| All Verbs | /api/primaryimage | ||
|---|---|---|---|
| All Verbs | /api/primaryimage/userprofile |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
Content-Type: application/json
Content-Length: length
{"ContactIdOwner":"00000000-0000-0000-0000-000000000000","File":{"MediaFileId":"00000000-0000-0000-0000-000000000000","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-01T00:00:00.0000000","CapturedByContactId":"00000000000000000000000000000000","CapturedByContactName":"String","CapturedByContactThumbnailUrl":"String","Notes":"String","ResourceActionName":"String","LocationVerified":"String","TrafficLightLocationVerified":"00000000-0000-0000-0000-000000000000","AudienceLevel":"String","WorksFor":"String"},"ApplianceId":"00000000-0000-0000-0000-000000000000","ContainerName":"String","ConnectedObjectId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}