SDS P4 API

<back to all web services

Meteringpoints

Get list of metering points

The following routes are available for this service:
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
"use strict";
/** @typedef {'ISO8601'|'UTC'|'NL'|'NLOffset'|'IN'|'INOffset'|'Unix'|'UnixMillis'} */
export var DateTimeFormat;
(function (DateTimeFormat) {
    DateTimeFormat["ISO8601"] = "ISO8601"
    DateTimeFormat["UTC"] = "UTC"
    DateTimeFormat["NL"] = "NL"
    DateTimeFormat["NLOffset"] = "NLOffset"
    DateTimeFormat["IN"] = "IN"
    DateTimeFormat["INOffset"] = "INOffset"
    DateTimeFormat["Unix"] = "Unix"
    DateTimeFormat["UnixMillis"] = "UnixMillis"
})(DateTimeFormat || (DateTimeFormat = {}));
export class Generic {
    /** @param {{ApiKey?:string,OnlyPayload?:boolean,ShowRequest?:boolean,DateTimeFormat?:DateTimeFormat}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Api-key. Used to provide credentials to the api. Can also be provided through the request headers with key: X-API-KEY */
    ApiKey;
    /**
     * @type {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  */
    OnlyPayload;
    /**
     * @type {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  */
    ShowRequest;
    /**
     * @type {DateTimeFormat}
     * @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 */
    DateTimeFormat;
}
export class Meteringpoints extends Generic {
    /** @param {{Offset?:number,Limit?:number,Ean?:string,ShowEnded?:boolean,AddExtraInfo?:boolean,ApiKey?:string,OnlyPayload?:boolean,ShowRequest?:boolean,DateTimeFormat?:DateTimeFormat}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {number}
     * @description Skip the first ... metering points */
    Offset;
    /**
     * @type {number}
     * @description Limit response to ... metering points */
    Limit;
    /**
     * @type {string}
     * @description Request of details of specific metering point with Ean */
    Ean;
    /**
     * @type {boolean}
     * @description Include metering points with ended contracts (Default: false) */
    ShowEnded;
    /**
     * @type {boolean}
     * @description Include additional info about the metering point (Default: false) */
    AddExtraInfo;
}

JavaScript Meteringpoints DTOs

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

HTTP + CSV

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/csv