Booklinker.API

GetCollectionRequest

The following routes are available for this service:
GET	/v2/collections
GET	/v2/collections/{Id}

"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 UserCollection {
    /** @param {{type?:string,id?:string,baseCode?:string,url?:string,title?:string,linkIds?:string[],collectionSettingsId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    type;
    /** @type {string} */
    id;
    /** @type {string} */
    baseCode;
    /** @type {string} */
    url;
    /** @type {string} */
    title;
    /** @type {string[]} */
    linkIds;
    /** @type {string} */
    collectionSettingsId;
}
export class GetCollectionResponse extends V2BaseResponse {
    /** @param {{data?:UserCollection,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {UserCollection} */
    data;
}
export class GetCollectionRequest extends V2BaseRequest {
    /** @param {{id?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    id;
}

JavaScript GetCollectionRequest DTOs

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

HTTP + OTHER

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

GET /v2/collections HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsonl

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

{"data":{"type":"collection","id":"String","baseCode":"String","url":"String","title":"String","collectionSettingsId":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}