Server

GetDevice

Devices

The following routes are available for this service:
GET	/api/v1/devices/{Guid}

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
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Stammdaten

Namespace Global

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

        Public Enum DeviceReadingKind
            ZA
            HA
            MO
            EB
            AB
        End Enum

        Public Enum EinheitType
            L
            Kg
            CBM
            Stck
            KWH
            MWH
            GWH
            T
            RM
            Einheit
            Qm
            GJ
            MJ
            Null
            St
            Srm
            Wh
        End Enum
    End Namespace

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

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

            <ApiMember(IsRequired:=true, ParameterType:="path")>
            Public Overridable Property Guid As Guid
        End Class

        Public Partial Class GetDeviceResponse
            Public Overridable Property Device As Device
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

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

        <DataContract>
        Public Partial Class Device
            Public Sub New()
                DeviceConsumptions = New List(Of DeviceConsumption)
            End Sub

            <DataMember>
            Public Overridable Property Guid As Guid

            <DataMember>
            Public Overridable Property Number As String

            <DataMember>
            Public Overridable Property Label As String

            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property InstallationDate As Date

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

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

            <DataMember>
            Public Overridable Property Unit As EinheitType

            <DataMember>
            Public Overridable Property Note As String

            <DataMember>
            Public Overridable Property DeviceCatalog As DeviceCatalog

            <DataMember>
            Public Overridable Property DeviceConsumptions As List(Of DeviceConsumption)
        End Class

        <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

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Stammdaten

        <DataContract>
        Public Partial Class DeviceCatalog
            <DataMember(Name:="Guid")>
            Public Overridable Property Guid As String

            <DataMember(Name:="TypKurz")>
            Public Overridable Property TypeShort As String

            <DataMember(Name:="TypLang")>
            Public Overridable Property TypeLong As String

            <DataMember(Name:="Ablesbar")>
            Public Overridable Property Readable As Boolean

            <DataMember(Name:="Klasse")>
            Public Overridable Property [Class] As String

            <DataMember(Name:="Abzug")>
            Public Overridable Property Subtraction As Boolean

            <DataMember(Name:="Hkvv")>
            Public Overridable Property Hkvv As Boolean

            <DataMember(Name:="Funk")>
            Public Overridable Property Radio As Boolean
        End Class
    End Namespace
End Namespace

VB.NET GetDevice 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/v1/devices/{Guid} HTTP/1.1 
Host: demo-servdesk.eras-online.de 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDeviceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get">
  <Device xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:CalibrationDate>0001-01-01T00:00:00</d2p1:CalibrationDate>
    <d2p1:DeinstallationDate>0001-01-01T00:00:00</d2p1:DeinstallationDate>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:DeviceCatalog xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Stammdaten">
      <d3p1:Ablesbar>false</d3p1:Ablesbar>
      <d3p1:Abzug>false</d3p1:Abzug>
      <d3p1:Funk>false</d3p1:Funk>
      <d3p1:Guid>String</d3p1:Guid>
      <d3p1:Hkvv>false</d3p1:Hkvv>
      <d3p1:Klasse>String</d3p1:Klasse>
      <d3p1:TypKurz>String</d3p1:TypKurz>
      <d3p1:TypLang>String</d3p1:TypLang>
    </d2p1:DeviceCatalog>
    <d2p1:DeviceConsumptions>
      <d2p1:DeviceConsumption>
        <d2p1:AmpouleColour>String</d2p1:AmpouleColour>
        <d2p1:ChangeDate>0001-01-01T00:00:00</d2p1:ChangeDate>
        <d2p1:DeviceGuid>String</d2p1:DeviceGuid>
        <d2p1:DeviceReading>0</d2p1:DeviceReading>
        <d2p1:DeviceReadingDate>0001-01-01T00:00:00</d2p1:DeviceReadingDate>
        <d2p1:DeviceReadingKind>ZA</d2p1:DeviceReadingKind>
        <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
        <d2p1:Note>String</d2p1:Note>
      </d2p1:DeviceConsumption>
    </d2p1:DeviceConsumptions>
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
    <d2p1:InstallationDate>0001-01-01T00:00:00</d2p1:InstallationDate>
    <d2p1:Label>String</d2p1:Label>
    <d2p1:Note>String</d2p1:Note>
    <d2p1:Number>String</d2p1:Number>
    <d2p1:Unit>L</d2p1:Unit>
  </Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetDeviceResponse>