Trendsic Platform Service

KioskAppointmentCheckinRequest

The following routes are available for this service:
POST,OPTIONS	/v1/kiosk/appointmentcheckin

<?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 KioskAppointmentCheckinResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var bool|null */
        public ?bool $Matched=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var DateTime|null */
        public ?DateTime $AppointmentTime=null,
        /** @var int */
        public int $Position=0,
        /** @var int|null */
        public ?int $EstWaitMinutes=null,
        /** @var string|null */
        public ?string $Message=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['Matched'])) $this->Matched = $o['Matched'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['AppointmentTime'])) $this->AppointmentTime = JsonConverters::from('DateTime', $o['AppointmentTime']);
        if (isset($o['Position'])) $this->Position = $o['Position'];
        if (isset($o['EstWaitMinutes'])) $this->EstWaitMinutes = $o['EstWaitMinutes'];
        if (isset($o['Message'])) $this->Message = $o['Message'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->Matched)) $o['Matched'] = $this->Matched;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->AppointmentTime)) $o['AppointmentTime'] = JsonConverters::to('DateTime', $this->AppointmentTime);
        if (isset($this->Position)) $o['Position'] = $this->Position;
        if (isset($this->EstWaitMinutes)) $o['EstWaitMinutes'] = $this->EstWaitMinutes;
        if (isset($this->Message)) $o['Message'] = $this->Message;
        return empty($o) ? new class(){} : $o;
    }
}

class KioskAppointmentCheckinRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ApiKey='',
        /** @var string */
        public string $LocationId='',
        /** @var string|null */
        public ?string $Query=null
    ) {
    }

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

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

POST /v1/kiosk/appointmentcheckin HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<KioskAppointmentCheckinRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
  <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
  <Query>String</Query>
</KioskAppointmentCheckinRequest>

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

<KioskAppointmentCheckinResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AppointmentTime>0001-01-01T00:00:00</AppointmentTime>
  <EstWaitMinutes>0</EstWaitMinutes>
  <Matched>false</Matched>
  <Message>String</Message>
  <Name>String</Name>
  <Position>0</Position>
  <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>
</KioskAppointmentCheckinResponse>