Server

GetDeviceList

Devices

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Eras2Client.Models

Namespace Global

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2Client.Models

        <DataContract>
        Public Partial Class Device
            <DataMember(Name:="Guid")>
            Public Overridable Property Guid As String

            <DataMember(Name:="Geraetenummer")>
            Public Overridable Property Number As String

            <DataMember(Name:="Bezeichnung")>
            Public Overridable Property Label As String

            <DataMember(Name:="Beschreibung")>
            Public Overridable Property Description As String

            <DataMember(Name:="Einbaudatum")>
            Public Overridable Property InstallationDate As Date

            <DataMember(Name:="Ausbaudatum")>
            Public Overridable Property DeinstallationDate As Nullable(Of Date)

            <DataMember(Name:="Eichdatum")>
            Public Overridable Property CalibrationDate As Nullable(Of Date)

            <DataMember(Name:="Einheit")>
            Public Overridable Property Unit As String

            <DataMember(Name:="Memo")>
            Public Overridable Property Note As String

            <DataMember(Name:="DeviceCatalogGuid")>
            Public Overridable Property DeviceCatalogGuid As String
        End Class
    End Namespace

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get

        Public Partial Class GetDeviceList
            Implements IHasBearerToken
            <ApiMember(IsRequired:=true, ParameterType:="query")>
            Public Overridable Property BearerToken As String

            '''<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")>
            Public Overridable Property FilterByObjektGuid As String

            '''<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")>
            Public Overridable Property FilterByNutzeinheitGuid As String
        End Class

        Public Partial Class GetDeviceListResponse
            Public Overridable Property DeviceList As IEnumerable(Of Device)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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: marneth-messdienst-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>