Server

<back to all web services

GetDevice

Devices
Requires Authentication
The following routes are available for this service:
GET/api/v1/devices/{Guid}
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class GetDevice : IHasBearerToken
{
    @ApiMember(IsRequired=true, ParameterType="query")
    var bearerToken:String? = null

    @ApiMember(IsRequired=true, ParameterType="path")
    var guid:UUID? = null
}

open class GetDeviceResponse
{
    var device:Device? = null
    var responseStatus:ResponseStatus? = null
}

@DataContract
open class Device
{
    @DataMember
    var guid:UUID? = null

    @DataMember
    var number:String? = null

    @DataMember
    var label:String? = null

    @DataMember
    var description:String? = null

    @DataMember
    var installationDate:Date? = null

    @DataMember
    var deinstallationDate:Date? = null

    @DataMember
    var calibrationDate:Date? = null

    @DataMember
    var unit:EinheitType? = null

    @DataMember
    var note:String? = null

    @DataMember
    var deviceCatalog:DeviceCatalog? = null

    @DataMember
    var deviceConsumptions:ArrayList<DeviceConsumption> = ArrayList<DeviceConsumption>()
}

enum class EinheitType
{
    L,
    Kg,
    Cbm,
    Stck,
    Kwh,
    Mwh,
    Gwh,
    T,
    Rm,
    Einheit,
    Qm,
    Gj,
    Mj,
    Null,
    St,
    Srm,
    Wh,
}

@DataContract
open class DeviceCatalog
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:String? = null

    @DataMember(Name="TypKurz")
    @SerializedName("TypKurz")
    var typeShort:String? = null

    @DataMember(Name="TypLang")
    @SerializedName("TypLang")
    var typeLong:String? = null

    @DataMember(Name="Ablesbar")
    @SerializedName("Ablesbar")
    var readable:Boolean? = null

    @DataMember(Name="Klasse")
    @SerializedName("Klasse")
    @SerializedName("class") var Class:String? = null

    @DataMember(Name="Abzug")
    @SerializedName("Abzug")
    var subtraction:Boolean? = null

    @DataMember(Name="Hkvv")
    @SerializedName("Hkvv")
    var hkvv:Boolean? = null

    @DataMember(Name="Funk")
    @SerializedName("Funk")
    var radio:Boolean? = null
}

@DataContract
open class DeviceConsumption
{
    @DataMember
    var guid:UUID? = null

    @DataMember
    var deviceReading:Double? = null

    @DataMember
    var deviceReadingDate:Date? = null

    @DataMember
    var deviceReadingKind:DeviceReadingKind? = null

    @DataMember
    var changeDate:Date? = null

    @DataMember
    var note:String? = null

    @DataMember
    var ampouleColour:String? = null

    @DataMember
    var deviceGuid:String? = null
}

enum class DeviceReadingKind
{
    Za,
    Ha,
    Mo,
    Eb,
    Ab,
}

Kotlin 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: marneth-messdienst-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>