| POST | /api/v1/external/fairtherm |
|---|
"use strict";
export class GetLobaroFairthermDeviceParsedDataResponse {
/** @param {{responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
}
export class Pagination {
/** @param {{limit?:number,total?:number,offset?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
limit;
/** @type {number} */
total;
/** @type {number} */
offset;
}
export class History {
/** @param {{time?:string,value?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
time;
/** @type {string} */
value;
}
export class CompactProfile {
/** @param {{history?:History[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {History[]} */
history;
}
export class MbusBodyDataRecords {
/** @param {{vifUnit?:string,vifQuantity?:string,valueScaled?:number,vifExponent?:string,valueString?:string,value?:string,difFunctionString?:string,storageNo?:string,compactProfile?:CompactProfile}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
vifUnit;
/** @type {string} */
vifQuantity;
/** @type {number} */
valueScaled;
/** @type {string} */
vifExponent;
/** @type {string} */
valueString;
/** @type {string} */
value;
/** @type {string} */
difFunctionString;
/** @type {string} */
storageNo;
/** @type {CompactProfile} */
compactProfile;
}
export class MbusBody {
/** @param {{dataRecords?:MbusBodyDataRecords[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {MbusBodyDataRecords[]} */
dataRecords;
}
export class Header {
/** @param {{idString?:number,deviceString?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
idString;
/** @type {string} */
deviceString;
}
export class DeviceMbusData {
/** @param {{idString?:number,deviceString?:string,body?:MbusBody,header?:Header}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
idString;
/** @type {string} */
deviceString;
/** @type {MbusBody} */
body;
/** @type {Header} */
header;
}
export class DeviceData {
/** @param {{mbus?:DeviceMbusData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {DeviceMbusData} */
mbus;
}
export class LobaroData {
/** @param {{id?:number,deviceId?:number,createdAt?:string,updatedAt?:string,data?:DeviceData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {number} */
deviceId;
/** @type {string} */
createdAt;
/** @type {string} */
updatedAt;
/** @type {DeviceData} */
data;
}
export class GetLobaroFairthermDeviceParsedData {
/** @param {{pagination?:Pagination,data?:LobaroData[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Pagination} */
pagination;
/** @type {LobaroData[]} */
data;
}
JavaScript 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: imm-con-gmbh-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
}
}
}