SDS P4 API

<back to all web services

Usage

Get usages from tablestorage

"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;
}
/** @typedef {'None'|'Hour'|'Day'|'Week'|'Month'|'Year'} */
export var AggregationForAPI;
(function (AggregationForAPI) {
    AggregationForAPI["None"] = "None"
    AggregationForAPI["Hour"] = "Hour"
    AggregationForAPI["Day"] = "Day"
    AggregationForAPI["Week"] = "Week"
    AggregationForAPI["Month"] = "Month"
    AggregationForAPI["Year"] = "Year"
})(AggregationForAPI || (AggregationForAPI = {}));
/** @typedef {'UsageReturnCombined'|'UsageReturn'|'UsageReturnAndTariff'} */
export var PayloadFormat;
(function (PayloadFormat) {
    PayloadFormat["UsageReturnCombined"] = "UsageReturnCombined"
    PayloadFormat["UsageReturn"] = "UsageReturn"
    PayloadFormat["UsageReturnAndTariff"] = "UsageReturnAndTariff"
})(PayloadFormat || (PayloadFormat = {}));
/** @typedef {'Detail'|'Day'|'Month'|'Unknown'} */
export var MeasurementSource;
(function (MeasurementSource) {
    MeasurementSource["Detail"] = "Detail"
    MeasurementSource["Day"] = "Day"
    MeasurementSource["Month"] = "Month"
    MeasurementSource["Unknown"] = "Unknown"
})(MeasurementSource || (MeasurementSource = {}));
export class Usage extends Generic {
    /** @param {{Ean?:string,Aggregation?:AggregationForAPI,DateFrom?:string,DateTo?:string,PayloadFormat?:PayloadFormat,Source?:MeasurementSource,AddDateNL?:boolean,AddTimestamps?:boolean,AddEan?:boolean,RegistersInRows?:boolean,CalculateDetailTariff?:boolean,CalculateMissingUsages?:boolean,ApiKey?:string,OnlyPayload?:boolean,ShowRequest?:boolean,DateTimeFormat?:DateTimeFormat}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description Request of details of specific meteringpoint with Ean */
    Ean;
    /**
     * @type {AggregationForAPI}
     * @description Aggregation level. The None-'level' will give the most detailed level available for the requested asset. If a level is requested that is not available or can be calculate, no data is returned. Enum options: None, Hour, Day */
    Aggregation;
    /**
     * @type {string}
     * @description Start date the usages are requested for */
    DateFrom;
    /**
     * @type {?string}
     * @description End date the usages are requested for (this is included in the response). If no date is provided the DateTo will seven days from the DateFrom.  */
    DateTo;
    /**
     * @type {PayloadFormat}
     * @description The output can be generated in a few formats. UsageReturnCombined: return values will be subtracted from the usage, UsageReturn: separate columns form usage and return (if available) and UsageReturnAndTariff: for both usage and return a column for tariff1 and tariff2. Default value: UsageReturnCombined */
    PayloadFormat;
    /**
     * @type {MeasurementSource}
     * @description See filter. Usages are available from the Detail or Day channel. Default value: Detail */
    Source;
    /**
     * @type {boolean}
     * @description Add column with Dutch day (Default: false) */
    AddDateNL;
    /**
     * @type {boolean}
     * @description Add columns with CreatedOn and LastUpdated (Default: false) */
    AddTimestamps;
    /**
     * @type {boolean}
     * @description Add column with ean (Default: false) */
    AddEan;
    /**
     * @type {boolean}
     * @description Create a row for each register instead of a column/field for each register (Default: false) */
    RegistersInRows;
    /**
     * @type {boolean}
     * @description Gridoperator doesn't provided tariff information for the detail channel, but this can be calculated (Default: false) */
    CalculateDetailTariff;
    /**
     * @type {boolean}
     * @description calculate the usage of that period and divide it over the missing hours or 15 minute periods, but this can be calculated (Default: false) */
    CalculateMissingUsages;
}

JavaScript Usage DTOs

GET /api/v5/meteringpoints/{Ean}/usages/{Aggregation}/{DateFrom} HTTP/1.1 
Host: p4v8.smartdatasolutions.nl 
Accept: text/jsv