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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class DateTimeFormat(str, Enum):
    IS_O8601 = 'ISO8601'
    UTC = 'UTC'
    NL = 'NL'
    NL_OFFSET = 'NLOffset'
    IN_ = 'IN'
    IN_OFFSET = 'INOffset'
    UNIX = 'Unix'
    UNIX_MILLIS = 'UnixMillis'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Generic:
    # @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")
    api_key: Optional[str] = None
    """
    Api-key. Used to provide credentials to the api. Can also be provided through the request headers with key: X-API-KEY
    """


    # @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")
    only_payload: bool = False
    """
    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="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")
    show_request: bool = False
    """
    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="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")
    date_time_format: Optional[DateTimeFormat] = None
    """
    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
    """


# @Api(Description="Get status")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StatusV8(Generic):
    """
    Get status
    """

    # @ApiMember(DataType="EAN (18 numbers)", Description="Request of details of specific metering point with specified ean", Name="Ean")
    ean: Optional[str] = None
    """
    Request of details of specific metering point with specified ean
    """

Python StatusV8 DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv