Booklinker.API

<back to all web services

GetCollectionRequest

Requires Authentication
The following routes are available for this service:
GET/v2/collections
GET/v2/collections/{Id}
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 GetCollectionRequest extends V2BaseRequest
    {
        @DataMember(Name="id")
        @SerializedName("id")
        public String id = null;
        
        public String getId() { return id; }
        public GetCollectionRequest setId(String value) { this.id = value; return this; }
    }

    @DataContract
    public static class V2BaseRequest
    {
        
    }

    @DataContract
    public static class GetCollectionResponse extends V2BaseResponse
    {
        @DataMember(Name="data")
        @SerializedName("data")
        public UserCollection data = null;
        
        public UserCollection getData() { return data; }
        public GetCollectionResponse setData(UserCollection value) { this.data = value; return this; }
    }

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

    @DataContract
    public static class UserCollection implements IUserCollection
    {
        @DataMember(Name="type")
        @SerializedName("type")
        public String type = null;

        @DataMember(Name="id")
        @SerializedName("id")
        public String id = null;

        @DataMember(Name="baseCode")
        @SerializedName("baseCode")
        public String baseCode = null;

        @DataMember(Name="url")
        @SerializedName("url")
        public String url = null;

        @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 getType() { return type; }
        public UserCollection setType(String value) { this.type = value; return this; }
        public String getId() { return id; }
        public UserCollection setId(String value) { this.id = value; return this; }
        public String getBaseCode() { return baseCode; }
        public UserCollection setBaseCode(String value) { this.baseCode = value; return this; }
        public String getUrl() { return url; }
        public UserCollection setUrl(String value) { this.url = value; return this; }
        public String getTitle() { return title; }
        public UserCollection setTitle(String value) { this.title = value; return this; }
        public ArrayList<String> getLinkIds() { return linkIds; }
        public UserCollection setLinkIds(ArrayList<String> value) { this.linkIds = value; return this; }
        public String getCollectionSettingsId() { return collectionSettingsId; }
        public UserCollection setCollectionSettingsId(String value) { this.collectionSettingsId = value; return this; }
    }

}

Java GetCollectionRequest DTOs

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

HTTP + CSV

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

GET /v2/collections HTTP/1.1 
Host: api.booklinker.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"data":{"type":"collection","id":"String","baseCode":"String","url":"String","title":"String","collectionSettingsId":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}