Platform API

<back to all web services

SaveMedia

Requires Authentication
The following routes are available for this service:
All Verbs/api/json/reply/savemedia
All Verbs/api/media
All Verbs/api/media/userprofile
SaveMedia Parameters:
NameParameterData TypeRequiredDescription
MediaFileIdqueryGuidNoThe media file Id to use.
MediaNamequerystringNo
MediaCapturedqueryDateTimeNo
ContactIdqueryGuidYesThe licensee's contact Id linked to the media file.
SessionIdqueryGuidYesThe id of the session in which the media file was created.
ApplianceIdqueryGuidNo
ContainerNamequerystringNo
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 .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/json/reply/savemedia HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"MediaFileId":"00000000-0000-0000-0000-000000000000","MediaName":"String","MediaCaptured":"0001-01-01T00:00:00.0000000","ContactId":"00000000-0000-0000-0000-000000000000","SessionId":"00000000-0000-0000-0000-000000000000","ApplianceId":"00000000-0000-0000-0000-000000000000","ContainerName":"String","ImageWidth":0,"ImageHeight":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ErosMediaFileId":"00000000-0000-0000-0000-000000000000","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"}}}