Server

<back to all web services

GetDevice

Devices
Requires Authentication
The following routes are available for this service:
GET/api/v1/devices/{Guid}
"use strict";
/** @typedef {'L'|'Kg'|'CBM'|'Stck'|'KWH'|'MWH'|'GWH'|'T'|'RM'|'Einheit'|'Qm'|'GJ'|'MJ'|'Null'|'St'|'Srm'|'Wh'} */
export var EinheitType;
(function (EinheitType) {
    EinheitType["L"] = "L"
    EinheitType["Kg"] = "Kg"
    EinheitType["CBM"] = "CBM"
    EinheitType["Stck"] = "Stck"
    EinheitType["KWH"] = "KWH"
    EinheitType["MWH"] = "MWH"
    EinheitType["GWH"] = "GWH"
    EinheitType["T"] = "T"
    EinheitType["RM"] = "RM"
    EinheitType["Einheit"] = "Einheit"
    EinheitType["Qm"] = "Qm"
    EinheitType["GJ"] = "GJ"
    EinheitType["MJ"] = "MJ"
    EinheitType["Null"] = "Null"
    EinheitType["St"] = "St"
    EinheitType["Srm"] = "Srm"
    EinheitType["Wh"] = "Wh"
})(EinheitType || (EinheitType = {}));
export class DeviceCatalog {
    /** @param {{Guid?:string,TypKurz?:string,TypLang?:string,Ablesbar?:boolean,Klasse?:string,Abzug?:boolean,Hkvv?:boolean,Funk?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    TypKurz;
    /** @type {string} */
    TypLang;
    /** @type {boolean} */
    Ablesbar;
    /** @type {string} */
    Klasse;
    /** @type {boolean} */
    Abzug;
    /** @type {boolean} */
    Hkvv;
    /** @type {boolean} */
    Funk;
}
/** @typedef {'ZA'|'HA'|'MO'|'EB'|'AB'} */
export var DeviceReadingKind;
(function (DeviceReadingKind) {
    DeviceReadingKind["ZA"] = "ZA"
    DeviceReadingKind["HA"] = "HA"
    DeviceReadingKind["MO"] = "MO"
    DeviceReadingKind["EB"] = "EB"
    DeviceReadingKind["AB"] = "AB"
})(DeviceReadingKind || (DeviceReadingKind = {}));
export class DeviceConsumption {
    /** @param {{guid?:string,deviceReading?:number,deviceReadingDate?:string,deviceReadingKind?:DeviceReadingKind,changeDate?:string,note?:string,ampouleColour?:string,deviceGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
    /** @type {?number} */
    deviceReading;
    /** @type {?string} */
    deviceReadingDate;
    /** @type {DeviceReadingKind} */
    deviceReadingKind;
    /** @type {?string} */
    changeDate;
    /** @type {string} */
    note;
    /** @type {string} */
    ampouleColour;
    /** @type {string} */
    deviceGuid;
}
export class Device {
    /** @param {{guid?:string,number?:string,label?:string,description?:string,installationDate?:string,deinstallationDate?:string,calibrationDate?:string,unit?:EinheitType,note?:string,deviceCatalog?:DeviceCatalog,deviceConsumptions?:DeviceConsumption[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
    /** @type {string} */
    number;
    /** @type {string} */
    label;
    /** @type {string} */
    description;
    /** @type {string} */
    installationDate;
    /** @type {?string} */
    deinstallationDate;
    /** @type {?string} */
    calibrationDate;
    /** @type {EinheitType} */
    unit;
    /** @type {string} */
    note;
    /** @type {DeviceCatalog} */
    deviceCatalog;
    /** @type {DeviceConsumption[]} */
    deviceConsumptions;
}
export class GetDeviceResponse {
    /** @param {{device?:Device,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Device} */
    device;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetDevice {
    /** @param {{bearerToken?:string,guid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    bearerToken;
    /** @type {string} */
    guid;
}

JavaScript GetDevice DTOs

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

HTTP + XML

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: heat-syke-servdesk.eras-online.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDeviceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get">
  <Device xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:CalibrationDate>0001-01-01T00:00:00</d2p1:CalibrationDate>
    <d2p1:DeinstallationDate>0001-01-01T00:00:00</d2p1:DeinstallationDate>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:DeviceCatalog xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Stammdaten">
      <d3p1:Ablesbar>false</d3p1:Ablesbar>
      <d3p1:Abzug>false</d3p1:Abzug>
      <d3p1:Funk>false</d3p1:Funk>
      <d3p1:Guid>String</d3p1:Guid>
      <d3p1:Hkvv>false</d3p1:Hkvv>
      <d3p1:Klasse>String</d3p1:Klasse>
      <d3p1:TypKurz>String</d3p1:TypKurz>
      <d3p1:TypLang>String</d3p1:TypLang>
    </d2p1:DeviceCatalog>
    <d2p1:DeviceConsumptions>
      <d2p1:DeviceConsumption>
        <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>
      </d2p1:DeviceConsumption>
    </d2p1:DeviceConsumptions>
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
    <d2p1:InstallationDate>0001-01-01T00:00:00</d2p1:InstallationDate>
    <d2p1:Label>String</d2p1:Label>
    <d2p1:Note>String</d2p1:Note>
    <d2p1:Number>String</d2p1:Number>
    <d2p1:Unit>L</d2p1:Unit>
  </Device>
  <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>
</GetDeviceResponse>