| GET | /usagereading/{TypeOfId}/{Id}/{Aggregation}/{DateFrom} | Get usages of a single asset with the selected aggregation and period |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TypeOfId | path | Enum | Yes | Type of Id. This can be provided in the form of an Identifer (String) |
| Id | path | String | Yes | The id of the asset the usages are requested for |
| 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, Min05, Min15, Hour, Week, Day, Month |
| DateFrom | path | Date: yyyy-mm-dd | Yes | Start date the usages are requested for |
| DateTo | query | 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 be the DateFrom effectively giving back 1 day of data. To request all available usages from a certain startdate, use a date in the future |
| PayloadFormat | query | Enum | No | The output can be generated in a few formats. UsageReturnCombined: return values will be subtracted from the usage, UsageReturn: seperate columns form usage and return (if available) and UsageReturnAndTariff: for both usage and return a column for tariff1 and tariff2. Default value: UsageReturnCombined |
| AlsoReading | query | Boolean | No | If want to get the reading as well with the usages |
| Filter | query | Enum | No | None gives the within day/detail readings. Hourly for gas and per 15 minutes for electricity. Only register 1.8.0 (G&E) and 2.8.0 (E). For the Day and Month filter are by default also based on the detail readings. Optional is to get the readings based on the day channel. For some meters there are no decimals available in the day readings. But these readings are like the readings visible on the fysical meters and have registers: 1.8.0 (G) and 1.8.1/1.8.2/2.8.1/2.8.2 (E). The registers ending on 1 are normal/high tariff, registers ending on 2 are low tariff |
| Source | query | Enum | No | See filter. Readings are available from the Detail or Day channel. Default value: Detail |
| CacheKey | query | string | No |
| 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 |
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.
POST /json/oneway/UsageReading HTTP/1.1
Host: data.smartdatasolutions.nl
Content-Type: application/json
Content-Length: length
{"TypeOfId":"Identifier","Id":"String","Aggregation":"None","DateFrom":"\/Date(-62135596800000-0000)\/","DateTo":"\/Date(-62135596800000-0000)\/","PayloadFormat":"UsageReturnCombined","AlsoReading":false,"Filter":"None","Source":"Detail","CacheKey":"urn:GenericResponse:Identifier|String|None|000101010000|000101010000|False|False|ISO8601","ApiKey":"String","OnlyPayload":false,"ShowRequest":false,"DateTimeFormat":"ISO8601"}