Server

<back to all web services

GetDeviceList

Devices
Requires Authentication
The following routes are available for this service:
GET/api/v1/devices
"use strict";
export class Device {
    /** @param {{Guid?:string,Geraetenummer?:string,Bezeichnung?:string,Beschreibung?:string,Einbaudatum?:string,Ausbaudatum?:string,Eichdatum?:string,Einheit?:string,Memo?:string,DeviceCatalogGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    Geraetenummer;
    /** @type {string} */
    Bezeichnung;
    /** @type {string} */
    Beschreibung;
    /** @type {string} */
    Einbaudatum;
    /** @type {?string} */
    Ausbaudatum;
    /** @type {?string} */
    Eichdatum;
    /** @type {string} */
    Einheit;
    /** @type {string} */
    Memo;
    /** @type {string} */
    DeviceCatalogGuid;
}
export class GetDeviceListResponse {
    /** @param {{deviceList?:Device[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Device[]} */
    deviceList;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetDeviceList {
    /** @param {{bearerToken?:string,filter_ObjektGuid_?:string,filter_NutzerGuid_?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    bearerToken;
    /**
     * @type {string}
     * @description Optional! Follow the format : /api/v1/devices?filter[ObjektGuid]=* */
    filter_ObjektGuid_;
    /**
     * @type {string}
     * @description Optional! Follow the format : /api/v1/devices?filter[NutzerGuid]=* */
    filter_NutzerGuid_;
}

JavaScript GetDeviceList DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/v1/devices HTTP/1.1 
Host: knabrechnung-servdesk.eras-online.de 
Accept: text/csv

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

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}