Booklinker.API

<back to all web services

GetLinksRequest

Requires Authentication
The following routes are available for this service:
GET/v1/links/list
"use strict";
export class PaginatedBaseRequest {
    /** @param {{skip?:number,take?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    skip;
    /** @type {number} */
    take;
}
export class LinkResult {
    /** @param {{baseCode?:string,url?:string,originalUrl?:string,imageUrl?:string,retailer?:string,title?:string,author?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    baseCode;
    /** @type {string} */
    url;
    /** @type {string} */
    originalUrl;
    /** @type {string} */
    imageUrl;
    /** @type {string} */
    retailer;
    /** @type {string} */
    title;
    /** @type {string} */
    author;
}
export class GetLinksResponse {
    /** @param {{allLinksLoaded?:boolean,results?:LinkResult[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    allLinksLoaded;
    /** @type {LinkResult[]} */
    results;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetLinksRequest extends PaginatedBaseRequest {
    /** @param {{ids?:string[],skip?:number,take?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string[]} */
    ids;
}

JavaScript GetLinksRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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