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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CoreService.ServiceModel.Dtos.Collections.Crud;
using CoreService.ServiceModel.Dtos.Base.Responses;

namespace CoreService.ServiceModel.Dtos.Base.Responses
{
    public partial class ItemExistsResponse
    {
        public virtual bool Exists { get; set; }
    }

}

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=typeof(CoreService.ServiceModel.Dtos.Base.Responses.ItemExistsResponse), StatusCode=200)]
    public partial class CollectionExists
        : IBaseRequest, IHasId, IHasTenantName, 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 virtual Guid Id { get; set; }

        [ApiMember(DataType="string", IsRequired=true, ParameterType="header")]
        [Validate("NotEmpty")]
        public virtual string TenantName { get; set; }
    }

}

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