CollectionsAPI

PutCollectionSettingsRequest

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


// @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 PutCollectionSettingsResponse extends V4BaseResponse
{

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

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

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

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