| GET | /api/v5/meteringpoints/{Ean}/readings/{Filter}/{DateFrom} | Shows all readings available after DateFrom | |
|---|---|---|---|
| GET | /api/v5/meteringpoints/{Ean}/readings/{Filter}/{DateFrom}/{DateTo} | Shows readings for period |
import 'package:servicestack/servicestack.dart';
enum DateTimeFormat
{
ISO8601,
UTC,
NL,
NLOffset,
IN,
INOffset,
Unix,
UnixMillis,
}
class Generic implements IConvertible
{
/**
* Api-key. Used to provide credentials to the api. Can also be provided through the request headers with key: X-API-KEY
*/
// @ApiMember(DataType="String", Description="Api-key. Used to provide credentials to the api. Can also be provided through the request headers with key: X-API-KEY", IsRequired=true, Name="ApiKey")
String? ApiKey;
/**
* Normally the result of the request is put inside a resultobject with some status information about the request. If you want the output as csv this outer object can be irritating. Default value: FALSE
*/
// @ApiMember(DataType="Boolean", Description="Normally the result of the request is put inside a resultobject with some status information about the request. If you want the output as csv this outer object can be irritating. Default value: FALSE ", Name="OnlyPayload")
bool? OnlyPayload;
/**
* Show the request as interpreted by the api. Useful to see how filters / dates are parsed. If no value us provided, the default value is: FALSE
*/
// @ApiMember(DataType="Boolean", Description="Show the request as interpreted by the api. Useful to see how filters / dates are parsed. If no value us provided, the default value is: FALSE ", Name="ShowRequest")
bool? ShowRequest;
/**
* Format all DateTime in the response object. If used in browser, sometimes ISO8601 is not correctly transformed. Enum options: ISO8601 (DEFAULT), UTC, NL, NLOffset, Unix, UnixMillis
*/
// @ApiMember(DataType="Enum", Description="Format all DateTime in the response object. If used in browser, sometimes ISO8601 is not correctly transformed. Enum options: ISO8601 (DEFAULT), UTC, NL, NLOffset, Unix, UnixMillis", Name="DateTimeFormat")
DateTimeFormat? DateTimeFormat;
Generic({this.ApiKey,this.OnlyPayload,this.ShowRequest,this.DateTimeFormat});
Generic.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ApiKey = json['ApiKey'];
OnlyPayload = json['OnlyPayload'];
ShowRequest = json['ShowRequest'];
DateTimeFormat = JsonConverters.fromJson(json['DateTimeFormat'],'DateTimeFormat',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ApiKey': ApiKey,
'OnlyPayload': OnlyPayload,
'ShowRequest': ShowRequest,
'DateTimeFormat': JsonConverters.toJson(DateTimeFormat,'DateTimeFormat',context!)
};
getTypeName() => "Generic";
TypeContext? context = _ctx;
}
enum Filter
{
None,
Hour,
Day,
Month,
Year,
}
enum MeasurementSource
{
Detail,
Day,
Month,
Unknown,
}
/**
* Get readings of a metering point
*/
// @Api(Description="Get readings of a metering point")
class Reading extends Generic implements IConvertible
{
/**
* Request of details of specific metering point with Ean
*/
// @ApiMember(DataType="EAN (18 numbers)", Description="Request of details of specific metering point with Ean", Name="Ean")
String? Ean;
/**
* Detail gives hourly readings for gas and 15 minutes readings for electricity. Only register 1.8.0 (G&E) and 2.8.0 (E) are available. The Day and Month filter are by default also based on the detail readings. Optional it is possible to get the values from the day channels. Advantage: readings are the readings visible as on the smart meter and for electricity the High/Low distinction is available. Downside: for some of the older smart meter models, no decimals are available. Registers starting with 1 are usage, starting with 2 are return. Registers ending on 1 are normal/high tariff, ending on 2 are low/night/weekend tariff. For gas only register 1.8.0 is available. For electricity 1.8.1/1.8.2/2.8.1/2.8.2 are available
*/
// @ApiMember(DataType="Enum: none/hour/day/month/year", Description="Detail gives hourly readings for gas and 15 minutes readings for electricity. Only register 1.8.0 (G&E) and 2.8.0 (E) are available. The Day and Month filter are by default also based on the detail readings. Optional it is possible to get the values from the day channels. Advantage: readings are the readings visible as on the smart meter and for electricity the High/Low distinction is available. Downside: for some of the older smart meter models, no decimals are available. Registers starting with 1 are usage, starting with 2 are return. Registers ending on 1 are normal/high tariff, ending on 2 are low/night/weekend tariff. For gas only register 1.8.0 is available. For electricity 1.8.1/1.8.2/2.8.1/2.8.2 are available", IsRequired=true, Name="Filter")
Filter? Filter;
/**
* Start date the readings are requested for
*/
// @ApiMember(DataType="Date: yyyy-mm-dd", Description="Start date the readings are requested for", IsRequired=true, Name="DateFrom")
DateTime? DateFrom;
/**
* End date the readings are requested for (this date is included in the response). If no date is provided the DateTo will be seven days from DateFrom.
*/
// @ApiMember(DataType="Date: yyyy-mm-dd", Description="End date the readings are requested for (this date is included in the response). If no date is provided the DateTo will be seven days from DateFrom.", Name="DateTo")
DateTime? DateTo;
/**
* See filter. Readings are available from the Detail or Day channel. Default value: Detail
*/
// @ApiMember(DataType="Enum: detail/day", Description="See filter. Readings are available from the Detail or Day channel. Default value: Detail", Name="Source")
MeasurementSource? Source;
/**
* Add column with Dutch day (Default: false)
*/
// @ApiMember(DataType="Boolean", Description="Add column with Dutch day (Default: false)", Name="AddDateNL")
bool? AddDateNL;
/**
* Add the first reading of the next day if available. Only available/relevant if no aggregation / source is detail (Default: true)
*/
// @ApiMember(DataType="Boolean", Description="Add the first reading of the next day if available. Only available/relevant if no aggregation / source is detail (Default: true)", Name="AddFirstReadingNextDay")
bool? AddFirstReadingNextDay;
/**
* Add columns with CreatedOn and LastUpdated (Default: false)
*/
// @ApiMember(DataType="Boolean", Description="Add columns with CreatedOn and LastUpdated (Default: false)", Name="AddTimestamps")
bool? AddTimestamps;
/**
* Add column with ean (Default: false)
*/
// @ApiMember(DataType="Boolean", Description="Add column with ean (Default: false)", Name="AddEan")
bool? AddEan;
/**
* Add column with the meter serial number (Default: false)
*/
// @ApiMember(DataType="Boolean", Description="Add column with the meter serial number (Default: false)", Name="AddMeterId")
bool? AddMeterId;
/**
* Create a row for each register instead of a column/field for each register (Default: false)
*/
// @ApiMember(DataType="Boolean", Description="Create a row for each register instead of a column/field for each register (Default: false)", Name="RegistersInRows")
bool? RegistersInRows;
Reading({this.Ean,this.Filter,this.DateFrom,this.DateTo,this.Source,this.AddDateNL,this.AddFirstReadingNextDay,this.AddTimestamps,this.AddEan,this.AddMeterId,this.RegistersInRows});
Reading.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Ean = json['Ean'];
Filter = JsonConverters.fromJson(json['Filter'],'Filter',context!);
DateFrom = JsonConverters.fromJson(json['DateFrom'],'DateTime',context!);
DateTo = JsonConverters.fromJson(json['DateTo'],'DateTime',context!);
Source = JsonConverters.fromJson(json['Source'],'MeasurementSource',context!);
AddDateNL = json['AddDateNL'];
AddFirstReadingNextDay = json['AddFirstReadingNextDay'];
AddTimestamps = json['AddTimestamps'];
AddEan = json['AddEan'];
AddMeterId = json['AddMeterId'];
RegistersInRows = json['RegistersInRows'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Ean': Ean,
'Filter': JsonConverters.toJson(Filter,'Filter',context!),
'DateFrom': JsonConverters.toJson(DateFrom,'DateTime',context!),
'DateTo': JsonConverters.toJson(DateTo,'DateTime',context!),
'Source': JsonConverters.toJson(Source,'MeasurementSource',context!),
'AddDateNL': AddDateNL,
'AddFirstReadingNextDay': AddFirstReadingNextDay,
'AddTimestamps': AddTimestamps,
'AddEan': AddEan,
'AddMeterId': AddMeterId,
'RegistersInRows': RegistersInRows
});
getTypeName() => "Reading";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'p4v8.smartdatasolutions.nl', types: <String, TypeInfo> {
'DateTimeFormat': TypeInfo(TypeOf.Enum, enumValues:DateTimeFormat.values),
'Generic': TypeInfo(TypeOf.Class, create:() => Generic()),
'Filter': TypeInfo(TypeOf.Enum, enumValues:Filter.values),
'MeasurementSource': TypeInfo(TypeOf.Enum, enumValues:MeasurementSource.values),
'Reading': TypeInfo(TypeOf.Class, create:() => Reading()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/v5/meteringpoints/{Ean}/readings/{Filter}/{DateFrom} HTTP/1.1
Host: p4v8.smartdatasolutions.nl
Accept: application/json