Booklinker.API

<back to all web services

PutCollectionSettingsRequest

Requires Authentication 
"use strict";
export class V2BaseRequest {
    constructor(init) { Object.assign(this, init) }
}
/** @typedef {'none'|'text'|'upload'} */
export var SignatureAppearance;
(function (SignatureAppearance) {
    SignatureAppearance["None"] = "none"
    SignatureAppearance["Text"] = "text"
    SignatureAppearance["Upload"] = "upload"
})(SignatureAppearance || (SignatureAppearance = {}));
export class CollectionSettingsBaseRequest extends V2BaseRequest {
    /** @param {{profileImageId?:string,signatureImageId?:string,signatureText?:string,signatureFont?:string,signatureAppearance?:SignatureAppearance}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    profileImageId;
    /** @type {string} */
    signatureImageId;
    /** @type {string} */
    signatureText;
    /** @type {string} */
    signatureFont;
    /** @type {SignatureAppearance} */
    signatureAppearance;
}
export class V2BaseResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
}
export class PutCollectionSettingsResponse extends V2BaseResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class PutCollectionSettingsRequest extends CollectionSettingsBaseRequest {
    /** @param {{id?:string,profileImageId?:string,signatureImageId?:string,signatureText?:string,signatureFont?:string,signatureAppearance?:SignatureAppearance}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    id;
}

JavaScript PutCollectionSettingsRequest 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 /json/reply/PutCollectionSettingsRequest HTTP/1.1 
Host: api.booklinker.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"String","profileImageId":"String","signatureImageId":"String","signatureText":"String","signatureFont":"String","signatureAppearance":"none"}

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"}}}