Booklinker.API

GetCollectionsRequest

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.*


@DataContract
open class GetCollectionsRequest : V2ListRequest()
{
}

@DataContract
open class V2ListRequest : V2PaginatedBaseRequest()
{
    @DataMember(Name="ids")
    @SerializedName("ids")
    open var ids:ArrayList<String>? = null
}

@DataContract
open class V2PaginatedBaseRequest : V2BaseRequest()
{
    @DataMember(Name="offset")
    @SerializedName("offset")
    open var offset:Int? = null

    @DataMember(Name="limit")
    @SerializedName("limit")
    open var limit:Int? = null
}

@DataContract
open class V2BaseRequest
{
}

@DataContract
open class GetCollectionsResponse : V2PaginatedBaseResponse(), IGetCollectionsResponse
{
}

@DataContract
open class V2PaginatedBaseResponse : V2BaseResponse()
{
    @DataMember(Name="page")
    @SerializedName("page")
    open var page:V2PageObject? = null
}

@DataContract
open class V2BaseResponse
{
    @DataMember(Name="responseStatus")
    @SerializedName("responseStatus")
    open var responseStatus:ResponseStatus? = null
}

@DataContract
open class V2PageObject
{
    @DataMember(Name="offset")
    @SerializedName("offset")
    open var offset:Int? = null

    @DataMember(Name="limit")
    @SerializedName("limit")
    open var limit:Int? = null

    @DataMember(Name="totalRecords")
    @SerializedName("totalRecords")
    open var totalRecords:Int? = null
}

Kotlin GetCollectionsRequest 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.

GET /v2/collections/list HTTP/1.1 
Host: api.booklinker.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/Booklinker.API.ServiceModel.V2.Responses">
  <responseStatus 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>
  </responseStatus>
  <page>
    <limit>0</limit>
    <offset>0</offset>
    <totalRecords>0</totalRecords>
  </page>
  <data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.DTOs.V2" i:nil="true" />
</GetCollectionsResponse>