SDS P4 API

<back to all web services

StatusV8

Get status

The following routes are available for this service:
GET/api/v5/meteringpoints/{Ean}/statusGet the status of a single asset
GET/api/v8/meteringpoints/{Ean}/statusGet the status of a single asset
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Get status
*/
@Api(Description="Get status")
open class StatusV8 : Generic()
{
    /**
    * Request of details of specific metering point with specified ean
    */
    @ApiMember(DataType="EAN (18 numbers)", Description="Request of details of specific metering point with specified ean", Name="Ean")
    var Ean:String? = 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,
}

Kotlin StatusV8 DTOs

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

HTTP + XML

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

GET /api/v5/meteringpoints/{Ean}/status HTTP/1.1 
Host: p4v8.smartdatasolutions.nl 
Accept: application/xml