| All Verbs | /api/json/reply/savemedia | ||
|---|---|---|---|
| All Verbs | /api/media | ||
| All Verbs | /api/media/userprofile |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MediaFileId | query | Guid | No | The media file Id to use. |
| MediaName | query | string | No | |
| MediaCaptured | query | DateTime | No | |
| ContactId | query | Guid | Yes | The licensee's contact Id linked to the media file. |
| SessionId | query | Guid | Yes | The id of the session in which the media file was created. |
| ApplianceId | query | Guid | No | |
| ContainerName | query | string | No | |
| ImageWidth | query | int? | No | |
| ImageHeight | query | int? | No |
| 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
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/jsv
Content-Type: text/jsv
Content-Length: length
{
MediaName: String,
MediaCaptured: 0001-01-01,
ContainerName: String,
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
}
}
}