Server

GetDevice

Devices

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

HTTP + JSV

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: brendle-schneider-servdesk.eras-online.de 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	device: 
	{
		guid: 00000000000000000000000000000000,
		number: String,
		label: String,
		description: String,
		installationDate: 0001-01-01T00:00:00Z,
		deinstallationDate: 0001-01-01T00:00:00Z,
		calibrationDate: 0001-01-01T00:00:00Z,
		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:00Z,
				deviceReadingKind: ZA,
				changeDate: 0001-01-01T00:00:00Z,
				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
		}
	}
}