Server

<back to all web services

GetDevice

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

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

// @DataContract
export class DeviceCatalog
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="TypKurz")
    public TypKurz: string;

    // @DataMember(Name="TypLang")
    public TypLang: string;

    // @DataMember(Name="Ablesbar")
    public Ablesbar: boolean;

    // @DataMember(Name="Klasse")
    public Klasse: string;

    // @DataMember(Name="Abzug")
    public Abzug: boolean;

    // @DataMember(Name="Hkvv")
    public Hkvv: boolean;

    // @DataMember(Name="Funk")
    public Funk: boolean;

    public constructor(init?: Partial<DeviceCatalog>) { (Object as any).assign(this, init); }
}

export enum DeviceReadingKind
{
    ZA = 'ZA',
    HA = 'HA',
    MO = 'MO',
    EB = 'EB',
    AB = 'AB',
}

// @DataContract
export class DeviceConsumption
{
    // @DataMember
    public guid: string;

    // @DataMember
    public deviceReading?: number;

    // @DataMember
    public deviceReadingDate?: string;

    // @DataMember
    public deviceReadingKind: DeviceReadingKind;

    // @DataMember
    public changeDate?: string;

    // @DataMember
    public note: string;

    // @DataMember
    public ampouleColour: string;

    // @DataMember
    public deviceGuid: string;

    public constructor(init?: Partial<DeviceConsumption>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Device
{
    // @DataMember
    public guid: string;

    // @DataMember
    public number: string;

    // @DataMember
    public label: string;

    // @DataMember
    public description: string;

    // @DataMember
    public installationDate: string;

    // @DataMember
    public deinstallationDate?: string;

    // @DataMember
    public calibrationDate?: string;

    // @DataMember
    public unit: EinheitType;

    // @DataMember
    public note: string;

    // @DataMember
    public deviceCatalog: DeviceCatalog;

    // @DataMember
    public deviceConsumptions: DeviceConsumption[];

    public constructor(init?: Partial<Device>) { (Object as any).assign(this, init); }
}

export class GetDeviceResponse
{
    public device: Device;
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetDeviceResponse>) { (Object as any).assign(this, init); }
}

export class GetDevice implements IHasBearerToken
{
    // @ApiMember(IsRequired=true, ParameterType="query")
    public bearerToken: string;

    // @ApiMember(IsRequired=true, ParameterType="path")
    public guid: string;

    public constructor(init?: Partial<GetDevice>) { (Object as any).assign(this, init); }
}

TypeScript 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: develop-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>