Booklinker.API

<back to all web services

GetCollectionsRequest

Requires Authentication
The following routes are available for this service:
GET/v2/collections/list
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 V2ListRequest
    {
        
    }

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

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

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

    @DataContract
    public static class V2BaseRequest
    {
        
    }

    @DataContract
    public static class GetCollectionsResponse extends V2PaginatedBaseResponse implements IGetCollectionsResponse
    {
        
    }

    @DataContract
    public static class V2PaginatedBaseResponse extends V2BaseResponse
    {
        @DataMember(Name="page")
        @SerializedName("page")
        public V2PageObject page = null;
        
        public V2PageObject getPage() { return page; }
        public V2PaginatedBaseResponse setPage(V2PageObject value) { this.page = 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 V2PageObject
    {
        @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 V2PageObject setOffset(Integer value) { this.offset = value; return this; }
        public Integer getLimit() { return limit; }
        public V2PageObject setLimit(Integer value) { this.limit = value; return this; }
        public Integer getTotalRecords() { return totalRecords; }
        public V2PageObject setTotalRecords(Integer value) { this.totalRecords = value; return this; }
    }

}

Java GetCollectionsRequest 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/list HTTP/1.1 
Host: api.booklinker.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"page":{"offset":0,"limit":0,"totalRecords":0},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}