Booklinker.API

<back to all web services

PostCollectionRequest

Requires Authentication
The following routes are available for this service:
POST/v2/collections
"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 PostCollectionResponse extends V2BaseResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class PostCollectionRequest extends V2BaseRequest {
    /** @param {{aliasDomain?:string,aliasCode?:string,title?:string,linkIds?:string[],collectionSettingsId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    aliasDomain;
    /** @type {string} */
    aliasCode;
    /** @type {string} */
    title;
    /** @type {string[]} */
    linkIds;
    /** @type {string} */
    collectionSettingsId;
}

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

POST /v2/collections HTTP/1.1 
Host: api.booklinker.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"aliasDomain":"String","aliasCode":"String","title":"String","collectionSettingsId":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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