CollectionsAPI

<back to all web services

PostCollectionRequest

Requires Authentication
The following routes are available for this service:
POST/v4/collections
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 PostCollectionRequest extends V4BaseRequest implements IPostCollectionRequest
    {
        @DataMember(Name="title")
        @SerializedName("title")
        public String title = null;

        @DataMember(Name="linkIds")
        @SerializedName("linkIds")
        public ArrayList<String> linkIds = null;

        @DataMember(Name="collectionSettingsId")
        @SerializedName("collectionSettingsId")
        public String collectionSettingsId = null;
        
        public String getTitle() { return title; }
        public PostCollectionRequest setTitle(String value) { this.title = value; return this; }
        public ArrayList<String> getLinkIds() { return linkIds; }
        public PostCollectionRequest setLinkIds(ArrayList<String> value) { this.linkIds = value; return this; }
        public String getCollectionSettingsId() { return collectionSettingsId; }
        public PostCollectionRequest setCollectionSettingsId(String value) { this.collectionSettingsId = value; return this; }
    }

    @DataContract
    public static class V4BaseRequest
    {
        
    }

    @DataContract
    public static class PostCollectionResponse extends V4BaseResponse implements IPostCollectionResponse
    {
        @DataMember(Name="data")
        @SerializedName("data")
        public IPostCollectionResponseData data = null;
        
        public IPostCollectionResponseData getData() { return data; }
        public PostCollectionResponse setData(IPostCollectionResponseData value) { this.data = 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; }
    }

    public static interface IPostCollectionResponseData
    {
        public String id = null;
    }

}

Java PostCollectionRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v4/collections HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostCollectionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.Requests">
  <collectionSettingsId>String</collectionSettingsId>
  <linkIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <title>String</title>
</PostCollectionRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostCollectionResponse 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>
  <data i:nil="true" />
</PostCollectionResponse>