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 .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 HTTP/1.1 
Host: calotec-portal-servdesk.eras-online.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDeviceListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get">
  <DeviceList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models" i:nil="true" />
  <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>
</GetDeviceListResponse>