Trackunit API

<back to all web services

GetClient

<?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};


// @DataContract
class Address implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $country=null,

        // @DataMember
        /** @var string|null */
        public ?string $zipCode=null,

        // @DataMember
        /** @var string|null */
        public ?string $city=null,

        // @DataMember
        /** @var string|null */
        public ?string $streetAddress=null
    ) {
    }

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

// @DataContract
class Client implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $id=null,

        // @DataMember
        /** @var string|null */
        public ?string $name=null,

        // @DataMember
        /** @var string|null */
        public ?string $note=null,

        // @DataMember
        /** @var Address|null */
        public ?Address $address=null
    ) {
    }

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

// @DataContract
class GetClientResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var array<Client>|null */
        public ?array $list=null,

        // @DataMember
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

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

// @DataContract
class GetClient implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $id=null
    ) {
    }

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

PHP GetClient DTOs

POST /GetClient HTTP/1.1 
Host: api.trackunit.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Id>String</Id>
</GetClient>

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

<GetClientResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <List>
    <Client>
      <Address>
        <City>String</City>
        <Country>String</Country>
        <StreetAddress>String</StreetAddress>
        <ZipCode>String</ZipCode>
      </Address>
      <Id>String</Id>
      <Name>String</Name>
      <Note>String</Note>
    </Client>
  </List>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <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>
        </Meta>
      </ResponseError>
    </Errors>
    <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>
    </Meta>
  </ResponseStatus>
</GetClientResponse>