| 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 |
namespace SDS.P4v6a.API.Common
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type DateTimeFormat =
| ISO8601 = 0
| UTC = 1
| NL = 2
| NLOffset = 3
| IN = 4
| INOffset = 5
| Unix = 6
| UnixMillis = 7
[<AllowNullLiteral>]
type Generic() =
///<summary>
///Api-key. Used to provide credentials to the api. Can also be provided through the request headers with key: X-API-KEY
///</summary>
[<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")>]
member val ApiKey:String = null with get,set
///<summary>
///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
///</summary>
[<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")>]
member val OnlyPayload:Boolean = new Boolean() with get,set
///<summary>
///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
///</summary>
[<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")>]
member val ShowRequest:Boolean = new Boolean() with get,set
///<summary>
///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
///</summary>
[<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")>]
member val DateTimeFormat:DateTimeFormat = new DateTimeFormat() with get,set
type Filter =
| None = 0
| Hour = 1
| Day = 2
| Month = 3
| Year = 4
type MeasurementSource =
| Detail = 0
| Day = 1
| Month = 2
| Unknown = 3
///<summary>
///Get readings of a metering point
///</summary>
[<Api(Description="Get readings of a metering point")>]
[<AllowNullLiteral>]
type Reading() =
inherit Generic()
///<summary>
///Request of details of specific metering point with Ean
///</summary>
[<ApiMember(DataType="EAN (18 numbers)", Description="Request of details of specific metering point with Ean", Name="Ean")>]
member val Ean:String = null with get,set
///<summary>
///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
///</summary>
[<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")>]
member val Filter:Filter = new Filter() with get,set
///<summary>
///Start date the readings are requested for
///</summary>
[<ApiMember(DataType="Date: yyyy-mm-dd", Description="Start date the readings are requested for", IsRequired=true, Name="DateFrom")>]
member val DateFrom:DateTime = new DateTime() with get,set
///<summary>
///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.
///</summary>
[<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")>]
member val DateTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///See filter. Readings are available from the Detail or Day channel. Default value: Detail
///</summary>
[<ApiMember(DataType="Enum: detail/day", Description="See filter. Readings are available from the Detail or Day channel. Default value: Detail", Name="Source")>]
member val Source:MeasurementSource = new MeasurementSource() with get,set
///<summary>
///Add column with Dutch day (Default: false)
///</summary>
[<ApiMember(DataType="Boolean", Description="Add column with Dutch day (Default: false)", Name="AddDateNL")>]
member val AddDateNL:Boolean = new Boolean() with get,set
///<summary>
///Add the first reading of the next day if available. Only available/relevant if no aggregation / source is detail (Default: true)
///</summary>
[<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")>]
member val AddFirstReadingNextDay:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///Add columns with CreatedOn and LastUpdated (Default: false)
///</summary>
[<ApiMember(DataType="Boolean", Description="Add columns with CreatedOn and LastUpdated (Default: false)", Name="AddTimestamps")>]
member val AddTimestamps:Boolean = new Boolean() with get,set
///<summary>
///Add column with ean (Default: false)
///</summary>
[<ApiMember(DataType="Boolean", Description="Add column with ean (Default: false)", Name="AddEan")>]
member val AddEan:Boolean = new Boolean() with get,set
///<summary>
///Add column with the meter serial number (Default: false)
///</summary>
[<ApiMember(DataType="Boolean", Description="Add column with the meter serial number (Default: false)", Name="AddMeterId")>]
member val AddMeterId:Boolean = new Boolean() with get,set
///<summary>
///Create a row for each register instead of a column/field for each register (Default: false)
///</summary>
[<ApiMember(DataType="Boolean", Description="Create a row for each register instead of a column/field for each register (Default: false)", Name="RegistersInRows")>]
member val RegistersInRows:Boolean = new Boolean() with get,set
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/v5/meteringpoints/{Ean}/readings/{Filter}/{DateFrom} HTTP/1.1
Host: p4v8.smartdatasolutions.nl
Accept: text/jsv