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
namespace SDS.P4v6a.API.Common

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type DateTimeFormat =
        | ISO8601 = 0
        | UTC = 1
        | NL = 2
        | NLOffset = 3
        | IN = 4
        | INOffset = 5
        | Unix = 6
        | UnixMillis = 7

    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with 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")>]
        member val OnlyPayload:Boolean = new Boolean() with 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")>]
        member val ShowRequest:Boolean = new Boolean() with 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")>]
        member val DateTimeFormat:DateTimeFormat = new DateTimeFormat() with get,set

    ///<summary>
    ///Get list of metering points
    ///</summary>
    [<Api(Description="Get list of metering points")>]
    [<AllowNullLiteral>]
    type Meteringpoints() = 
        inherit Generic()
        ///<summary>
        ///Skip the first ... metering points
        ///</summary>
        [<ApiMember(DataType="Integer", Description="Skip the first ... metering points", Name="Offset")>]
        member val Offset:Int32 = new Int32() with get,set

        ///<summary>
        ///Limit response to ... metering points
        ///</summary>
        [<ApiMember(DataType="Integer", Description="Limit response to ... metering points", Name="Limit")>]
        member val Limit:Int32 = new Int32() with 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")>]
        member val Ean:String = null with 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")>]
        member val ShowEnded:Boolean = new Boolean() with 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")>]
        member val AddExtraInfo:Boolean = new Boolean() with get,set

F# 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

HTTP + JSON

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