<back to all web services
Meteringpoints
Get list of metering points
The following routes are available for this service:| GET | /api/v5/meteringpoints/ | Show list of all metering points linked to the provided ApiKey | |
|---|
| GET | /api/v5/meteringpoints/{Ean} | Get detailed information about the requested metering point | |
|---|
Meteringpoints Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Offset | query | Integer | No | Skip the first ... metering points |
| Limit | query | Integer | No | Limit response to ... metering points |
| Ean | path | EAN (18 numbers) | No | Request of details of specific metering point with Ean |
| ShowEnded | query | Boolean | No | Include metering points with ended contracts (Default: false) |
| AddExtraInfo | query | Boolean | No | Include additional info about the metering point (Default: false) |
Generic Parameters:| 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 |
DateTimeFormat Enum:| ISO8601 | |
| UTC | |
| NL | |
| NLOffset | |
| IN | |
| INOffset | |
| Unix | |
| UnixMillis | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
GET /api/v5/meteringpoints/ HTTP/1.1
Host: p4v8.smartdatasolutions.nl
Accept: application/xml