Server

<back to all web services

GetDevice

Devices
Requires Authentication
The following routes are available for this service:
GET/api/v1/devices/{Guid}
<?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 EinheitType : string
{
    case L = 'L';
    case Kg = 'Kg';
    case CBM = 'CBM';
    case Stck = 'Stck';
    case KWH = 'KWH';
    case MWH = 'MWH';
    case GWH = 'GWH';
    case T = 'T';
    case RM = 'RM';
    case Einheit = 'Einheit';
    case Qm = 'Qm';
    case GJ = 'GJ';
    case MJ = 'MJ';
    case Null = 'Null';
    case St = 'St';
    case Srm = 'Srm';
    case Wh = 'Wh';
}

// @DataContract
class DeviceCatalog implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="Guid")
        /** @var string|null */
        public ?string $Guid=null,

        // @DataMember(Name="TypKurz")
        /** @var string|null */
        public ?string $TypKurz=null,

        // @DataMember(Name="TypLang")
        /** @var string|null */
        public ?string $TypLang=null,

        // @DataMember(Name="Ablesbar")
        /** @var bool|null */
        public ?bool $Ablesbar=null,

        // @DataMember(Name="Klasse")
        /** @var string|null */
        public ?string $Klasse=null,

        // @DataMember(Name="Abzug")
        /** @var bool|null */
        public ?bool $Abzug=null,

        // @DataMember(Name="Hkvv")
        /** @var bool|null */
        public ?bool $Hkvv=null,

        // @DataMember(Name="Funk")
        /** @var bool|null */
        public ?bool $Funk=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Guid'])) $this->Guid = $o['Guid'];
        if (isset($o['TypKurz'])) $this->TypKurz = $o['TypKurz'];
        if (isset($o['TypLang'])) $this->TypLang = $o['TypLang'];
        if (isset($o['Ablesbar'])) $this->Ablesbar = $o['Ablesbar'];
        if (isset($o['Klasse'])) $this->Klasse = $o['Klasse'];
        if (isset($o['Abzug'])) $this->Abzug = $o['Abzug'];
        if (isset($o['Hkvv'])) $this->Hkvv = $o['Hkvv'];
        if (isset($o['Funk'])) $this->Funk = $o['Funk'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Guid)) $o['Guid'] = $this->Guid;
        if (isset($this->TypKurz)) $o['TypKurz'] = $this->TypKurz;
        if (isset($this->TypLang)) $o['TypLang'] = $this->TypLang;
        if (isset($this->Ablesbar)) $o['Ablesbar'] = $this->Ablesbar;
        if (isset($this->Klasse)) $o['Klasse'] = $this->Klasse;
        if (isset($this->Abzug)) $o['Abzug'] = $this->Abzug;
        if (isset($this->Hkvv)) $o['Hkvv'] = $this->Hkvv;
        if (isset($this->Funk)) $o['Funk'] = $this->Funk;
        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 Device implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string */
        public string $guid='',

        // @DataMember
        /** @var string|null */
        public ?string $number=null,

        // @DataMember
        /** @var string|null */
        public ?string $label=null,

        // @DataMember
        /** @var string|null */
        public ?string $description=null,

        // @DataMember
        /** @var DateTime */
        public DateTime $installationDate=new DateTime(),

        // @DataMember
        /** @var DateTime|null */
        public ?DateTime $deinstallationDate=null,

        // @DataMember
        /** @var DateTime|null */
        public ?DateTime $calibrationDate=null,

        // @DataMember
        /** @var EinheitType|null */
        public ?EinheitType $unit=null,

        // @DataMember
        /** @var string|null */
        public ?string $note=null,

        // @DataMember
        /** @var DeviceCatalog|null */
        public ?DeviceCatalog $deviceCatalog=null,

        // @DataMember
        /** @var array<DeviceConsumption>|null */
        public ?array $deviceConsumptions=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['guid'])) $this->guid = $o['guid'];
        if (isset($o['number'])) $this->number = $o['number'];
        if (isset($o['label'])) $this->label = $o['label'];
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['installationDate'])) $this->installationDate = JsonConverters::from('DateTime', $o['installationDate']);
        if (isset($o['deinstallationDate'])) $this->deinstallationDate = JsonConverters::from('DateTime', $o['deinstallationDate']);
        if (isset($o['calibrationDate'])) $this->calibrationDate = JsonConverters::from('DateTime', $o['calibrationDate']);
        if (isset($o['unit'])) $this->unit = JsonConverters::from('EinheitType', $o['unit']);
        if (isset($o['note'])) $this->note = $o['note'];
        if (isset($o['deviceCatalog'])) $this->deviceCatalog = JsonConverters::from('DeviceCatalog', $o['deviceCatalog']);
        if (isset($o['deviceConsumptions'])) $this->deviceConsumptions = JsonConverters::fromArray('DeviceConsumption', $o['deviceConsumptions']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->guid)) $o['guid'] = $this->guid;
        if (isset($this->number)) $o['number'] = $this->number;
        if (isset($this->label)) $o['label'] = $this->label;
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->installationDate)) $o['installationDate'] = JsonConverters::to('DateTime', $this->installationDate);
        if (isset($this->deinstallationDate)) $o['deinstallationDate'] = JsonConverters::to('DateTime', $this->deinstallationDate);
        if (isset($this->calibrationDate)) $o['calibrationDate'] = JsonConverters::to('DateTime', $this->calibrationDate);
        if (isset($this->unit)) $o['unit'] = JsonConverters::to('EinheitType', $this->unit);
        if (isset($this->note)) $o['note'] = $this->note;
        if (isset($this->deviceCatalog)) $o['deviceCatalog'] = JsonConverters::to('DeviceCatalog', $this->deviceCatalog);
        if (isset($this->deviceConsumptions)) $o['deviceConsumptions'] = JsonConverters::toArray('DeviceConsumption', $this->deviceConsumptions);
        return empty($o) ? new class(){} : $o;
    }
}

class GetDeviceResponse implements JsonSerializable
{
    public function __construct(
        /** @var Device|null */
        public ?Device $device=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

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

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

        // @ApiMember(IsRequired=true, ParameterType="path")
        /** @var string */
        public string $guid=''
    ) {
    }

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

PHP GetDevice DTOs

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

HTTP + CSV

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

GET /api/v1/devices/{Guid} HTTP/1.1 
Host: isp-plauen-servdesk.eras-online.de 
Accept: text/csv

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

{"device":{"guid":"00000000000000000000000000000000","number":"String","label":"String","description":"String","installationDate":"0001-01-01T00:00:00.0000000Z","deinstallationDate":"0001-01-01T00:00:00.0000000Z","calibrationDate":"0001-01-01T00:00:00.0000000Z","unit":"L","note":"String","deviceCatalog":{"Guid":"String","TypKurz":"String","TypLang":"String","Ablesbar":false,"Klasse":"String","Abzug":false,"Hkvv":false,"Funk":false},"deviceConsumptions":[{"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"}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}