CollectionsAPI

<back to all web services

GetCollectionsRequest

// @DataContract
export class V4BaseRequest
{

    public constructor(init?: Partial<V4BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class V4PaginatedBaseRequest extends V4BaseRequest
{
    // @DataMember(Name="offset")
    public offset: number;

    // @DataMember(Name="limit")
    public limit: number;

    public constructor(init?: Partial<V4PaginatedBaseRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class V4ListRequest extends V4PaginatedBaseRequest
{
    // @DataMember(Name="ids")
    public ids: string[];

    public constructor(init?: Partial<V4ListRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class V4BaseResponse
{
    // @DataMember(Name="status")
    public status: ResponseStatus;

    public constructor(init?: Partial<V4BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class V4PageObject
{
    // @DataMember(Name="offset")
    public offset: number;

    // @DataMember(Name="limit")
    public limit: number;

    // @DataMember(Name="totalRecords")
    public totalRecords: number;

    public constructor(init?: Partial<V4PageObject>) { (Object as any).assign(this, init); }
}

// @DataContract
export class V4PaginatedBaseResponse extends V4BaseResponse
{
    // @DataMember(Name="page")
    public page: V4PageObject;

    public constructor(init?: Partial<V4PaginatedBaseResponse>) { super(init); (Object as any).assign(this, init); }
}

export interface IUserCollection
{
    id: string;
    title: string;
    linkIds: string[];
    collectionSettingsId: string;
}

// @DataContract
export class GetCollectionsResponse extends V4PaginatedBaseResponse implements IGetCollectionsResponse
{
    // @DataMember(Name="data")
    public data: IUserCollection[];

    public constructor(init?: Partial<GetCollectionsResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class GetCollectionsRequest extends V4ListRequest
{

    public constructor(init?: Partial<GetCollectionsRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetCollectionsRequest DTOs

GET /v4/collections/list HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCollectionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.Responses">
  <status xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </status>
  <page>
    <limit>0</limit>
    <offset>0</offset>
    <totalRecords>0</totalRecords>
  </page>
  <data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
</GetCollectionsResponse>