Booklinker.API

<back to all web services

GetLinksRequest

Requires Authentication
The following routes are available for this service:
GET/v1/links/list
import Foundation
import ServiceStack

// @DataContract
public class GetLinksRequest : PaginatedBaseRequest
{
    // @DataMember(Name="ids")
    public var ids:[String]

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case ids
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        ids = try container.decodeIfPresent([String].self, forKey: .ids) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if ids != nil { try container.encode(ids, forKey: .ids) }
    }
}

// @DataContract
public class PaginatedBaseRequest : Codable
{
    // @DataMember(Name="skip")
    public var skip:Int

    // @DataMember(Name="take")
    public var take:Int

    required public init(){}
}

// @DataContract
public class GetLinksResponse : Codable
{
    // @DataMember(Name="allLinksLoaded")
    public var allLinksLoaded:Bool

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

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

    required public init(){}
}

// @DataContract
public class LinkResult : Codable
{
    // @DataMember(Name="baseCode")
    public var baseCode:String

    // @DataMember(Name="url")
    public var url:String

    // @DataMember(Name="originalUrl")
    public var originalUrl:String

    // @DataMember(Name="imageUrl")
    public var imageUrl:String

    // @DataMember(Name="retailer")
    public var retailer:String

    // @DataMember(Name="title")
    public var title:String

    // @DataMember(Name="author")
    public var author:String

    required public init(){}
}

Swift GetLinksRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}