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
"use strict";
export class PhotoAnnotation {
    /** @param {{PhotoAnnotationID?:number,AttachmentId?:string,AnnotationJson?:string,FlattenedAttachmentId?:string,FlattenedUrl?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PhotoAnnotationID;
    /** @type {string} */
    AttachmentId;
    /** @type {string} */
    AnnotationJson;
    /** @type {?string} */
    FlattenedAttachmentId;
    /** @type {string} */
    FlattenedUrl;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class PhotoAnnotationResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Annotation?:PhotoAnnotation,OriginalUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {PhotoAnnotation} */
    Annotation;
    /** @type {string} */
    OriginalUrl;
}
export class PhotoAnnotationRequest {
    /** @param {{AttachmentId?:string,AnnotationJson?:string,FlattenedDataUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AttachmentId;
    /** @type {string} */
    AnnotationJson;
    /** @type {string} */
    FlattenedDataUrl;
}

JavaScript 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"}