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 .xml suffix or ?format=xml

HTTP + XML

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

<PhotoAnnotationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AnnotationJson>String</AnnotationJson>
  <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
  <FlattenedDataUrl>String</FlattenedDataUrl>
</PhotoAnnotationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PhotoAnnotationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Annotation>
    <AnnotationJson>String</AnnotationJson>
    <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedBy>String</CreatedBy>
    <FlattenedAttachmentId>00000000-0000-0000-0000-000000000000</FlattenedAttachmentId>
    <FlattenedUrl>String</FlattenedUrl>
    <PhotoAnnotationID>0</PhotoAnnotationID>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
  </Annotation>
  <OriginalUrl>String</OriginalUrl>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</PhotoAnnotationResponse>