Server

<back to all web services

GetDevice

Devices
Requires Authentication
The following routes are available for this service:
GET/api/v1/devices/{Guid}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get;
using Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models;
using Eras2Web.Service.Desktop.Server.ServiceModel.Enums;
using Eras2Web.Service.Desktop.Server.ServiceModel.Stammdaten;

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Enums
{
    public enum DeviceReadingKind
    {
        ZA,
        HA,
        MO,
        EB,
        AB,
    }

    public enum EinheitType
    {
        L,
        Kg,
        CBM,
        Stck,
        KWH,
        MWH,
        GWH,
        T,
        RM,
        Einheit,
        Qm,
        GJ,
        MJ,
        Null,
        St,
        Srm,
        Wh,
    }

}

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get
{
    public partial class GetDevice
        : IHasBearerToken
    {
        [ApiMember(IsRequired=true, ParameterType="query")]
        public virtual string BearerToken { get; set; }

        [ApiMember(IsRequired=true, ParameterType="path")]
        public virtual Guid Guid { get; set; }
    }

    public partial class GetDeviceResponse
    {
        public virtual Device Device { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models
{
    [DataContract]
    public partial class Device
    {
        public Device()
        {
            DeviceConsumptions = new List<DeviceConsumption>{};
        }

        [DataMember]
        public virtual Guid Guid { get; set; }

        [DataMember]
        public virtual string Number { get; set; }

        [DataMember]
        public virtual string Label { get; set; }

        [DataMember]
        public virtual string Description { get; set; }

        [DataMember]
        public virtual DateTime InstallationDate { get; set; }

        [DataMember]
        public virtual DateTime? DeinstallationDate { get; set; }

        [DataMember]
        public virtual DateTime? CalibrationDate { get; set; }

        [DataMember]
        public virtual EinheitType Unit { get; set; }

        [DataMember]
        public virtual string Note { get; set; }

        [DataMember]
        public virtual DeviceCatalog DeviceCatalog { get; set; }

        [DataMember]
        public virtual List<DeviceConsumption> DeviceConsumptions { get; set; }
    }

    [DataContract]
    public partial class DeviceConsumption
    {
        [DataMember]
        public virtual Guid Guid { get; set; }

        [DataMember]
        public virtual double? DeviceReading { get; set; }

        [DataMember]
        public virtual DateTime? DeviceReadingDate { get; set; }

        [DataMember]
        public virtual DeviceReadingKind DeviceReadingKind { get; set; }

        [DataMember]
        public virtual DateTime? ChangeDate { get; set; }

        [DataMember]
        public virtual string Note { get; set; }

        [DataMember]
        public virtual string AmpouleColour { get; set; }

        [DataMember]
        public virtual string DeviceGuid { get; set; }
    }

}

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Stammdaten
{
    [DataContract]
    public partial class DeviceCatalog
    {
        [DataMember(Name="Guid")]
        public virtual string Guid { get; set; }

        [DataMember(Name="TypKurz")]
        public virtual string TypeShort { get; set; }

        [DataMember(Name="TypLang")]
        public virtual string TypeLong { get; set; }

        [DataMember(Name="Ablesbar")]
        public virtual bool Readable { get; set; }

        [DataMember(Name="Klasse")]
        public virtual string Class { get; set; }

        [DataMember(Name="Abzug")]
        public virtual bool Subtraction { get; set; }

        [DataMember(Name="Hkvv")]
        public virtual bool Hkvv { get; set; }

        [DataMember(Name="Funk")]
        public virtual bool Radio { get; set; }
    }

}

C# 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: depolt-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>