Platform API

<back to all web services

AddAttachments

Requires Authentication
The following routes are available for this service:
POST/api/attachments
AddAttachments Parameters:
NameParameterData TypeRequiredDescription
FilesquerystringNo including file content, file type, content type and connected object.
ApplianceIdbodyGuidYesAppliance from which primary image file is to be uploaded.
ConnectedObjectIdbodyGuidYesObject for which primary image is to be uploaded.
ConnectedObjectLicenseeIdbodyGuidYesLicensee Id of the Object owner for which primary image is to be uploaded.
MediaModel Parameters:
NameParameterData TypeRequiredDescription
MediaFileIdformGuidNo
MediaNameformstringNo
FileContentformstringNo
FileContentTypeformstringNo
FilePathformstringNo
OriginalFileNameformstringNo
ImageWidthformintNo
ImageHeightformintNo
FileSizeKBformintNo
BlobUriRawformstringNo
BlobUriFullformstringNo
BlobUriThumbnailformstringNo
WatermarkUriformstringNo
CapturedDateformDateTimeNo
CapturedByContactIdformGuid?No
CapturedByContactNameformstringNo
CapturedByContactThumbnailUrlformstringNo
NotesformstringNo
ResourceActionNameformstringNo
LocationVerifiedformstringNo
TrafficLightLocationVerifiedformGuidNo
AudienceLevelformstringNo
WorksForformstringNo
AddAttachmentsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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/attachments HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Files":[{"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","ConnectedObjectId":"00000000-0000-0000-0000-000000000000","ConnectedObjectLicenseeId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}