SDS P4 API

<back to all web services

Graph

Get data for graph, usages and some statistical information

The following routes are available for this service:
GET/api/v6/meteringpoints/{Ean}/graph/{Aggregation}/{DateFrom}/{DateTo}Get usages based on aggregation starting from DateFrom to endDate
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 data for graph, usages and some statistical information
        '''</Summary>
        <Api(Description:="Get data for graph, usages and some statistical information")>
        Public Partial Class Graph
            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", IsRequired:=true, 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, Day, Week, Month
            '''</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, Day, Week, Month", 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. ", IsRequired:=true, Name:="DateTo")>
            Public Overridable Property DateTo As Date

            '''<Summary>
            '''calculate the usage of that period and divide it over the missing hours or 15 minute periods, but this can be calculated (Default: false)
            '''</Summary>
            <ApiMember(DataType:="Boolean", Description:="calculate the usage of that period and divide it over the missing hours or 15 minute periods, but this can be calculated (Default: false)", Name:="CalculateMissingUsages")>
            Public Overridable Property CalculateMissingUsages As Boolean
        End Class
    End Namespace
End Namespace

VB.NET Graph DTOs

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/v6/meteringpoints/{Ean}/graph/{Aggregation}/{DateFrom}/{DateTo} HTTP/1.1 
Host: p4v8.smartdatasolutions.nl 
Accept: application/json