| All Verbs | /api/attachments/{ConnectedObjectId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConnectedObjectId | path | Guid | Yes | Object for which primary image is to be uploaded. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Attachments | form | List<MediaModel> | No | |
| ResponseStatus | form | ResponseStatus | No |
| 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 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/attachments/{ConnectedObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"ConnectedObjectId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Attachments":[{"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"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}