Booklinker.API

<back to all web services

PostImageRequest

Requires Authentication
The following routes are available for this service:
POST/v2/images
"use strict";
export class V2BaseRequest {
    constructor(init) { Object.assign(this, init) }
}
export class V2BaseResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
}
export class PostImageResponse extends V2BaseResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class PostImageRequest extends V2BaseRequest {
    /** @param {{provider?:string,providerImageId?:string,attributes?:{ [index:string]: string; }}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    provider;
    /** @type {string} */
    providerImageId;
    /** @type {{ [index:string]: string; }} */
    attributes;
}

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

POST /v2/images HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	provider: String,
	providerImageId: String,
	attributes: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}