Booklinker.API

<back to all web services

PostLinkIssueReportRequest

The following routes are available for this service:
POST/v1/report-link-issue
"use strict";
export class PostLinkIssueReportResponse {
    /** @param {{success?:boolean,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    success;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class PostLinkIssueReportRequest {
    /** @param {{aliasDomain?:string,aliasCode?:string,issues?:string[],email?:string,notes?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    aliasDomain;
    /** @type {string} */
    aliasCode;
    /** @type {string[]} */
    issues = [];
    /** @type {string} */
    email;
    /** @type {string} */
    notes;
}

JavaScript PostLinkIssueReportRequest 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 /v1/report-link-issue HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	aliasDomain: String,
	aliasCode: String,
	issues: 
	[
		String
	],
	email: String,
	notes: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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