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

export enum DateTimeFormat
{
    ISO8601 = 'ISO8601',
    UTC = 'UTC',
    NL = 'NL',
    NLOffset = 'NLOffset',
    IN = 'IN',
    INOffset = 'INOffset',
    Unix = 'Unix',
    UnixMillis = 'UnixMillis',
}

export class Generic
{
    /** @description 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")
    public ApiKey: string;

    /** @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  */
    // @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 OnlyPayload: 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  */
    // @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 ShowRequest: boolean;

    /** @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 */
    // @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 DateTimeFormat: DateTimeFormat;

    public constructor(init?: Partial<Generic>) { (Object as any).assign(this, init); }
}

/** @description Get status */
// @Api(Description="Get status")
export class StatusV8 extends Generic
{
    /** @description 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")
    public Ean: string;

    public constructor(init?: Partial<StatusV8>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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