Trendsic Platform Service

BranchApptAuditRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/queue/appointments/{CheckInId}/audit

<?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 BranchApptAuditEntry implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Kind=null,
        /** @var string|null */
        public ?string $Summary=null,
        /** @var string|null */
        public ?string $Reason=null,
        /** @var bool|null */
        public ?bool $Notified=null,
        /** @var string|null */
        public ?string $UserName=null,
        /** @var DateTime */
        public DateTime $AtLocal=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Kind'])) $this->Kind = $o['Kind'];
        if (isset($o['Summary'])) $this->Summary = $o['Summary'];
        if (isset($o['Reason'])) $this->Reason = $o['Reason'];
        if (isset($o['Notified'])) $this->Notified = $o['Notified'];
        if (isset($o['UserName'])) $this->UserName = $o['UserName'];
        if (isset($o['AtLocal'])) $this->AtLocal = JsonConverters::from('DateTime', $o['AtLocal']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Kind)) $o['Kind'] = $this->Kind;
        if (isset($this->Summary)) $o['Summary'] = $this->Summary;
        if (isset($this->Reason)) $o['Reason'] = $this->Reason;
        if (isset($this->Notified)) $o['Notified'] = $this->Notified;
        if (isset($this->UserName)) $o['UserName'] = $this->UserName;
        if (isset($this->AtLocal)) $o['AtLocal'] = JsonConverters::to('DateTime', $this->AtLocal);
        return empty($o) ? new class(){} : $o;
    }
}

class BranchApptAuditResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<BranchApptAuditEntry>|null */
        public ?array $Entries=null
    ) {
    }

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

class BranchApptAuditRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $CheckInId=''
    ) {
    }

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

PHP BranchApptAuditRequest 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.

GET /v1/queue/appointments/{CheckInId}/audit HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BranchApptAuditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Entries>
    <BranchApptAuditEntry>
      <AtLocal>0001-01-01T00:00:00</AtLocal>
      <Kind>String</Kind>
      <Notified>false</Notified>
      <Reason>String</Reason>
      <Summary>String</Summary>
      <UserName>String</UserName>
    </BranchApptAuditEntry>
  </Entries>
  <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>
</BranchApptAuditResponse>