| 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 |
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports SDS.P4v6a.API.ServiceModel.Requests
Imports SDS.P4v6a.API.Common
Namespace Global
Namespace SDS.P4v6a.API.ServiceModel.Requests
Public Partial Class 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")>
Public Overridable Property ApiKey As String
'''<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")>
Public Overridable Property OnlyPayload As Boolean
'''<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")>
Public Overridable Property ShowRequest As Boolean
'''<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")>
Public Overridable Property DateTimeFormat As DateTimeFormat
End Class
'''<Summary>
'''Get list of metering points
'''</Summary>
<Api(Description:="Get list of metering points")>
Public Partial Class Meteringpoints
Inherits Generic
'''<Summary>
'''Skip the first ... metering points
'''</Summary>
<ApiMember(DataType:="Integer", Description:="Skip the first ... metering points", Name:="Offset")>
Public Overridable Property Offset As Integer
'''<Summary>
'''Limit response to ... metering points
'''</Summary>
<ApiMember(DataType:="Integer", Description:="Limit response to ... metering points", Name:="Limit")>
Public Overridable Property Limit As Integer
'''<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")>
Public Overridable Property Ean As String
'''<Summary>
'''Include metering points with ended contracts (Default: false)
'''</Summary>
<ApiMember(DataType:="Boolean", Description:="Include metering points with ended contracts (Default: false)", Name:="ShowEnded")>
Public Overridable Property ShowEnded As Boolean
'''<Summary>
'''Include additional info about the metering point (Default: false)
'''</Summary>
<ApiMember(DataType:="Boolean", Description:="Include additional info about the metering point (Default: false)", Name:="AddExtraInfo")>
Public Overridable Property AddExtraInfo As Boolean
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv