Server

<back to all web services

GetDeviceList

Devices
Requires Authentication
The following routes are available for this service:
GET/api/v1/devices
namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2Client.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type Device() = 
        [<DataMember(Name="Guid")>]
        member val Guid:String = null with get,set

        [<DataMember(Name="Geraetenummer")>]
        member val Number:String = null with get,set

        [<DataMember(Name="Bezeichnung")>]
        member val Label:String = null with get,set

        [<DataMember(Name="Beschreibung")>]
        member val Description:String = null with get,set

        [<DataMember(Name="Einbaudatum")>]
        member val InstallationDate:DateTime = new DateTime() with get,set

        [<DataMember(Name="Ausbaudatum")>]
        member val DeinstallationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember(Name="Eichdatum")>]
        member val CalibrationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember(Name="Einheit")>]
        member val Unit:String = null with get,set

        [<DataMember(Name="Memo")>]
        member val Note:String = null with get,set

        [<DataMember(Name="DeviceCatalogGuid")>]
        member val DeviceCatalogGuid:String = null with get,set

    [<AllowNullLiteral>]
    type GetDeviceListResponse() = 
        member val DeviceList:IEnumerable<Device> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type GetDeviceList() = 
        [<ApiMember(IsRequired=true, ParameterType="query")>]
        member val BearerToken:String = null with get,set

        ///<summary>
        ///Optional! Follow the format : /api/v1/devices?filter[ObjektGuid]=*
        ///</summary>
        [<DataMember(Name="filter[ObjektGuid]")>]
        [<ApiMember(Description="Optional! Follow the format : /api/v1/devices?filter[ObjektGuid]=*", ParameterType="query")>]
        member val FilterByObjektGuid:String = null with get,set

        ///<summary>
        ///Optional! Follow the format : /api/v1/devices?filter[NutzerGuid]=*
        ///</summary>
        [<DataMember(Name="filter[NutzerGuid]")>]
        [<ApiMember(Description="Optional! Follow the format : /api/v1/devices?filter[NutzerGuid]=*", ParameterType="query")>]
        member val FilterByNutzeinheitGuid:String = null with get,set

F# 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: immo-account-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>