| 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 |
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 list of metering points */
// @Api(Description="Get list of metering points")
export class Meteringpoints extends Generic
{
/** @description Skip the first ... metering points */
// @ApiMember(DataType="Integer", Description="Skip the first ... metering points", Name="Offset")
public Offset: number;
/** @description Limit response to ... metering points */
// @ApiMember(DataType="Integer", Description="Limit response to ... metering points", Name="Limit")
public Limit: number;
/** @description 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")
public Ean: string;
/** @description Include metering points with ended contracts (Default: false) */
// @ApiMember(DataType="Boolean", Description="Include metering points with ended contracts (Default: false)", Name="ShowEnded")
public ShowEnded: boolean;
/** @description Include additional info about the metering point (Default: false) */
// @ApiMember(DataType="Boolean", Description="Include additional info about the metering point (Default: false)", Name="AddExtraInfo")
public AddExtraInfo: boolean;
public constructor(init?: Partial<Meteringpoints>) { super(init); (Object as any).assign(this, init); }
}
TypeScript Meteringpoints 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
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: application/json