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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Checks if a collection with this id exists
    */
    @Api(Description="Checks if a collection with this id exists")
    @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=ItemExistsResponse.class, StatusCode=200)
    public static class CollectionExists implements IBaseRequest, IHasId, IHasTenantName, IGet
    {
        /**
        * The unique id of the collection
        */
        @ApiMember(DataType="string", Description="The unique id of the collection", Format="guid", IsRequired=true, ParameterType="path")
        public UUID id = null;

        @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
        @Validate(Validator="NotEmpty")
        public String tenantName = null;
        
        public UUID getId() { return id; }
        public CollectionExists setId(UUID value) { this.id = value; return this; }
        public String getTenantName() { return tenantName; }
        public CollectionExists setTenantName(String value) { this.tenantName = value; return this; }
    }

    public static class ItemExistsResponse
    {
        public Boolean exists = null;
        
        public Boolean isExists() { return exists; }
        public ItemExistsResponse setExists(Boolean value) { this.exists = value; return this; }
    }

}

Java 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}