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

export class PhotoAnnotation
{
    public PhotoAnnotationID: number;
    public AttachmentId: string;
    public AnnotationJson: string;
    public FlattenedAttachmentId?: string;
    public FlattenedUrl: string;
    public CreatedBy: string;
    public CreatedAt?: string;
    public UpdatedAt?: string;

    public constructor(init?: Partial<PhotoAnnotation>) { (Object as any).assign(this, init); }
}

export class PhotoAnnotationResponse
{
    public ResponseStatus: ResponseStatus;
    public Annotation: PhotoAnnotation;
    public OriginalUrl: string;

    public constructor(init?: Partial<PhotoAnnotationResponse>) { (Object as any).assign(this, init); }
}

export class PhotoAnnotationRequest
{
    public AttachmentId: string;
    public AnnotationJson: string;
    public FlattenedDataUrl: string;

    public constructor(init?: Partial<PhotoAnnotationRequest>) { (Object as any).assign(this, init); }
}

TypeScript PhotoAnnotationRequest DTOs

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

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"AttachmentId":"00000000000000000000000000000000","AnnotationJson":"String","FlattenedDataUrl":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}