| POST | /cmd/locations |
|---|
<?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 Ref implements JsonSerializable
{
public function __construct(
/** @var string */
public string $id='',
/** @var string */
public string $val=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['val'])) $this->val = $o['val'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->val)) $o['val'] = $this->val;
return empty($o) ? new class(){} : $o;
}
}
class RefEx extends Ref implements JsonSerializable
{
/**
* @param string $id
* @param string $val
*/
public function __construct(
string $id='',
string $val='',
/** @var RecordDictionary2<string, string>|null */
public ?RecordDictionary2 $data=null
) {
parent::__construct($id,$val);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['data'])) $this->data = JsonConverters::from(JsonConverters::context('RecordDictionary2',genericArgs:['string','string']), $o['data']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->data)) $o['data'] = JsonConverters::to(JsonConverters::context('RecordDictionary2',genericArgs:['string','string']), $this->data);
return empty($o) ? new class(){} : $o;
}
}
class GPSCoordinates implements JsonSerializable
{
public function __construct(
/** @var float */
public float $lat=0.0,
/** @var float */
public float $lng=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['lat'])) $this->lat = $o['lat'];
if (isset($o['lng'])) $this->lng = $o['lng'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->lat)) $o['lat'] = $this->lat;
if (isset($this->lng)) $o['lng'] = $this->lng;
return empty($o) ? new class(){} : $o;
}
}
class Address implements JsonSerializable
{
public function __construct(
/** @var string */
public string $street='',
/** @var string */
public string $city='',
/** @var string */
public string $state='',
/** @var string */
public string $postalCode='',
/** @var Ref|null */
public ?Ref $country=null,
/** @var GPSCoordinates|null */
public ?GPSCoordinates $gps=null,
/** @var RecordDictionary2<string, string>|null */
public ?RecordDictionary2 $data=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['street'])) $this->street = $o['street'];
if (isset($o['city'])) $this->city = $o['city'];
if (isset($o['state'])) $this->state = $o['state'];
if (isset($o['postalCode'])) $this->postalCode = $o['postalCode'];
if (isset($o['country'])) $this->country = JsonConverters::from('Ref', $o['country']);
if (isset($o['gps'])) $this->gps = JsonConverters::from('GPSCoordinates', $o['gps']);
if (isset($o['data'])) $this->data = JsonConverters::from(JsonConverters::context('RecordDictionary2',genericArgs:['string','string']), $o['data']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->street)) $o['street'] = $this->street;
if (isset($this->city)) $o['city'] = $this->city;
if (isset($this->state)) $o['state'] = $this->state;
if (isset($this->postalCode)) $o['postalCode'] = $this->postalCode;
if (isset($this->country)) $o['country'] = JsonConverters::to('Ref', $this->country);
if (isset($this->gps)) $o['gps'] = JsonConverters::to('GPSCoordinates', $this->gps);
if (isset($this->data)) $o['data'] = JsonConverters::to(JsonConverters::context('RecordDictionary2',genericArgs:['string','string']), $this->data);
return empty($o) ? new class(){} : $o;
}
}
enum DeviceType : int
{
case ClerkServicedKiosk = 0;
case PersonalOnline = 1;
case SelfServiceKiosk = 2;
case Unknown = -1;
}
class Device implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $id=null,
/** @var string|null */
public ?string $name=null,
/** @var bool|null */
public ?bool $isActive=null,
/** @var DeviceType|null */
public ?DeviceType $type=null,
/** @var RecordDictionary2<string, string>|null */
public ?RecordDictionary2 $integrationsData=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['isActive'])) $this->isActive = $o['isActive'];
if (isset($o['type'])) $this->type = JsonConverters::from('DeviceType', $o['type']);
if (isset($o['integrationsData'])) $this->integrationsData = JsonConverters::from(JsonConverters::context('RecordDictionary2',genericArgs:['string','string']), $o['integrationsData']);
}
/** @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->isActive)) $o['isActive'] = $this->isActive;
if (isset($this->type)) $o['type'] = JsonConverters::to('DeviceType', $this->type);
if (isset($this->integrationsData)) $o['integrationsData'] = JsonConverters::to(JsonConverters::context('RecordDictionary2',genericArgs:['string','string']), $this->integrationsData);
return empty($o) ? new class(){} : $o;
}
}
class ProductReference implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $id=null,
/** @var string|null */
public ?string $value=null,
/** @var string|null */
public ?string $category=null,
/** @var Ref|null */
public ?Ref $productProvider=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['value'])) $this->value = $o['value'];
if (isset($o['category'])) $this->category = $o['category'];
if (isset($o['productProvider'])) $this->productProvider = JsonConverters::from('Ref', $o['productProvider']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->value)) $o['value'] = $this->value;
if (isset($this->category)) $o['category'] = $this->category;
if (isset($this->productProvider)) $o['productProvider'] = JsonConverters::to('Ref', $this->productProvider);
return empty($o) ? new class(){} : $o;
}
}
class ProductInstanceRef implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $id=null,
/** @var string|null */
public ?string $name=null,
/** @var string|null */
public ?string $title=null,
/** @var ProductReference|null */
public ?ProductReference $product=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['title'])) $this->title = $o['title'];
if (isset($o['product'])) $this->product = JsonConverters::from('ProductReference', $o['product']);
}
/** @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->title)) $o['title'] = $this->title;
if (isset($this->product)) $o['product'] = JsonConverters::to('ProductReference', $this->product);
return empty($o) ? new class(){} : $o;
}
}
class Locale implements JsonSerializable
{
public function __construct(
/** @var Ref|null */
public ?Ref $timeZone=null,
/** @var Ref|null */
public ?Ref $currency=null,
/** @var Ref|null */
public ?Ref $language=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['timeZone'])) $this->timeZone = JsonConverters::from('Ref', $o['timeZone']);
if (isset($o['currency'])) $this->currency = JsonConverters::from('Ref', $o['currency']);
if (isset($o['language'])) $this->language = JsonConverters::from('Ref', $o['language']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->timeZone)) $o['timeZone'] = JsonConverters::to('Ref', $this->timeZone);
if (isset($this->currency)) $o['currency'] = JsonConverters::to('Ref', $this->currency);
if (isset($this->language)) $o['language'] = JsonConverters::to('Ref', $this->language);
return empty($o) ? new class(){} : $o;
}
}
class OpenLocation implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $id=null,
/** @var string|null */
public ?string $name=null,
/** @var RefEx|null */
public ?RefEx $organization=null,
/** @var Ref|null */
public ?Ref $region=null,
/** @var Ref|null */
public ?Ref $group=null,
/** @var Address|null */
public ?Address $address=null,
/** @var array<Device>|null */
public ?array $devices=null,
/** @var array<ProductInstanceRef>|null */
public ?array $productInstances=null,
/** @var Locale|null */
public ?Locale $locale=null,
/** @var array<string,string>|null */
public ?array $integrationsData=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['organization'])) $this->organization = JsonConverters::from('RefEx', $o['organization']);
if (isset($o['region'])) $this->region = JsonConverters::from('Ref', $o['region']);
if (isset($o['group'])) $this->group = JsonConverters::from('Ref', $o['group']);
if (isset($o['address'])) $this->address = JsonConverters::from('Address', $o['address']);
if (isset($o['devices'])) $this->devices = JsonConverters::fromArray('Device', $o['devices']);
if (isset($o['productInstances'])) $this->productInstances = JsonConverters::fromArray('ProductInstanceRef', $o['productInstances']);
if (isset($o['locale'])) $this->locale = JsonConverters::from('Locale', $o['locale']);
if (isset($o['integrationsData'])) $this->integrationsData = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['integrationsData']);
}
/** @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->organization)) $o['organization'] = JsonConverters::to('RefEx', $this->organization);
if (isset($this->region)) $o['region'] = JsonConverters::to('Ref', $this->region);
if (isset($this->group)) $o['group'] = JsonConverters::to('Ref', $this->group);
if (isset($this->address)) $o['address'] = JsonConverters::to('Address', $this->address);
if (isset($this->devices)) $o['devices'] = JsonConverters::toArray('Device', $this->devices);
if (isset($this->productInstances)) $o['productInstances'] = JsonConverters::toArray('ProductInstanceRef', $this->productInstances);
if (isset($this->locale)) $o['locale'] = JsonConverters::to('Locale', $this->locale);
if (isset($this->integrationsData)) $o['integrationsData'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->integrationsData);
return empty($o) ? new class(){} : $o;
}
}
/**
* @template TKey
* @template TVal
* @template array of TKey
* @template array1 of TVal
*/
class RecordDictionary2 extends array implements JsonSerializable
{
public array $genericArgs = [];
public static function create(array $genericArgs=[]): RecordDictionary2 {
$to = new RecordDictionary2();
$to->genericArgs = $genericArgs;
return $to;
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
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.
POST /cmd/locations HTTP/1.1
Host: api.beto2.webhop.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<OpenLocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Betting.WebApi.ServiceModel">
<Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/Starnet.Common">
<d2p1:City>String</d2p1:City>
<d2p1:Country>
<d2p1:_x003C_Id_x003E_k__BackingField>String</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_Val_x003E_k__BackingField>String</d2p1:_x003C_Val_x003E_k__BackingField>
</d2p1:Country>
<d2p1:Data 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:Data>
<d2p1:GPS>
<d2p1:Lat>0</d2p1:Lat>
<d2p1:Lng>0</d2p1:Lng>
</d2p1:GPS>
<d2p1:PostalCode>String</d2p1:PostalCode>
<d2p1:State>String</d2p1:State>
<d2p1:Street>String</d2p1:Street>
</Address>
<Devices xmlns:d2p1="http://schemas.datacontract.org/2004/07/Betting.Common">
<d2p1:Device>
<d2p1:Id>String</d2p1:Id>
<d2p1:IntegrationsData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</d2p1:IntegrationsData>
<d2p1:IsActive>false</d2p1:IsActive>
<d2p1:Name>String</d2p1:Name>
<d2p1:Type>ClerkServicedKiosk</d2p1:Type>
</d2p1:Device>
</Devices>
<Group xmlns:d2p1="http://schemas.datacontract.org/2004/07/Starnet.Common">
<d2p1:_x003C_Id_x003E_k__BackingField>String</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_Val_x003E_k__BackingField>String</d2p1:_x003C_Val_x003E_k__BackingField>
</Group>
<Id>String</Id>
<IntegrationsData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</IntegrationsData>
<Locale xmlns:d2p1="http://schemas.datacontract.org/2004/07/Betting.Common">
<d2p1:Currency xmlns:d3p1="http://schemas.datacontract.org/2004/07/Starnet.Common">
<d3p1:_x003C_Id_x003E_k__BackingField>String</d3p1:_x003C_Id_x003E_k__BackingField>
<d3p1:_x003C_Val_x003E_k__BackingField>String</d3p1:_x003C_Val_x003E_k__BackingField>
</d2p1:Currency>
<d2p1:Language xmlns:d3p1="http://schemas.datacontract.org/2004/07/Starnet.Common">
<d3p1:_x003C_Id_x003E_k__BackingField>String</d3p1:_x003C_Id_x003E_k__BackingField>
<d3p1:_x003C_Val_x003E_k__BackingField>String</d3p1:_x003C_Val_x003E_k__BackingField>
</d2p1:Language>
<d2p1:TimeZone xmlns:d3p1="http://schemas.datacontract.org/2004/07/Starnet.Common">
<d3p1:_x003C_Id_x003E_k__BackingField>String</d3p1:_x003C_Id_x003E_k__BackingField>
<d3p1:_x003C_Val_x003E_k__BackingField>String</d3p1:_x003C_Val_x003E_k__BackingField>
</d2p1:TimeZone>
</Locale>
<Name>String</Name>
<Organization xmlns:d2p1="http://schemas.datacontract.org/2004/07/Starnet.Common">
<d2p1:_x003C_Id_x003E_k__BackingField>String</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_Val_x003E_k__BackingField>String</d2p1:_x003C_Val_x003E_k__BackingField>
<d2p1:_x003C_Data_x003E_k__BackingField 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:_x003C_Data_x003E_k__BackingField>
</Organization>
<ProductInstances xmlns:d2p1="http://schemas.datacontract.org/2004/07/Betting.Common">
<d2p1:ProductInstanceRef>
<d2p1:Id>String</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
<d2p1:Product>
<d2p1:Category>String</d2p1:Category>
<d2p1:Id>String</d2p1:Id>
<d2p1:ProductProvider xmlns:d5p1="http://schemas.datacontract.org/2004/07/Starnet.Common">
<d5p1:_x003C_Id_x003E_k__BackingField>String</d5p1:_x003C_Id_x003E_k__BackingField>
<d5p1:_x003C_Val_x003E_k__BackingField>String</d5p1:_x003C_Val_x003E_k__BackingField>
</d2p1:ProductProvider>
<d2p1:Value>String</d2p1:Value>
</d2p1:Product>
<d2p1:Title>String</d2p1:Title>
</d2p1:ProductInstanceRef>
</ProductInstances>
<Region xmlns:d2p1="http://schemas.datacontract.org/2004/07/Starnet.Common">
<d2p1:_x003C_Id_x003E_k__BackingField>String</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_Val_x003E_k__BackingField>String</d2p1:_x003C_Val_x003E_k__BackingField>
</Region>
</OpenLocation>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>