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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class PhotoAnnotation
            Public Overridable Property PhotoAnnotationID As Integer
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property AnnotationJson As String
            Public Overridable Property FlattenedAttachmentId As Guid?
            Public Overridable Property FlattenedUrl As String
            Public Overridable Property CreatedBy As String
            Public Overridable Property CreatedAt As Date?
            Public Overridable Property UpdatedAt As Date?
        End Class

        Public Partial Class PhotoAnnotationRequest
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property AnnotationJson As String
            Public Overridable Property FlattenedDataUrl As String
        End Class

        Public Partial Class PhotoAnnotationResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Annotation As PhotoAnnotation
            Public Overridable Property OriginalUrl As String
        End Class
    End Namespace
End Namespace

VB.NET 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>