Platform API

<back to all web services

SaveImageAsObjectPrimary

Updates the specified objects primary image with the specified Images Media File ID.

Requires Authentication
The following routes are available for this service:
All Verbs/api/json/reply/SaveImageAsObjectPrimary
All Verbs/api/SaveImageAsObjectPrimary
All Verbs/api/SaveImageAsObjectPrimary/userprofile
SaveImageAsObjectPrimary Parameters:
NameParameterData TypeRequiredDescription
ObjectIdqueryGuidYesGuid of the object whose primary image details we want to update.
PrimaryImageMediaFileIdqueryGuidYesGuid of the Media File that contains details of the image we want to be primary.
BlobImageURLqueryGuidYesURL to the full image.
BlobImageURLThumbnailqueryGuidYesURL to the thumbnail image.

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 /api/json/reply/SaveImageAsObjectPrimary HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	BlobImageURL: String,
	BlobImageURLThumbnail: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ErrorCode: String,
	Message: String,
	StackTrace: String,
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String,
			Meta: 
			{
				String: String
			}
		}
	],
	Meta: 
	{
		String: String
	}
}