Trendsic Platform Service

<back to all web services

PhotoAnnotationRequest

Requires Authentication
The following routes are available for this service:
GET,PUT,OPTIONS/v1/photos/{AttachmentId}/annotation
PhotoAnnotationRequest Parameters:
NameParameterData TypeRequiredDescription
AttachmentIdpathGuidNo
AnnotationJsonbodystringNo
FlattenedDataUrlbodystringNo
PhotoAnnotationResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AnnotationformPhotoAnnotationNo
OriginalUrlformstringNo
PhotoAnnotation Parameters:
NameParameterData TypeRequiredDescription
PhotoAnnotationIDformintNo
AttachmentIdformGuidNo
AnnotationJsonformstringNo
FlattenedAttachmentIdformGuid?No
FlattenedUrlformstringNo
CreatedByformstringNo
CreatedAtformDateTime?No
UpdatedAtformDateTime?No

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.

PUT /v1/photos/{AttachmentId}/annotation HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"AttachmentId":"00000000000000000000000000000000","AnnotationJson":"String","FlattenedDataUrl":"String"}
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"}},"Annotation":{"PhotoAnnotationID":0,"AttachmentId":"00000000000000000000000000000000","AnnotationJson":"String","FlattenedAttachmentId":"00000000000000000000000000000000","FlattenedUrl":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"},"OriginalUrl":"String"}