SDS P4 API

<back to all web services

StatusV8

Get status

The following routes are available for this service:
GET/api/v5/meteringpoints/{Ean}/statusGet the status of a single asset
GET/api/v8/meteringpoints/{Ean}/statusGet the status of a single asset
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports SDS.P4v6a.API.ServiceModel.Requests
Imports SDS.P4v6a.API.Common

Namespace Global

    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 Overridable Property ApiKey As String

            '''<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 Overridable Property OnlyPayload As Boolean

            '''<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 Overridable Property ShowRequest As Boolean

            '''<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 Overridable Property DateTimeFormat As DateTimeFormat
        End Class

        '''<Summary>
        '''Get status
        '''</Summary>
        <Api(Description:="Get status")>
        Public Partial Class StatusV8
            Inherits Generic
            '''<Summary>
            '''Request of details of specific metering point with specified ean
            '''</Summary>
            <ApiMember(DataType:="EAN (18 numbers)", Description:="Request of details of specific metering point with specified ean", Name:="Ean")>
            Public Overridable Property Ean As String
        End Class
    End Namespace
End Namespace

VB.NET StatusV8 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/{Ean}/status HTTP/1.1 
Host: p4v8.smartdatasolutions.nl 
Accept: application/xml