Platform API

ManagePrimaryImage

The following routes are available for this service:
All Verbs	/api/primaryimage
All Verbs	/api/primaryimage/userprofile

**ManagePrimaryImage** Parameters:
Name	Parameter	Data Type	Required	Description
ContactIdOwner	query	Guid	Yes	The licensee's contact Id linked to the media file.
File	query	MediaModel	Yes	Primary image file to be uploaded including file type and content type.
ApplianceId	query	Guid	Yes	Appliance from which primary image file is to be uploaded.
ContainerName	query	Guid	Yes	Blob storage container to which primary image file is to be uploaded.
ConnectedObjectId	query	Guid	Yes	Object for which primary image is to be uploaded.

**MediaModel** Parameters:
Name	Parameter	Data Type	Required
MediaFileId	form	Guid	No
MediaName	form	string	No
FileContent	form	string	No
FileContentType	form	string	No
FilePath	form	string	No
OriginalFileName	form	string	No
ImageWidth	form	int	No
ImageHeight	form	int	No
FileSizeKB	form	int	No
BlobUriRaw	form	string	No
BlobUriFull	form	string	No
BlobUriThumbnail	form	string	No
WatermarkUri	form	string	No
CapturedDate	form	DateTime	No
CapturedByContactId	form	Guid?	No
CapturedByContactName	form	string	No
CapturedByContactThumbnailUrl	form	string	No
Notes	form	string	No
ResourceActionName	form	string	No
LocationVerified	form	string	No
TrafficLightLocationVerified	form	Guid	No
AudienceLevel	form	string	No
WorksFor	form	string	No

**SaveMediaResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ErosMediaFileId	query	Guid	No	Media File Guid
MediaName	query	string	No	Media File Name
OriginalFileName	query	string	No	The original name of the media being saved.
MediaFileUrl	query	string	No	Url of the media file.
MediaFileThumbnailUrl	query	string	No	Url of the media file thumbnail.
ResponseStatus	query	ResponseStatus	No	Service Stack Response Status.

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

{
	File: 
	{
		MediaName: String,
		FileContent: String,
		FileContentType: String,
		FilePath: String,
		OriginalFileName: String,
		ImageWidth: 0,
		ImageHeight: 0,
		FileSizeKB: 0,
		BlobUriRaw: String,
		BlobUriFull: String,
		BlobUriThumbnail: String,
		WatermarkUri: String,
		CapturedDate: 0001-01-01,
		CapturedByContactId: 00000000000000000000000000000000,
		CapturedByContactName: String,
		CapturedByContactThumbnailUrl: String,
		Notes: String,
		ResourceActionName: String,
		LocationVerified: String,
		AudienceLevel: String,
		WorksFor: String
	},
	ContainerName: String
}

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

{
	MediaName: String,
	OriginalFileName: String,
	MediaFileUrl: String,
	MediaFileThumbnailUrl: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}