CollectionsAPI

<back to all web services

GetCollectionsRequest

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    @DataContract
    public static class GetCollectionsRequest extends V4ListRequest
    {
        
    }

    @DataContract
    public static class V4ListRequest extends V4PaginatedBaseRequest
    {
        @DataMember(Name="ids")
        @SerializedName("ids")
        public ArrayList<String> ids = null;
        
        public ArrayList<String> getIds() { return ids; }
        public V4ListRequest setIds(ArrayList<String> value) { this.ids = value; return this; }
    }

    @DataContract
    public static class V4PaginatedBaseRequest extends V4BaseRequest
    {
        @DataMember(Name="offset")
        @SerializedName("offset")
        public Integer offset = null;

        @DataMember(Name="limit")
        @SerializedName("limit")
        public Integer limit = null;
        
        public Integer getOffset() { return offset; }
        public V4PaginatedBaseRequest setOffset(Integer value) { this.offset = value; return this; }
        public Integer getLimit() { return limit; }
        public V4PaginatedBaseRequest setLimit(Integer value) { this.limit = value; return this; }
    }

    @DataContract
    public static class V4BaseRequest
    {
        
    }

    @DataContract
    public static class GetCollectionsResponse extends V4PaginatedBaseResponse implements IGetCollectionsResponse
    {
        @DataMember(Name="data")
        @SerializedName("data")
        public ArrayList<IUserCollection> data = null;
        
        public ArrayList<IUserCollection> getData() { return data; }
        public GetCollectionsResponse setData(ArrayList<IUserCollection> value) { this.data = value; return this; }
    }

    @DataContract
    public static class V4PaginatedBaseResponse extends V4BaseResponse
    {
        @DataMember(Name="page")
        @SerializedName("page")
        public V4PageObject page = null;
        
        public V4PageObject getPage() { return page; }
        public V4PaginatedBaseResponse setPage(V4PageObject value) { this.page = value; return this; }
    }

    @DataContract
    public static class V4BaseResponse
    {
        @DataMember(Name="status")
        @SerializedName("status")
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public V4BaseResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    @DataContract
    public static class V4PageObject
    {
        @DataMember(Name="offset")
        @SerializedName("offset")
        public Integer offset = null;

        @DataMember(Name="limit")
        @SerializedName("limit")
        public Integer limit = null;

        @DataMember(Name="totalRecords")
        @SerializedName("totalRecords")
        public Integer totalRecords = null;
        
        public Integer getOffset() { return offset; }
        public V4PageObject setOffset(Integer value) { this.offset = value; return this; }
        public Integer getLimit() { return limit; }
        public V4PageObject setLimit(Integer value) { this.limit = value; return this; }
        public Integer getTotalRecords() { return totalRecords; }
        public V4PageObject setTotalRecords(Integer value) { this.totalRecords = value; return this; }
    }

    public static interface IUserCollection
    {
        public String id = null;
        public String title = null;
        public ArrayList<String> linkIds = null;
        public String collectionSettingsId = null;
    }

}

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