Server

<back to all web services

GetDevice

Devices
Requires Authentication
The following routes are available for this service:
GET/api/v1/devices/{Guid}
GetDevice Parameters:
NameParameterData TypeRequiredDescription
BearerTokenquerystringYes
GuidpathGuidYes
GetDeviceResponse Parameters:
NameParameterData TypeRequiredDescription
DeviceformDeviceNo
ResponseStatusformResponseStatusNo
Device Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
NumberformstringNo
LabelformstringNo
DescriptionformstringNo
InstallationDateformDateTimeNo
DeinstallationDateformDateTime?No
CalibrationDateformDateTime?No
UnitformEinheitTypeNo

Allowable Values

  • L
  • Kg
  • CBM
  • Stck
  • KWH
  • MWH
  • GWH
  • T
  • RM
  • Einheit
  • Qm
  • GJ
  • MJ
  • Null
  • St
  • Srm
  • Wh
NoteformstringNo
DeviceCatalogformDeviceCatalogNo
DeviceConsumptionsformList<DeviceConsumption>No
EinheitType Enum:
L
Kg
CBM
Stck
KWH
MWH
GWH
T
RM
Einheit
Qm
GJ
MJ
Null
St
Srm
Wh
DeviceCatalog Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
TypeShortformstringNo
TypeLongformstringNo
ReadableformboolNo
ClassformstringNo
SubtractionformboolNo
HkvvformboolNo
RadioformboolNo
DeviceConsumption Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
DeviceReadingformdouble?No
DeviceReadingDateformDateTime?No
DeviceReadingKindformDeviceReadingKindNo

Allowable Values

  • ZA
  • HA
  • MO
  • EB
  • AB
ChangeDateformDateTime?No
NoteformstringNo
AmpouleColourformstringNo
DeviceGuidformstringNo
DeviceReadingKind Enum:
ZA
HA
MO
EB
AB

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

HTTP + OTHER

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: mdf-servdesk.eras-online.de 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}