SDS P4 API

<back to all web services

Meteringpoints

Get list of metering points

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Get list of metering points
    */
    @Api(Description="Get list of metering points")
    public static class Meteringpoints extends Generic
    {
        /**
        * Skip the first ... metering points
        */
        @ApiMember(DataType="Integer", Description="Skip the first ... metering points", Name="Offset")
        public Integer Offset = null;

        /**
        * Limit response to ... metering points
        */
        @ApiMember(DataType="Integer", Description="Limit response to ... metering points", Name="Limit")
        public Integer Limit = null;

        /**
        * 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 String Ean = null;

        /**
        * Include metering points with ended contracts (Default: false)
        */
        @ApiMember(DataType="Boolean", Description="Include metering points with ended contracts (Default: false)", Name="ShowEnded")
        public Boolean ShowEnded = null;

        /**
        * 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 Boolean AddExtraInfo = null;
        
        public Integer getOffset() { return Offset; }
        public Meteringpoints setOffset(Integer value) { this.Offset = value; return this; }
        public Integer getLimit() { return Limit; }
        public Meteringpoints setLimit(Integer value) { this.Limit = value; return this; }
        public String getEan() { return Ean; }
        public Meteringpoints setEan(String value) { this.Ean = value; return this; }
        public Boolean isShowEnded() { return ShowEnded; }
        public Meteringpoints setShowEnded(Boolean value) { this.ShowEnded = value; return this; }
        public Boolean isAddExtraInfo() { return AddExtraInfo; }
        public Meteringpoints setAddExtraInfo(Boolean value) { this.AddExtraInfo = value; return this; }
    }

    public static class Generic
    {
        /**
        * 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 String ApiKey = null;

        /**
        * 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 Boolean OnlyPayload = null;

        /**
        * 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 Boolean ShowRequest = null;

        /**
        * 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 = null;
        
        public String getApiKey() { return ApiKey; }
        public Generic setApiKey(String value) { this.ApiKey = value; return this; }
        public Boolean isOnlyPayload() { return OnlyPayload; }
        public Generic setOnlyPayload(Boolean value) { this.OnlyPayload = value; return this; }
        public Boolean isShowRequest() { return ShowRequest; }
        public Generic setShowRequest(Boolean value) { this.ShowRequest = value; return this; }
        public DateTimeFormat getDateTimeFormat() { return DateTimeFormat; }
        public Generic setDateTimeFormat(DateTimeFormat value) { this.DateTimeFormat = value; return this; }
    }

    public static enum DateTimeFormat
    {
        IsO8601,
        Utc,
        Nl,
        NlOffset,
        In,
        InOffset,
        Unix,
        UnixMillis;
    }

}

Java Meteringpoints DTOs

GET /api/v5/meteringpoints/ HTTP/1.1 
Host: p4v8.smartdatasolutions.nl 
Accept: application/json