Booklinker.API

<back to all web services

GetLinksRequest

Requires Authentication
The following routes are available for this service:
GET/v1/links/list
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Booklinker.API.ServiceModel.V1.Requests;
using Booklinker.API.ServiceModel.V1.Responses;
using Booklinker.API.ServiceModel.DTOs.Shortlinks;

namespace Booklinker.API.ServiceModel.DTOs.Shortlinks
{
    [DataContract]
    public partial class LinkResult
    {
        [DataMember(Name="baseCode")]
        public virtual string BaseCode { get; set; }

        [DataMember(Name="url")]
        public virtual string Url { get; set; }

        [DataMember(Name="originalUrl")]
        public virtual string OriginalUrl { get; set; }

        [DataMember(Name="imageUrl")]
        public virtual string ImageUrl { get; set; }

        [DataMember(Name="retailer")]
        public virtual string Retailer { get; set; }

        [DataMember(Name="title")]
        public virtual string Title { get; set; }

        [DataMember(Name="author")]
        public virtual string Author { get; set; }
    }

}

namespace Booklinker.API.ServiceModel.V1.Requests
{
    [DataContract]
    public partial class GetLinksRequest
        : PaginatedBaseRequest
    {
        [DataMember(Name="ids")]
        public virtual List<string> Ids { get; set; }
    }

    [DataContract]
    public partial class PaginatedBaseRequest
    {
        [DataMember(Name="skip")]
        public virtual int Skip { get; set; }

        [DataMember(Name="take")]
        public virtual int Take { get; set; }
    }

}

namespace Booklinker.API.ServiceModel.V1.Responses
{
    [DataContract]
    public partial class GetLinksResponse
    {
        [DataMember(Name="allLinksLoaded")]
        public virtual bool AllLinksLoaded { get; set; }

        [DataMember(Name="results")]
        public virtual List<LinkResult> Results { get; set; }

        [DataMember(Name="responseStatus")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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>