Server

<back to all web services

GetDeviceList

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

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

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

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

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

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

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

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

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

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

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

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

export class GetDeviceListResponse
{
    public deviceList: Device[];
    public responseStatus: ResponseStatus;

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

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

    /** @description Optional! Follow the format : /api/v1/devices?filter[ObjektGuid]=* */
    // @DataMember(Name="filter[ObjektGuid]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/devices?filter[ObjektGuid]=*", ParameterType="query")
    public filter_ObjektGuid_: string;

    /** @description Optional! Follow the format : /api/v1/devices?filter[NutzerGuid]=* */
    // @DataMember(Name="filter[NutzerGuid]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/devices?filter[NutzerGuid]=*", ParameterType="query")
    public filter_NutzerGuid_: string;

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

TypeScript 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: bdl-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"}}}