| 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 |
import java.math.*
import java.util.*
import net.servicestack.client.*
/**
* Get list of metering points
*/
@Api(Description="Get list of metering points")
open class Meteringpoints : Generic()
{
/**
* Skip the first ... metering points
*/
@ApiMember(DataType="Integer", Description="Skip the first ... metering points", Name="Offset")
var Offset:Int? = null
/**
* Limit response to ... metering points
*/
@ApiMember(DataType="Integer", Description="Limit response to ... metering points", Name="Limit")
var Limit:Int? = null
/**
* 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
/**
* Include metering points with ended contracts (Default: false)
*/
@ApiMember(DataType="Boolean", Description="Include metering points with ended contracts (Default: false)", Name="ShowEnded")
var ShowEnded:Boolean? = null
/**
* Include additional info about the metering point (Default: false)
*/
@ApiMember(DataType="Boolean", Description="Include additional info about the metering point (Default: false)", Name="AddExtraInfo")
var AddExtraInfo: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,
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv