Server

<back to all web services

GetDevice

Devices
Requires Authentication
The following routes are available for this service:
GET/api/v1/devices/{Guid}
namespace Eras2Web.Service.Desktop.Server.ServiceModel.Enums

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type EinheitType =
        | L = 0
        | Kg = 1
        | CBM = 2
        | Stck = 3
        | KWH = 4
        | MWH = 5
        | GWH = 6
        | T = 7
        | RM = 8
        | Einheit = 9
        | Qm = 10
        | GJ = 11
        | MJ = 12
        | Null = 13
        | St = 14
        | Srm = 15
        | Wh = 16

    [<DataContract>]
    [<AllowNullLiteral>]
    type DeviceCatalog() = 
        [<DataMember(Name="Guid")>]
        member val Guid:String = null with get,set

        [<DataMember(Name="TypKurz")>]
        member val TypeShort:String = null with get,set

        [<DataMember(Name="TypLang")>]
        member val TypeLong:String = null with get,set

        [<DataMember(Name="Ablesbar")>]
        member val Readable:Boolean = new Boolean() with get,set

        [<DataMember(Name="Klasse")>]
        member val Class:String = null with get,set

        [<DataMember(Name="Abzug")>]
        member val Subtraction:Boolean = new Boolean() with get,set

        [<DataMember(Name="Hkvv")>]
        member val Hkvv:Boolean = new Boolean() with get,set

        [<DataMember(Name="Funk")>]
        member val Radio:Boolean = new Boolean() with get,set

    type DeviceReadingKind =
        | ZA = 0
        | HA = 1
        | MO = 2
        | EB = 3
        | AB = 4

    [<DataContract>]
    [<AllowNullLiteral>]
    type DeviceConsumption() = 
        [<DataMember>]
        member val Guid:Guid = new Guid() with get,set

        [<DataMember>]
        member val DeviceReading:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val DeviceReadingDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val DeviceReadingKind:DeviceReadingKind = new DeviceReadingKind() with get,set

        [<DataMember>]
        member val ChangeDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val Note:String = null with get,set

        [<DataMember>]
        member val AmpouleColour:String = null with get,set

        [<DataMember>]
        member val DeviceGuid:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type Device() = 
        [<DataMember>]
        member val Guid:Guid = new Guid() with get,set

        [<DataMember>]
        member val Number:String = null with get,set

        [<DataMember>]
        member val Label:String = null with get,set

        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val InstallationDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val DeinstallationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val CalibrationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val Unit:EinheitType = new EinheitType() with get,set

        [<DataMember>]
        member val Note:String = null with get,set

        [<DataMember>]
        member val DeviceCatalog:DeviceCatalog = null with get,set

        [<DataMember>]
        member val DeviceConsumptions:ResizeArray<DeviceConsumption> = new ResizeArray<DeviceConsumption>() with get,set

    [<AllowNullLiteral>]
    type GetDeviceResponse() = 
        member val Device:Device = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type GetDevice() = 
        [<ApiMember(IsRequired=true, ParameterType="query")>]
        member val BearerToken:String = null with get,set

        [<ApiMember(IsRequired=true, ParameterType="path")>]
        member val Guid:Guid = new Guid() with get,set

F# 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: inea-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>