Booklinker.API

GetLinksRequest

The following routes are available for this service:
GET	/v1/links/list


// @DataContract
export class PaginatedBaseRequest
{
    // @DataMember(Name="skip")
    public skip: number;

    // @DataMember(Name="take")
    public take: number;

    public constructor(init?: Partial<PaginatedBaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class LinkResult
{
    // @DataMember(Name="baseCode")
    public baseCode: string;

    // @DataMember(Name="url")
    public url: string;

    // @DataMember(Name="originalUrl")
    public originalUrl: string;

    // @DataMember(Name="imageUrl")
    public imageUrl: string;

    // @DataMember(Name="retailer")
    public retailer: string;

    // @DataMember(Name="title")
    public title: string;

    // @DataMember(Name="author")
    public author: string;

    public constructor(init?: Partial<LinkResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetLinksResponse
{
    // @DataMember(Name="allLinksLoaded")
    public allLinksLoaded: boolean;

    // @DataMember(Name="results")
    public results: LinkResult[];

    // @DataMember(Name="responseStatus")
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetLinksResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetLinksRequest extends PaginatedBaseRequest
{
    // @DataMember(Name="ids")
    public ids: string[];

    public constructor(init?: Partial<GetLinksRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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>