Booklinker.API

<back to all web services

PutCollectionSettingsRequest

Requires Authentication 

// @DataContract
export class V2BaseRequest
{

    public constructor(init?: Partial<V2BaseRequest>) { (Object as any).assign(this, init); }
}

export enum SignatureAppearance
{
    None = 'none',
    Text = 'text',
    Upload = 'upload',
}

// @DataContract
export class CollectionSettingsBaseRequest extends V2BaseRequest implements ICollectionSettingsBaseRequest
{
    // @DataMember(Name="profileImageId")
    public profileImageId: string;

    // @DataMember(Name="signatureImageId")
    public signatureImageId: string;

    // @DataMember(Name="signatureText")
    public signatureText: string;

    // @DataMember(Name="signatureFont")
    public signatureFont: string;

    // @DataMember(Name="signatureAppearance")
    public signatureAppearance: SignatureAppearance;

    public constructor(init?: Partial<CollectionSettingsBaseRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class V2BaseResponse
{
    // @DataMember(Name="responseStatus")
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<V2BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PutCollectionSettingsResponse extends V2BaseResponse
{

    public constructor(init?: Partial<PutCollectionSettingsResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class PutCollectionSettingsRequest extends CollectionSettingsBaseRequest implements IPutCollectionSettingsRequest
{
    // @DataMember(Name="id")
    public id: string;

    public constructor(init?: Partial<PutCollectionSettingsRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript PutCollectionSettingsRequest DTOs

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

HTTP + CSV

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

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

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

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

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