CollectionsAPI

<back to all web services

PostCollectionSettingsRequest

Requires Authentication
The following routes are available for this service:
POST/v4/collections/settings
CollectionSettingsBaseRequest Parameters:
NameParameterData TypeRequiredDescription
ProfileImageIdformstringNo
SignatureImageIdformstringNo
SignatureTextformstringNo
SignatureFontformstringNo
SignatureAppearanceformSignatureAppearanceNo
SignatureAppearance Enum:
NameValue
Nonenone
Texttext
Uploadupload
V4BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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.

POST /v4/collections/settings HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	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
		}
	}
}