Trendsic Platform Service

PhotoAnnotationRequest

The following routes are available for this service:
GET,PUT,OPTIONS	/v1/photos/{AttachmentId}/annotation

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PhotoAnnotation:
    photo_annotation_i_d: int = 0
    attachment_id: Optional[str] = None
    annotation_json: Optional[str] = None
    flattened_attachment_id: Optional[str] = None
    flattened_url: Optional[str] = None
    created_by: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    updated_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PhotoAnnotationResponse:
    response_status: Optional[ResponseStatus] = None
    annotation: Optional[PhotoAnnotation] = None
    original_url: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PhotoAnnotationRequest:
    attachment_id: Optional[str] = None
    annotation_json: Optional[str] = None
    flattened_data_url: Optional[str] = None

Python 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>