| GET | /pulsit/profile |
|---|
<?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 ApiServiceRequest implements IServiceRequest, IHasApiKey, JsonSerializable
{
public function __construct(
/** @description The API Key required for authentication */
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
/** @var string */
public string $ApiKey=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ApiKey'])) $this->ApiKey = $o['ApiKey'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ApiKey)) $o['ApiKey'] = $this->ApiKey;
return empty($o) ? new class(){} : $o;
}
}
class ApiServiceResponse implements IServiceResponse, JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Description=null,
/** @var string|null */
public ?string $Heading=null,
/** @var bool|null */
public ?bool $WasSuccessful=null,
/** @var Object|null */
public ?Object $ModelState=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['Heading'])) $this->Heading = $o['Heading'];
if (isset($o['WasSuccessful'])) $this->WasSuccessful = $o['WasSuccessful'];
if (isset($o['ModelState'])) $this->ModelState = JsonConverters::from('Object', $o['ModelState']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->Heading)) $o['Heading'] = $this->Heading;
if (isset($this->WasSuccessful)) $o['WasSuccessful'] = $this->WasSuccessful;
if (isset($this->ModelState)) $o['ModelState'] = JsonConverters::to('Object', $this->ModelState);
return empty($o) ? new class(){} : $o;
}
}
class PulsitModuleStatusItem implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $PulsitModuleId=null,
/** @var float */
public float $Latitude=0.0,
/** @var float */
public float $Longitude=0.0,
/** @var string|null */
public ?string $EventDescription=null,
/** @var DateTime */
public DateTime $EventTime=new DateTime(),
/** @var string|null */
public ?string $Status=null,
/** @var int */
public int $PulsitStartId=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['PulsitModuleId'])) $this->PulsitModuleId = $o['PulsitModuleId'];
if (isset($o['Latitude'])) $this->Latitude = $o['Latitude'];
if (isset($o['Longitude'])) $this->Longitude = $o['Longitude'];
if (isset($o['EventDescription'])) $this->EventDescription = $o['EventDescription'];
if (isset($o['EventTime'])) $this->EventTime = JsonConverters::from('DateTime', $o['EventTime']);
if (isset($o['Status'])) $this->Status = $o['Status'];
if (isset($o['PulsitStartId'])) $this->PulsitStartId = $o['PulsitStartId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->PulsitModuleId)) $o['PulsitModuleId'] = $this->PulsitModuleId;
if (isset($this->Latitude)) $o['Latitude'] = $this->Latitude;
if (isset($this->Longitude)) $o['Longitude'] = $this->Longitude;
if (isset($this->EventDescription)) $o['EventDescription'] = $this->EventDescription;
if (isset($this->EventTime)) $o['EventTime'] = JsonConverters::to('DateTime', $this->EventTime);
if (isset($this->Status)) $o['Status'] = $this->Status;
if (isset($this->PulsitStartId)) $o['PulsitStartId'] = $this->PulsitStartId;
return empty($o) ? new class(){} : $o;
}
}
class PulsitProfileProductItem implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Product=null,
/** @var string|null */
public ?string $Make=null,
/** @var string|null */
public ?string $Model=null,
/** @var string|null */
public ?string $Year=null,
/** @var string|null */
public ?string $RegistrationNumber=null,
/** @var string|null */
public ?string $PulsitModuleId=null,
/** @var PulsitModuleStatusItem|null */
public ?PulsitModuleStatusItem $LatestStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Product'])) $this->Product = $o['Product'];
if (isset($o['Make'])) $this->Make = $o['Make'];
if (isset($o['Model'])) $this->Model = $o['Model'];
if (isset($o['Year'])) $this->Year = $o['Year'];
if (isset($o['RegistrationNumber'])) $this->RegistrationNumber = $o['RegistrationNumber'];
if (isset($o['PulsitModuleId'])) $this->PulsitModuleId = $o['PulsitModuleId'];
if (isset($o['LatestStatus'])) $this->LatestStatus = JsonConverters::from('PulsitModuleStatusItem', $o['LatestStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Product)) $o['Product'] = $this->Product;
if (isset($this->Make)) $o['Make'] = $this->Make;
if (isset($this->Model)) $o['Model'] = $this->Model;
if (isset($this->Year)) $o['Year'] = $this->Year;
if (isset($this->RegistrationNumber)) $o['RegistrationNumber'] = $this->RegistrationNumber;
if (isset($this->PulsitModuleId)) $o['PulsitModuleId'] = $this->PulsitModuleId;
if (isset($this->LatestStatus)) $o['LatestStatus'] = JsonConverters::to('PulsitModuleStatusItem', $this->LatestStatus);
return empty($o) ? new class(){} : $o;
}
}
enum DeviceType : int
{
case Lock = 0;
case HomeSecurity = 1;
}
class PulsitProfileDeviceItem implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $PulsitModuleId=null,
/** @var string|null */
public ?string $Product=null,
/** @var string|null */
public ?string $Description=null,
/** @var DeviceType|null */
public ?DeviceType $Type=null,
/** @var string|null */
public ?string $TypeString=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['PulsitModuleId'])) $this->PulsitModuleId = $o['PulsitModuleId'];
if (isset($o['Product'])) $this->Product = $o['Product'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['Type'])) $this->Type = JsonConverters::from('DeviceType', $o['Type']);
if (isset($o['TypeString'])) $this->TypeString = $o['TypeString'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->PulsitModuleId)) $o['PulsitModuleId'] = $this->PulsitModuleId;
if (isset($this->Product)) $o['Product'] = $this->Product;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->Type)) $o['Type'] = JsonConverters::to('DeviceType', $this->Type);
if (isset($this->TypeString)) $o['TypeString'] = $this->TypeString;
return empty($o) ? new class(){} : $o;
}
}
class PulsitProfileResponse extends ApiServiceResponse implements JsonSerializable
{
/**
* @param string|null $Description
* @param string|null $Heading
* @param bool|null $WasSuccessful
* @param Object|null $ModelState
*/
public function __construct(
?string $Description=null,
?string $Heading=null,
?bool $WasSuccessful=null,
?Object $ModelState=null,
/** @var array<PulsitProfileProductItem>|null */
public ?array $Products=null,
/** @var array<PulsitProfileDeviceItem>|null */
public ?array $Devices=null
) {
parent::__construct($Description,$Heading,$WasSuccessful,$ModelState);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Products'])) $this->Products = JsonConverters::fromArray('PulsitProfileProductItem', $o['Products']);
if (isset($o['Devices'])) $this->Devices = JsonConverters::fromArray('PulsitProfileDeviceItem', $o['Devices']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Products)) $o['Products'] = JsonConverters::toArray('PulsitProfileProductItem', $this->Products);
if (isset($this->Devices)) $o['Devices'] = JsonConverters::toArray('PulsitProfileDeviceItem', $this->Devices);
return empty($o) ? new class(){} : $o;
}
}
class PulsitProfileRequest extends ApiServiceRequest implements JsonSerializable
{
/**
* @param string $ApiKey
*/
public function __construct(
string $ApiKey='',
/** @var string|null */
public ?string $IdNumber=null
) {
parent::__construct($ApiKey);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['IdNumber'])) $this->IdNumber = $o['IdNumber'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->IdNumber)) $o['IdNumber'] = $this->IdNumber;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /pulsit/profile HTTP/1.1 Host: galaxymobile.api.client.prod.86degrees.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PulsitProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientApi.Services">
<Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
<Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
<ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
<WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
<Devices>
<PulsitProfileDeviceItem>
<Description>String</Description>
<Product>String</Product>
<PulsitModuleId>String</PulsitModuleId>
<Type>Lock</Type>
</PulsitProfileDeviceItem>
</Devices>
<Products>
<PulsitProfileProductItem>
<LatestStatus>
<EventDescription>String</EventDescription>
<EventTime>0001-01-01T00:00:00</EventTime>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
<PulsitModuleId>String</PulsitModuleId>
<PulsitStartId>0</PulsitStartId>
<Status>String</Status>
</LatestStatus>
<Make>String</Make>
<Model>String</Model>
<Product>String</Product>
<PulsitModuleId>String</PulsitModuleId>
<RegistrationNumber>String</RegistrationNumber>
<Year>String</Year>
</PulsitProfileProductItem>
</Products>
</PulsitProfileResponse>