| POST | /api/v1/deviceconsumptions |
|---|
<?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 PostDeviceConsumptionResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null,
/** @var string|null */
public ?string $checksumMD5=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
if (isset($o['checksumMD5'])) $this->checksumMD5 = $o['checksumMD5'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
if (isset($this->checksumMD5)) $o['checksumMD5'] = $this->checksumMD5;
return empty($o) ? new class(){} : $o;
}
}
enum DeviceReadingKind : string
{
case ZA = 'ZA';
case HA = 'HA';
case MO = 'MO';
case EB = 'EB';
case AB = 'AB';
}
// @DataContract
class DeviceConsumption implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string */
public string $guid='',
// @DataMember
/** @var float|null */
public ?float $deviceReading=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $deviceReadingDate=null,
// @DataMember
/** @var DeviceReadingKind|null */
public ?DeviceReadingKind $deviceReadingKind=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $changeDate=null,
// @DataMember
/** @var string|null */
public ?string $note=null,
// @DataMember
/** @var string|null */
public ?string $ampouleColour=null,
// @DataMember
/** @var string|null */
public ?string $deviceGuid=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['guid'])) $this->guid = $o['guid'];
if (isset($o['deviceReading'])) $this->deviceReading = $o['deviceReading'];
if (isset($o['deviceReadingDate'])) $this->deviceReadingDate = JsonConverters::from('DateTime', $o['deviceReadingDate']);
if (isset($o['deviceReadingKind'])) $this->deviceReadingKind = JsonConverters::from('DeviceReadingKind', $o['deviceReadingKind']);
if (isset($o['changeDate'])) $this->changeDate = JsonConverters::from('DateTime', $o['changeDate']);
if (isset($o['note'])) $this->note = $o['note'];
if (isset($o['ampouleColour'])) $this->ampouleColour = $o['ampouleColour'];
if (isset($o['deviceGuid'])) $this->deviceGuid = $o['deviceGuid'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->guid)) $o['guid'] = $this->guid;
if (isset($this->deviceReading)) $o['deviceReading'] = $this->deviceReading;
if (isset($this->deviceReadingDate)) $o['deviceReadingDate'] = JsonConverters::to('DateTime', $this->deviceReadingDate);
if (isset($this->deviceReadingKind)) $o['deviceReadingKind'] = JsonConverters::to('DeviceReadingKind', $this->deviceReadingKind);
if (isset($this->changeDate)) $o['changeDate'] = JsonConverters::to('DateTime', $this->changeDate);
if (isset($this->note)) $o['note'] = $this->note;
if (isset($this->ampouleColour)) $o['ampouleColour'] = $this->ampouleColour;
if (isset($this->deviceGuid)) $o['deviceGuid'] = $this->deviceGuid;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class RelatedTo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string */
public string $guid=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['guid'])) $this->guid = $o['guid'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->guid)) $o['guid'] = $this->guid;
return empty($o) ? new class(){} : $o;
}
}
class PostDeviceConsumption implements IHasBearerToken, JsonSerializable
{
public function __construct(
// @ApiMember(IsRequired=true, ParameterType="body")
/** @var DeviceConsumption|null */
public ?DeviceConsumption $deviceConsumption=null,
// @ApiMember(IsRequired=true, ParameterType="body")
/** @var RelatedTo|null */
public ?RelatedTo $relatedToDevice=null,
// @ApiMember(IsRequired=true, ParameterType="body")
/** @var string */
public string $bearerToken=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['deviceConsumption'])) $this->deviceConsumption = JsonConverters::from('DeviceConsumption', $o['deviceConsumption']);
if (isset($o['relatedToDevice'])) $this->relatedToDevice = JsonConverters::from('RelatedTo', $o['relatedToDevice']);
if (isset($o['bearerToken'])) $this->bearerToken = $o['bearerToken'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->deviceConsumption)) $o['deviceConsumption'] = JsonConverters::to('DeviceConsumption', $this->deviceConsumption);
if (isset($this->relatedToDevice)) $o['relatedToDevice'] = JsonConverters::to('RelatedTo', $this->relatedToDevice);
if (isset($this->bearerToken)) $o['bearerToken'] = $this->bearerToken;
return empty($o) ? new class(){} : $o;
}
}
PHP PostDeviceConsumption DTOs
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 /api/v1/deviceconsumptions HTTP/1.1
Host: brendle-schneider-servdesk.eras-online.de
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PostDeviceConsumption xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Post">
<BearerToken>String</BearerToken>
<DeviceConsumption xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
<d2p1:AmpouleColour>String</d2p1:AmpouleColour>
<d2p1:ChangeDate>0001-01-01T00:00:00</d2p1:ChangeDate>
<d2p1:DeviceGuid>String</d2p1:DeviceGuid>
<d2p1:DeviceReading>0</d2p1:DeviceReading>
<d2p1:DeviceReadingDate>0001-01-01T00:00:00</d2p1:DeviceReadingDate>
<d2p1:DeviceReadingKind>ZA</d2p1:DeviceReadingKind>
<d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
<d2p1:Note>String</d2p1:Note>
</DeviceConsumption>
<RelatedToDevice xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
<d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
</RelatedToDevice>
</PostDeviceConsumption>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PostDeviceConsumptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Post">
<ChecksumMD5>String</ChecksumMD5>
<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>
</PostDeviceConsumptionResponse>