Booklinker.API

<back to all web services

GetShortLinkMetadataRequest

The following routes are available for this service:
GET/v1/shortlink/metadata
"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 Destination {
    /** @param {{isSuggestion?:boolean,isAutoSuggestion?:boolean,destinationUrl?:string,replacementButton?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    isSuggestion;
    /** @type {boolean} */
    isAutoSuggestion;
    /** @type {string} */
    destinationUrl;
    /** @type {string} */
    replacementButton;
}
export class GetShortLinkMetadataResponse {
    /** @param {{baseCode?:string,domain?:string,code?:string,productMetadata?:ProductMetadata,destinations?:Destination[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    baseCode;
    /** @type {string} */
    domain;
    /** @type {string} */
    code;
    /** @type {ProductMetadata} */
    productMetadata;
    /** @type {Destination[]} */
    destinations;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetShortLinkMetadataRequest {
    /** @param {{domain?:string,code?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    domain;
    /** @type {string} */
    code;
}
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 GetShortLinkMetadataRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/shortlink/metadata HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv

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

{
	baseCode: String,
	domain: String,
	code: String,
	productMetadata: 
	{
		title: String,
		author: String,
		description: String,
		retailer: String
	},
	destinations: 
	[
		{
			isSuggestion: False,
			isAutoSuggestion: False,
			destinationUrl: String,
			replacementButton: String
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}