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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using SDS.P4v6a.API.ServiceModel.Requests;
using SDS.P4v6a.API.Common;

namespace SDS.P4v6a.API.ServiceModel.Requests
{
    public partial class Generic
    {
        ///<summary>
        ///Api-key. Used to provide credentials to the api. Can also be provided through the request headers with key: X-API-KEY
        ///</summary>
        [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 virtual string ApiKey { get; set; }

        ///<summary>
        ///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 
        ///</summary>
        [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 virtual bool OnlyPayload { get; set; }

        ///<summary>
        ///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 
        ///</summary>
        [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 virtual bool ShowRequest { get; set; }

        ///<summary>
        ///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
        ///</summary>
        [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 virtual DateTimeFormat DateTimeFormat { get; set; }
    }

    ///<summary>
    ///Get list of metering points
    ///</summary>
    [Api(Description="Get list of metering points")]
    public partial class Meteringpoints
        : Generic
    {
        ///<summary>
        ///Skip the first ... metering points
        ///</summary>
        [ApiMember(DataType="Integer", Description="Skip the first ... metering points", Name="Offset")]
        public virtual int Offset { get; set; }

        ///<summary>
        ///Limit response to ... metering points
        ///</summary>
        [ApiMember(DataType="Integer", Description="Limit response to ... metering points", Name="Limit")]
        public virtual int Limit { get; set; }

        ///<summary>
        ///Request of details of specific metering point with Ean
        ///</summary>
        [ApiMember(DataType="EAN (18 numbers)", Description="Request of details of specific metering point with Ean", Name="Ean")]
        public virtual string Ean { get; set; }

        ///<summary>
        ///Include metering points with ended contracts (Default: false)
        ///</summary>
        [ApiMember(DataType="Boolean", Description="Include metering points with ended contracts (Default: false)", Name="ShowEnded")]
        public virtual bool ShowEnded { get; set; }

        ///<summary>
        ///Include additional info about the metering point (Default: false)
        ///</summary>
        [ApiMember(DataType="Boolean", Description="Include additional info about the metering point (Default: false)", Name="AddExtraInfo")]
        public virtual bool AddExtraInfo { get; set; }
    }

}

C# Meteringpoints 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/ HTTP/1.1 
Host: p4v8.smartdatasolutions.nl 
Accept: application/xml