Server

<back to all web services

GetDeviceConsumptionList

<?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};


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;
    }
}

class GetDeviceConsumptionListResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<DeviceConsumption>|null */
        public ?array $deviceConsumptionList=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

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

class GetDeviceConsumptionList implements IHasBearerToken, JsonSerializable
{
    public function __construct(
        // @ApiMember(IsRequired=true, ParameterType="query")
        /** @var string */
        public string $bearerToken='',

        /** @description Optional! Follow the format : /api/v1/deviceconsumptions?filter[DeviceGuid]=* */
        // @DataMember(Name="filter[DeviceGuid]")
        // @ApiMember(Description="Optional! Follow the format : /api/v1/deviceconsumptions?filter[DeviceGuid]=*", ParameterType="query")
        /** @var string|null */
        public ?string $filter_DeviceGuid_=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['bearerToken'])) $this->bearerToken = $o['bearerToken'];
        if (isset($o['filter_DeviceGuid_'])) $this->filter_DeviceGuid_ = $o['filter_DeviceGuid_'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->bearerToken)) $o['bearerToken'] = $this->bearerToken;
        if (isset($this->filter_DeviceGuid_)) $o['filter_DeviceGuid_'] = $this->filter_DeviceGuid_;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetDeviceConsumptionList DTOs

GET /api/v1/deviceconsumptions HTTP/1.1 
Host: knabrechnung-servdesk.eras-online.de 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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