CollectionsAPI

PostCollectionSettingsRequest

The following routes are available for this service:
POST	/v4/collections/settings


// @DataContract
export class V4BaseRequest
{

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

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

// @DataContract
export class CollectionSettingsBaseRequest extends V4BaseRequest 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 V4BaseResponse
{
    // @DataMember(Name="status")
    public status: ResponseStatus;

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

// @DataContract
export class PostCollectionSettingsResponse extends V4BaseResponse implements IPostCollectionSettingsResponse
{

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

// @DataContract
export class PostCollectionSettingsRequest extends CollectionSettingsBaseRequest implements IPostCollectionSettingsRequest
{

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

TypeScript PostCollectionSettingsRequest 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 /v4/collections/settings HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

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

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