Server

PutDeviceConsumption

Deviceconsumptions

The following routes are available for this service:
PUT	/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 PutDeviceConsumptionResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        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 PutDeviceConsumption 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 PutDeviceConsumption DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /api/v1/deviceconsumptions HTTP/1.1 
Host: brendle-schneider-servdesk.eras-online.de 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"deviceConsumption":{"guid":"00000000000000000000000000000000","deviceReading":0,"deviceReadingDate":"0001-01-01T00:00:00.0000000Z","deviceReadingKind":"ZA","changeDate":"0001-01-01T00:00:00.0000000Z","note":"String","ampouleColour":"String","deviceGuid":"String"},"relatedToDevice":{"guid":"00000000000000000000000000000000"},"bearerToken":"String"}

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

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}