Server

<back to all web services

GetLobaroFairthermDeviceParsedData

External
Requires Authentication
The following routes are available for this service:
POST/api/v1/external/fairtherm

export class GetLobaroFairthermDeviceParsedDataResponse
{
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetLobaroFairthermDeviceParsedDataResponse>) { (Object as any).assign(this, init); }
}

export class Pagination
{
    public limit: number;
    public total: number;
    public offset: number;

    public constructor(init?: Partial<Pagination>) { (Object as any).assign(this, init); }
}

export class History
{
    public time: string;
    public value: string;

    public constructor(init?: Partial<History>) { (Object as any).assign(this, init); }
}

export class CompactProfile
{
    public history: History[];

    public constructor(init?: Partial<CompactProfile>) { (Object as any).assign(this, init); }
}

export class MbusBodyDataRecords
{
    public vifUnit: string;
    public vifQuantity: string;
    public valueScaled: number;
    public vifExponent: string;
    public valueString: string;
    public value: string;
    public difFunctionString: string;
    public storageNo: string;
    public compactProfile: CompactProfile;

    public constructor(init?: Partial<MbusBodyDataRecords>) { (Object as any).assign(this, init); }
}

export class MbusBody
{
    public dataRecords: MbusBodyDataRecords[];

    public constructor(init?: Partial<MbusBody>) { (Object as any).assign(this, init); }
}

export class Header
{
    public idString: number;
    public deviceString: string;

    public constructor(init?: Partial<Header>) { (Object as any).assign(this, init); }
}

export class DeviceMbusData
{
    public idString: number;
    public deviceString: string;
    public body: MbusBody;
    public header: Header;

    public constructor(init?: Partial<DeviceMbusData>) { (Object as any).assign(this, init); }
}

export class DeviceData
{
    public mbus: DeviceMbusData;

    public constructor(init?: Partial<DeviceData>) { (Object as any).assign(this, init); }
}

export class LobaroData
{
    public id: number;
    public deviceId: number;
    public createdAt: string;
    public updatedAt: string;
    public data: DeviceData;

    public constructor(init?: Partial<LobaroData>) { (Object as any).assign(this, init); }
}

export class GetLobaroFairthermDeviceParsedData
{
    // @ApiMember(IsRequired=true, ParameterType="body")
    public pagination: Pagination;

    // @ApiMember(IsRequired=true, ParameterType="body")
    public data: LobaroData[];

    public constructor(init?: Partial<GetLobaroFairthermDeviceParsedData>) { (Object as any).assign(this, init); }
}

TypeScript GetLobaroFairthermDeviceParsedData DTOs

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

HTTP + 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
		}
	}
}