Trendsic Platform Service

<back to all web services

PhotoAnnotationRequest

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class PhotoAnnotation implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $PhotoAnnotationID=0,
        /** @var string */
        public string $AttachmentId='',
        /** @var string|null */
        public ?string $AnnotationJson=null,
        /** @var string|null */
        public ?string $FlattenedAttachmentId=null,
        /** @var string|null */
        public ?string $FlattenedUrl=null,
        /** @var string|null */
        public ?string $CreatedBy=null,
        /** @var DateTime|null */
        public ?DateTime $CreatedAt=null,
        /** @var DateTime|null */
        public ?DateTime $UpdatedAt=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['PhotoAnnotationID'])) $this->PhotoAnnotationID = $o['PhotoAnnotationID'];
        if (isset($o['AttachmentId'])) $this->AttachmentId = $o['AttachmentId'];
        if (isset($o['AnnotationJson'])) $this->AnnotationJson = $o['AnnotationJson'];
        if (isset($o['FlattenedAttachmentId'])) $this->FlattenedAttachmentId = $o['FlattenedAttachmentId'];
        if (isset($o['FlattenedUrl'])) $this->FlattenedUrl = $o['FlattenedUrl'];
        if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
        if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
        if (isset($o['UpdatedAt'])) $this->UpdatedAt = JsonConverters::from('DateTime', $o['UpdatedAt']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->PhotoAnnotationID)) $o['PhotoAnnotationID'] = $this->PhotoAnnotationID;
        if (isset($this->AttachmentId)) $o['AttachmentId'] = $this->AttachmentId;
        if (isset($this->AnnotationJson)) $o['AnnotationJson'] = $this->AnnotationJson;
        if (isset($this->FlattenedAttachmentId)) $o['FlattenedAttachmentId'] = $this->FlattenedAttachmentId;
        if (isset($this->FlattenedUrl)) $o['FlattenedUrl'] = $this->FlattenedUrl;
        if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
        if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
        if (isset($this->UpdatedAt)) $o['UpdatedAt'] = JsonConverters::to('DateTime', $this->UpdatedAt);
        return empty($o) ? new class(){} : $o;
    }
}

class PhotoAnnotationResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var PhotoAnnotation|null */
        public ?PhotoAnnotation $Annotation=null,
        /** @var string|null */
        public ?string $OriginalUrl=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['Annotation'])) $this->Annotation = JsonConverters::from('PhotoAnnotation', $o['Annotation']);
        if (isset($o['OriginalUrl'])) $this->OriginalUrl = $o['OriginalUrl'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->Annotation)) $o['Annotation'] = JsonConverters::to('PhotoAnnotation', $this->Annotation);
        if (isset($this->OriginalUrl)) $o['OriginalUrl'] = $this->OriginalUrl;
        return empty($o) ? new class(){} : $o;
    }
}

class PhotoAnnotationRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $AttachmentId='',
        /** @var string|null */
        public ?string $AnnotationJson=null,
        /** @var string|null */
        public ?string $FlattenedDataUrl=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AttachmentId'])) $this->AttachmentId = $o['AttachmentId'];
        if (isset($o['AnnotationJson'])) $this->AnnotationJson = $o['AnnotationJson'];
        if (isset($o['FlattenedDataUrl'])) $this->FlattenedDataUrl = $o['FlattenedDataUrl'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AttachmentId)) $o['AttachmentId'] = $this->AttachmentId;
        if (isset($this->AnnotationJson)) $o['AnnotationJson'] = $this->AnnotationJson;
        if (isset($this->FlattenedDataUrl)) $o['FlattenedDataUrl'] = $this->FlattenedDataUrl;
        return empty($o) ? new class(){} : $o;
    }
}

PHP PhotoAnnotationRequest DTOs

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>