Server

<back to all web services

GetDeviceConsumptionList

Deviceconsumptions
Requires Authentication
The following routes are available for this service:
GET/api/v1/deviceconsumptions
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Enums

Namespace Global

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Enums

        Public Enum DeviceReadingKind
            ZA
            HA
            MO
            EB
            AB
        End Enum
    End Namespace

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get

        Public Partial Class GetDeviceConsumptionList
            Implements IHasBearerToken
            <ApiMember(IsRequired:=true, ParameterType:="query")>
            Public Overridable Property BearerToken As String

            '''<Summary>
            '''Optional! Follow the format : /api/v1/deviceconsumptions?filter[DeviceGuid]=*
            '''</Summary>
            <DataMember(Name:="filter[DeviceGuid]")>
            <ApiMember(Description:="Optional! Follow the format : /api/v1/deviceconsumptions?filter[DeviceGuid]=*", ParameterType:="query")>
            Public Overridable Property FilterByDeviceGuid As String
        End Class

        Public Partial Class GetDeviceConsumptionListResponse
            Public Overridable Property DeviceConsumptionList As IEnumerable(Of DeviceConsumption)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models

        <DataContract>
        Public Partial Class DeviceConsumption
            <DataMember>
            Public Overridable Property Guid As Guid

            <DataMember>
            Public Overridable Property DeviceReading As Nullable(Of Double)

            <DataMember>
            Public Overridable Property DeviceReadingDate As Nullable(Of Date)

            <DataMember>
            Public Overridable Property DeviceReadingKind As DeviceReadingKind

            <DataMember>
            Public Overridable Property ChangeDate As Nullable(Of Date)

            <DataMember>
            Public Overridable Property Note As String

            <DataMember>
            Public Overridable Property AmpouleColour As String

            <DataMember>
            Public Overridable Property DeviceGuid As String
        End Class
    End Namespace
End Namespace

VB.NET GetDeviceConsumptionList DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/v1/deviceconsumptions HTTP/1.1 
Host: demo-servdesk.eras-online.de 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}