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 .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"allLinksLoaded":false,"results":[{"baseCode":"String","url":"String","originalUrl":"String","imageUrl":"String","retailer":"String","title":"String","author":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}