| GET | /api/v1/devices/{Guid} |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
class EinheitType(str, Enum):
L = 'L'
KG = 'Kg'
CBM = 'CBM'
STCK = 'Stck'
KWH = 'KWH'
MWH = 'MWH'
GWH = 'GWH'
T = 'T'
RM = 'RM'
EINHEIT = 'Einheit'
QM = 'Qm'
GJ = 'GJ'
MJ = 'MJ'
NULL = 'Null'
ST = 'St'
SRM = 'Srm'
WH = 'Wh'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeviceCatalog:
guid: Optional[str] = None
type_short: Optional[str] = None
type_long: Optional[str] = None
readable: bool = False
class_: Optional[str] = field(metadata=config(field_name='class'), default=None)
subtraction: bool = False
hkvv: bool = False
radio: bool = False
class DeviceReadingKind(str, Enum):
ZA = 'ZA'
HA = 'HA'
MO = 'MO'
EB = 'EB'
AB = 'AB'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeviceConsumption:
guid: Optional[str] = None
device_reading: Optional[float] = None
device_reading_date: Optional[datetime.datetime] = None
device_reading_kind: Optional[DeviceReadingKind] = None
change_date: Optional[datetime.datetime] = None
note: Optional[str] = None
ampoule_colour: Optional[str] = None
device_guid: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Device:
guid: Optional[str] = None
number: Optional[str] = None
label: Optional[str] = None
description: Optional[str] = None
installation_date: datetime.datetime = datetime.datetime(1, 1, 1)
deinstallation_date: Optional[datetime.datetime] = None
calibration_date: Optional[datetime.datetime] = None
unit: Optional[EinheitType] = None
note: Optional[str] = None
device_catalog: Optional[DeviceCatalog] = None
device_consumptions: Optional[List[DeviceConsumption]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDeviceResponse:
device: Optional[Device] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDevice(IHasBearerToken):
# @ApiMember(IsRequired=true, ParameterType="query")
bearer_token: Optional[str] = None
# @ApiMember(IsRequired=true, ParameterType="path")
guid: Optional[str] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
device:
{
guid: 00000000000000000000000000000000,
number: String,
label: String,
description: String,
installationDate: 0001-01-01T00:00:00Z,
deinstallationDate: 0001-01-01T00:00:00Z,
calibrationDate: 0001-01-01T00:00:00Z,
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:00Z,
deviceReadingKind: ZA,
changeDate: 0001-01-01T00:00:00Z,
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
}
}
}