Booklinker.API

GetLinksRequest

The following routes are available for this service:
GET	/v1/links/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 GetLinksRequest : PaginatedBaseRequest()
{
    @DataMember(Name="ids")
    @SerializedName("ids")
    open var ids:ArrayList<String>? = null
}

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

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

@DataContract
open class GetLinksResponse
{
    @DataMember(Name="allLinksLoaded")
    @SerializedName("allLinksLoaded")
    open var allLinksLoaded:Boolean? = null

    @DataMember(Name="results")
    @SerializedName("results")
    open var results:ArrayList<LinkResult>? = null

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

@DataContract
open class LinkResult
{
    @DataMember(Name="baseCode")
    @SerializedName("baseCode")
    open var baseCode:String? = null

    @DataMember(Name="url")
    @SerializedName("url")
    open var url:String? = null

    @DataMember(Name="originalUrl")
    @SerializedName("originalUrl")
    open var originalUrl:String? = null

    @DataMember(Name="imageUrl")
    @SerializedName("imageUrl")
    open var imageUrl:String? = null

    @DataMember(Name="retailer")
    @SerializedName("retailer")
    open var retailer:String? = null

    @DataMember(Name="title")
    @SerializedName("title")
    open var title:String? = null

    @DataMember(Name="author")
    @SerializedName("author")
    open var author:String? = null
}

Kotlin GetLinksRequest 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 /v1/links/list HTTP/1.1 
Host: api.booklinker.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetLinksResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.Responses">
  <allLinksLoaded>false</allLinksLoaded>
  <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>
  <results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.DTOs.Shortlinks">
    <d2p1:LinkResult>
      <d2p1:author>String</d2p1:author>
      <d2p1:baseCode>String</d2p1:baseCode>
      <d2p1:imageUrl>String</d2p1:imageUrl>
      <d2p1:originalUrl>String</d2p1:originalUrl>
      <d2p1:retailer>String</d2p1:retailer>
      <d2p1:title>String</d2p1:title>
      <d2p1:url>String</d2p1:url>
    </d2p1:LinkResult>
  </results>
</GetLinksResponse>