| GET | /usages/{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 |
| 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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/oneway/Usage HTTP/1.1
Host: data.smartdatasolutions.nl
Content-Type: application/xml
Content-Length: length
<Usage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SDS.Backend.APIs.DataApi.DTO.Request">
<ApiKey>String</ApiKey>
<DateTimeFormat>ISO8601</DateTimeFormat>
<OnlyPayload>false</OnlyPayload>
<ShowRequest>false</ShowRequest>
<Aggregation>None</Aggregation>
<DateFrom>0001-01-01T00:00:00</DateFrom>
<DateTo>0001-01-01T00:00:00</DateTo>
<Id>String</Id>
<PayloadFormat>UsageReturnCombined</PayloadFormat>
<TypeOfId>Identifier</TypeOfId>
</Usage>