CoreService

<back to all web services

CollectionExists

Collection - CRUD

Checks if a collection with this id exists

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/collections/{Id}/existsChecks if a collection with then given id exists
GET/collections/{Id}/existsChecks if a collection with then given id exists
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CoreService.ServiceModel.Dtos.Collections.Crud
Imports CoreService.ServiceModel.Dtos.Base.Responses

Namespace Global

    Namespace CoreService.ServiceModel.Dtos.Base.Responses

        Public Partial Class ItemExistsResponse
            Public Overridable Property Exists As Boolean
        End Class
    End Namespace

    Namespace CoreService.ServiceModel.Dtos.Collections.Crud

        '''<Summary>
        '''Checks if a collection with this id exists
        '''</Summary>
        <Api(Description:="Checks if a collection with this id exists")>
        <ApiResponse(Description:="Success", IsDefaultResponse:=true, ResponseType:=GetType(ItemExistsResponse), StatusCode:=200)>
        Public Partial Class CollectionExists
            Implements IBaseRequest
            Implements IHasId
            Implements IHasTenantName
            Implements IGet
            '''<Summary>
            '''The unique id of the collection
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The unique id of the collection", Format:="guid", IsRequired:=true, ParameterType:="path")>
            Public Overridable Property Id As Guid Implements IHasId.Id

            <ApiMember(DataType:="string", IsRequired:=true, ParameterType:="header")>
            <Validate(Validator:="NotEmpty")>
            Public Overridable Property TenantName As String Implements IHasTenantName.TenantName
        End Class
    End Namespace
End Namespace

VB.NET CollectionExists DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/collections/{Id}/exists HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"exists":false}