Trackunit API

<back to all web services

GetUnitExtendedInfo

The following routes are available for this service:
GET POST/GetUnitExtendedInfo
<?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 GetUnitExtendedInfoResult implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $name=null,

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

        // @DataMember
        /** @var int */
        public int $variableId=0,

        // @DataMember
        /** @var DateTime */
        public DateTime $time=new DateTime(),

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

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

// @DataContract
class GetUnitExtendedInfoResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var array<GetUnitExtendedInfoResult>|null */
        public ?array $result=null,

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

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

// @DataContract
class GetUnitExtendedInfo 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 GetUnitExtendedInfo 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 /GetUnitExtendedInfo HTTP/1.1 
Host: api.trackunit.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetUnitExtendedInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Id>String</Id>
</GetUnitExtendedInfo>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetUnitExtendedInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <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>
  <Result>
    <GetUnitExtendedInfoResult>
      <Name>String</Name>
      <Time>0001-01-01T00:00:00</Time>
      <UoM>String</UoM>
      <Value>String</Value>
      <VariableId>0</VariableId>
    </GetUnitExtendedInfoResult>
  </Result>
</GetUnitExtendedInfoResponse>