CollectionsAPI

PutCollectionSettingsRequest

The following routes are available for this service:
PUT	/v4/collections/settings
PUT	/v4/collections/settings/{Id}

"use strict";
export class V4BaseRequest {
    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 V4BaseRequest {
    /** @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 V4BaseResponse {
    /** @param {{status?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    status;
}
export class PutCollectionSettingsResponse extends V4BaseResponse {
    /** @param {{status?: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.

PUT /v4/collections/settings HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.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

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