| GET | /api/v5/meteringpoints/{Ean}/usagereading/{Aggregation}/{DateFrom} | Get usage/reading of a single asset with the selected aggregation starting from DateFrom | |
|---|---|---|---|
| GET | /api/v5/meteringpoints/{Ean}/usagereading/{Aggregation}/{DateFrom}/{DateTo} | Get usage/reading of a single asset with the selected aggregation and period |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Ean | path | EAN (18 numbers) | No | Request of details of specific meteringpoint with Ean |
| Aggregation | path | Enum | Yes | Aggregation level. The None-'level' will give the most detailed level available for the requested asset. If a level is requested that is not available or can be calculate, no data is returned. Enum options: None, Hour |
| DateFrom | path | Date: yyyy-mm-dd | Yes | Start date the usages are requested for |
| DateTo | path | Date: yyyy-mm-dd | No | End date the usages are requested for (this is included in the response). If no date is provided the DateTo will seven days from the DateFrom. |
| PayloadFormat | query | Enum | No | The output can be generated in a few formats. UsageReturnCombined: return values will be subtracted from the usage, UsageReturn: separate columns form usage and return (if available) and UsageReturnAndTariff: for both usage and return a column for tariff1 and tariff2. Default value: UsageReturnCombined |
| Source | query | Enum | No | See filter. Usages are available from the Detail channel. Default value: Detail |
| AddDateNL | query | Boolean | No | Add column with Dutch day (Default: false) |
| AddTimestamps | query | Boolean | No | Add columns with CreatedOn and LastUpdated (Default: false) |
| AddEan | query | Boolean | No | Add column with ean (Default: false) |
| RegistersInRows | query | Boolean | No | Create a row for each register instead of a column/field for each register (Default: false) |
| CalculateDetailTariff | query | Boolean | No | Gridoperator doesn't provided tariff information for the detail channel, but this can be calculated (Default: false) |
| AlsoReading | query | Boolean | No | If want to get the reading as well with the usages |
| CacheKey | query | string | No | CacheKey used for Internal logic |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | String | Yes | Api-key. Used to provide credentials to the api. Can also be provided through the request headers with key: X-API-KEY |
| OnlyPayload | form | Boolean | No | 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 |
| ShowRequest | form | Boolean | No | 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 |
| DateTimeFormat | form | Enum | No | 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 |
| ISO8601 | |
| UTC | |
| NL | |
| NLOffset | |
| IN | |
| INOffset | |
| Unix | |
| UnixMillis |
| None | |
| Hour | |
| Day | |
| Week | |
| Month | |
| Year |
| UsageReturnCombined | |
| UsageReturn | |
| UsageReturnAndTariff |
| Detail | |
| Day | |
| Month | |
| Unknown |
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}/usagereading/{Aggregation}/{DateFrom} HTTP/1.1
Host: p4v8.smartdatasolutions.nl
Accept: text/jsv