| 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 |
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 usagereading
'''</Summary>
<Api(Description:="Get usagereading")>
Public Partial Class UsageReading
Inherits Generic
'''<Summary>
'''Request of details of specific meteringpoint with Ean
'''</Summary>
<ApiMember(DataType:="EAN (18 numbers)", Description:="Request of details of specific meteringpoint with Ean", Name:="Ean")>
Public Overridable Property Ean As String
'''<Summary>
'''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
'''</Summary>
<ApiMember(DataType:="Enum", Description:="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", IsRequired:=true, Name:="Aggregation")>
Public Overridable Property Aggregation As AggregationForAPI
'''<Summary>
'''Start date the usages are requested for
'''</Summary>
<ApiMember(DataType:="Date: yyyy-mm-dd", Description:="Start date the usages are requested for", IsRequired:=true, Name:="DateFrom")>
Public Overridable Property DateFrom As Date
'''<Summary>
'''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.
'''</Summary>
<ApiMember(DataType:="Date: yyyy-mm-dd", Description:="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. ", Name:="DateTo")>
Public Overridable Property DateTo As Nullable(Of Date)
'''<Summary>
'''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
'''</Summary>
<ApiMember(DataType:="Enum", Description:="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", Name:="PayloadFormat")>
Public Overridable Property PayloadFormat As PayloadFormat
'''<Summary>
'''See filter. Usages are available from the Detail channel. Default value: Detail
'''</Summary>
<ApiMember(DataType:="Enum", Description:="See filter. Usages are available from the Detail channel. Default value: Detail", Name:="Source")>
Public Overridable Property Source As MeasurementSource
'''<Summary>
'''Add column with Dutch day (Default: false)
'''</Summary>
<ApiMember(DataType:="Boolean", Description:="Add column with Dutch day (Default: false)", Name:="AddDateNL")>
Public Overridable Property AddDateNL As Boolean
'''<Summary>
'''Add columns with CreatedOn and LastUpdated (Default: false)
'''</Summary>
<ApiMember(DataType:="Boolean", Description:="Add columns with CreatedOn and LastUpdated (Default: false)", Name:="AddTimestamps")>
Public Overridable Property AddTimestamps As Boolean
'''<Summary>
'''Add column with ean (Default: false)
'''</Summary>
<ApiMember(DataType:="Boolean", Description:="Add column with ean (Default: false)", Name:="AddEan")>
Public Overridable Property AddEan As Boolean
'''<Summary>
'''Create a row for each register instead of a column/field for each register (Default: false)
'''</Summary>
<ApiMember(DataType:="Boolean", Description:="Create a row for each register instead of a column/field for each register (Default: false)", Name:="RegistersInRows")>
Public Overridable Property RegistersInRows As Boolean
'''<Summary>
'''Gridoperator doesn't provided tariff information for the detail channel, but this can be calculated (Default: false)
'''</Summary>
<ApiMember(DataType:="Boolean", Description:="Gridoperator doesn't provided tariff information for the detail channel, but this can be calculated (Default: false)", Name:="CalculateDetailTariff")>
Public Overridable Property CalculateDetailTariff As Boolean
'''<Summary>
'''If want to get the reading as well with the usages
'''</Summary>
<ApiMember(DataType:="Boolean", Description:="If want to get the reading as well with the usages", Name:="AlsoReading")>
Public Overridable Property AlsoReading As Boolean
'''<Summary>
'''CacheKey used for Internal logic
'''</Summary>
<ApiMember(Description:="CacheKey used for Internal logic", Name:="CacheKey")>
Public Overridable Property CacheKey As String
End Class
End Namespace
End Namespace
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.
GET /api/v5/meteringpoints/{Ean}/usagereading/{Aggregation}/{DateFrom} HTTP/1.1
Host: p4v8.smartdatasolutions.nl
Accept: application/json