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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: kromer-servdesk.eras-online.de 
Accept: application/json

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

{"device":{"guid":"00000000000000000000000000000000","number":"String","label":"String","description":"String","installationDate":"0001-01-01T00:00:00.0000000Z","deinstallationDate":"0001-01-01T00:00:00.0000000Z","calibrationDate":"0001-01-01T00:00:00.0000000Z","unit":"L","note":"String","deviceCatalog":{"Guid":"String","TypKurz":"String","TypLang":"String","Ablesbar":false,"Klasse":"String","Abzug":false,"Hkvv":false,"Funk":false},"deviceConsumptions":[{"guid":"00000000000000000000000000000000","deviceReading":0,"deviceReadingDate":"0001-01-01T00:00:00.0000000Z","deviceReadingKind":"ZA","changeDate":"0001-01-01T00:00:00.0000000Z","note":"String","ampouleColour":"String","deviceGuid":"String"}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}