| POST | /api/v1/external/fairtherm |
|---|
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
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetLobaroFairthermDeviceParsedDataResponse:
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Pagination:
limit: int = 0
total: int = 0
offset: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class History:
time: Optional[str] = None
value: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompactProfile:
history: Optional[List[History]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MbusBodyDataRecords:
vif_unit: Optional[str] = None
vif_quantity: Optional[str] = None
value_scaled: float = 0.0
vif_exponent: Optional[str] = None
value_string: Optional[str] = None
value: Optional[str] = None
dif_function_string: Optional[str] = None
storage_no: Optional[str] = None
compact_profile: Optional[CompactProfile] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MbusBody:
data_records: Optional[List[MbusBodyDataRecords]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Header:
id_string: int = 0
device_string: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeviceMbusData:
id_string: int = 0
device_string: Optional[str] = None
body: Optional[MbusBody] = None
header: Optional[Header] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeviceData:
mbus: Optional[DeviceMbusData] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LobaroData:
id: int = 0
device_id: int = 0
created_at: datetime.datetime = datetime.datetime(1, 1, 1)
updated_at: datetime.datetime = datetime.datetime(1, 1, 1)
data: Optional[DeviceData] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetLobaroFairthermDeviceParsedData:
# @ApiMember(IsRequired=true, ParameterType="body")
pagination: Optional[Pagination] = None
# @ApiMember(IsRequired=true, ParameterType="body")
data: Optional[List[LobaroData]] = None
Python GetLobaroFairthermDeviceParsedData DTOs
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.
POST /api/v1/external/fairtherm HTTP/1.1
Host: elotesch-servdesk.eras-online.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
pagination:
{
limit: 0,
total: 0,
offset: 0
},
data:
[
{
id: 0,
deviceId: 0,
createdAt: 0001-01-01T00:00:00Z,
updatedAt: 0001-01-01T00:00:00Z,
data:
{
mbus:
{
idString: 0,
deviceString: String,
body:
{
dataRecords:
[
{
vifUnit: String,
vifQuantity: String,
valueScaled: 0,
vifExponent: String,
valueString: String,
value: String,
difFunctionString: String,
storageNo: String,
compactProfile:
{
history:
[
{
time: String,
value: String
}
]
}
}
]
},
header:
{
idString: 0,
deviceString: String
}
}
}
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}