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
namespace CoreService.ServiceModel.Dtos.Base.Responses

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ItemExistsResponse() = 
        member val Exists:Boolean = new Boolean() with get,set

    ///<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=typeof<ItemExistsResponse>, StatusCode=200)>]
    [<AllowNullLiteral>]
    type CollectionExists() = 
        interface 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")>]
        member val Id:Guid = new Guid() with get,set

        [<ApiMember(DataType="string", IsRequired=true, ParameterType="header")>]
        [<Validate(Validator="NotEmpty")>]
        member val TenantName:String = null with get,set

F# 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}