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