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 .xml suffix or ?format=xml

HTTP + XML

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

POST /xml/reply/PutCollectionSettingsRequest HTTP/1.1 
Host: api.booklinker.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PutCollectionSettingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V2.Requests">
  <profileImageId>String</profileImageId>
  <signatureAppearance>None</signatureAppearance>
  <signatureFont>String</signatureFont>
  <signatureImageId>String</signatureImageId>
  <signatureText>String</signatureText>
  <id>String</id>
</PutCollectionSettingsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PutCollectionSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V2.Responses">
  <responseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </responseStatus>
</PutCollectionSettingsResponse>