Booklinker.API

<back to all web services

PostPendingLinkRequest

Requires Authentication
The following routes are available for this service:
POST/v1/links/pending
"use strict";
export class ProductMetadata extends ProductMetadata {
    /** @param {{title?:string,author?:string,url?:string,description?:string,retailer?:string,productImages?:{ [index:string]: string; }}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class PostPendingLinkResponse {
    /** @param {{url?:string,productMetadata?:ProductMetadata,domain?:string,code?:string,baseDomain?:string,baseCode?:string,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    url;
    /** @type {ProductMetadata} */
    productMetadata;
    /** @type {string} */
    domain;
    /** @type {string} */
    code;
    /** @type {string} */
    baseDomain;
    /** @type {string} */
    baseCode;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class PostPendingLinkRequest {
    /** @param {{token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    token;
}
export class ProductMetadata {
    /** @param {{title?:string,author?:string,url?:string,description?:string,retailer?:string,productImages?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    title;
    /** @type {string} */
    author;
    /** @type {string} */
    url;
    /** @type {string} */
    description;
    /** @type {string} */
    retailer;
    /** @type {{ [index:string]: string; }} */
    productImages;
}

JavaScript PostPendingLinkRequest 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.

POST /v1/links/pending HTTP/1.1 
Host: api.booklinker.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"token":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"url":"String","productMetadata":{"title":"String","author":"String","description":"String","retailer":"String"},"domain":"String","code":"String","baseDomain":"String","baseCode":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}