Platform API

<back to all web services

UploadFile

Requires Authentication
The following routes are available for this service:
All Verbs/api/media/file
UploadFile Parameters:
NameParameterData TypeRequiredDescription
PathquerystringNo
MediaCapturedqueryDateTimeNo
ContactIdqueryGuidNo
ApplianceIdqueryGuidNo
ImageWidthqueryint?No
ImageHeightqueryint?No
SaveMediaResponse Parameters:
NameParameterData TypeRequiredDescription
ErosMediaFileIdqueryGuidNoMedia File Guid
MediaNamequerystringNoMedia File Name
OriginalFileNamequerystringNoThe original name of the media being saved.
MediaFileUrlquerystringNoUrl of the media file.
MediaFileThumbnailUrlquerystringNoUrl of the media file thumbnail.
ResponseStatusqueryResponseStatusNoService 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/media/file HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Path: String,
	MediaCaptured: 0001-01-01,
	ImageWidth: 0,
	ImageHeight: 0
}
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
		}
	}
}