SDS P4 API

Reading

Get readings of a metering point

The following routes are available for this service:
GET	/api/v5/meteringpoints/{Ean}/readings/{Filter}/{DateFrom}	Shows all readings available after DateFrom
GET	/api/v5/meteringpoints/{Ean}/readings/{Filter}/{DateFrom}/{DateTo}	Shows readings for period

import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Get readings of a metering point
*/
@Api(Description="Get readings of a metering point")
open class Reading : Generic()
{
    /**
    * Request of details of specific metering point with Ean
    */
    @ApiMember(DataType="EAN (18 numbers)", Description="Request of details of specific metering point with Ean", Name="Ean")
    var Ean:String? = null

    /**
    * Detail gives hourly readings for gas and 15 minutes readings for electricity. Only register 1.8.0 (G&E) and 2.8.0 (E) are available. The Day and Month filter are by default also based on the detail readings. Optional it is possible to get the values from the day channels. Advantage: readings are the readings visible as on the smart meter and for electricity the High/Low distinction is available. Downside: for some of the older smart meter models, no decimals are available. Registers starting with 1 are usage, starting with 2 are return. Registers ending on 1 are normal/high tariff, ending on 2 are low/night/weekend tariff. For gas only register 1.8.0 is available. For electricity 1.8.1/1.8.2/2.8.1/2.8.2 are available
    */
    @ApiMember(DataType="Enum: none/hour/day/month/year", Description="Detail gives hourly readings for gas and 15 minutes readings for electricity. Only register 1.8.0 (G&E) and 2.8.0 (E) are available. The Day and Month filter are by default also based on the detail readings. Optional it is possible to get the values from the day channels. Advantage: readings are the readings visible as on the smart meter and for electricity the High/Low distinction is available. Downside: for some of the older smart meter models, no decimals are available. Registers starting with 1 are usage, starting with 2 are return. Registers ending on 1 are normal/high tariff, ending on 2 are low/night/weekend tariff. For gas only register 1.8.0 is available. For electricity 1.8.1/1.8.2/2.8.1/2.8.2 are available", IsRequired=true, Name="Filter")
    var Filter:Filter? = null

    /**
    * Start date the readings are requested for
    */
    @ApiMember(DataType="Date: yyyy-mm-dd", Description="Start date the readings are requested for", IsRequired=true, Name="DateFrom")
    var DateFrom:Date? = null

    /**
    * End date the readings are requested for (this date is included in the response). If no date is provided the DateTo will be seven days from DateFrom.
    */
    @ApiMember(DataType="Date: yyyy-mm-dd", Description="End date the readings are requested for (this date is included in the response). If no date is provided the DateTo will be seven days from DateFrom.", Name="DateTo")
    var DateTo:Date? = null

    /**
    * See filter. Readings are available from the Detail or Day channel. Default value: Detail
    */
    @ApiMember(DataType="Enum: detail/day", Description="See filter. Readings are available from the Detail or Day channel. Default value: Detail", Name="Source")
    var Source:MeasurementSource? = null

    /**
    * Add column with Dutch day (Default: false)
    */
    @ApiMember(DataType="Boolean", Description="Add column with Dutch day (Default: false)", Name="AddDateNL")
    var AddDateNL:Boolean? = null

    /**
    * Add the first reading of the next day if available. Only available/relevant if no aggregation / source is detail (Default: true)
    */
    @ApiMember(DataType="Boolean", Description="Add the first reading of the next day if available. Only available/relevant if no aggregation / source is detail (Default: true)", Name="AddFirstReadingNextDay")
    var AddFirstReadingNextDay:Boolean? = null

    /**
    * Add columns with CreatedOn and LastUpdated (Default: false)
    */
    @ApiMember(DataType="Boolean", Description="Add columns with CreatedOn and LastUpdated (Default: false)", Name="AddTimestamps")
    var AddTimestamps:Boolean? = null

    /**
    * Add column with ean (Default: false)
    */
    @ApiMember(DataType="Boolean", Description="Add column with ean (Default: false)", Name="AddEan")
    var AddEan:Boolean? = null

    /**
    * Add column with the meter serial number (Default: false)
    */
    @ApiMember(DataType="Boolean", Description="Add column with the meter serial number (Default: false)", Name="AddMeterId")
    var AddMeterId:Boolean? = null

    /**
    * Create a row for each register instead of a column/field for each register (Default: false)
    */
    @ApiMember(DataType="Boolean", Description="Create a row for each register instead of a column/field for each register (Default: false)", Name="RegistersInRows")
    var RegistersInRows:Boolean? = null
}

open class Generic
{
    /**
    * Api-key. Used to provide credentials to the api. Can also be provided through the request headers with key: X-API-KEY
    */
    @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")
    var ApiKey:String? = null

    /**
    * 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 
    */
    @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")
    var OnlyPayload:Boolean? = null

    /**
    * 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 
    */
    @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")
    var ShowRequest:Boolean? = null

    /**
    * 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
    */
    @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")
    var DateTimeFormat:DateTimeFormat? = null
}

enum class DateTimeFormat
{
    IsO8601,
    Utc,
    Nl,
    NlOffset,
    In,
    InOffset,
    Unix,
    UnixMillis,
}

enum class Filter
{
    None,
    Hour,
    Day,
    Month,
    Year,
}

enum class MeasurementSource
{
    Detail,
    Day,
    Month,
    Unknown,
}

Kotlin Reading DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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

GET /api/v5/meteringpoints/{Ean}/readings/{Filter}/{DateFrom} HTTP/1.1 
Host: p4v8.smartdatasolutions.nl 
Accept: text/jsv