Server

<back to all web services

GetStammdaten

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/Stammdaten
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eras2Amw.Service.Server.ServiceModel.Eras2Client.Stammdaten
Imports Eras2Amw.Service.Server.ServiceModel.Common
Imports Eras2Amw.Service.Server.ServiceModel.Enums

Namespace Global

    Namespace Eras2Amw.Service.Server.ServiceModel.Common

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

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

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

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

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

            <DataMember(Name:="Key")>
            Public Overridable Property Key As Integer

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

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

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

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

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

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

            <DataMember(Name:="Funktion")>
            Public Overridable Property Feature As String

            <DataMember(Name:="Typ")>
            Public Overridable Property Kind As Nullable(Of CommunicationKind)

            <DataMember(Name:="IstVorgegeben")>
            Public Overridable Property IsPreset As Boolean

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

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

            <DataMember(Name:="ArtikelName")>
            Public Overridable Property ArticleName As String

            <DataMember(Name:="ArtikelNummer")>
            Public Overridable Property ArticleNumber As String

            <DataMember(Name:="ArtikelBeschreibung")>
            Public Overridable Property ArticleDescription As String

            <DataMember(Name:="ArtikelnummerHersteller")>
            Public Overridable Property ArticleNumberManufacturer As String

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

            <DataMember(Name:="Abzug")>
            Public Overridable Property Subtraction As Boolean

            <DataMember(Name:="Hkvv")>
            Public Overridable Property Hkvv As Boolean

            <DataMember(Name:="Funk")>
            Public Overridable Property Radio As Boolean

            <DataMember(Name:="Bestellnummer")>
            Public Overridable Property OrderCode As String

            <DataMember(Name:="Baulaenge")>
            Public Overridable Property InstallationLength As String

            <DataMember(Name:="Anschluss")>
            Public Overridable Property Connector As String

            <DataMember(Name:="Qn")>
            Public Overridable Property Diameter As String

            <DataMember(Name:="SontexFunkID")>
            Public Overridable Property SontexRadioIdentifier As String

            <DataMember(Name:="SontexHKVKennung")>
            Public Overridable Property SontexHkvIdentifier As String

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

            <DataMember(Name:="DeviceKindGuid")>
            Public Overridable Property DeviceKindGuid As Guid

            <DataMember(Name:="ManufacturerGuid")>
            Public Overridable Property ManufacturerGuid As Guid
        End Class

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

            <DataMember(Name:="GeraeteTypLang")>
            Public Overridable Property LabelLong As String

            <DataMember(Name:="GeraeteTypKurz")>
            Public Overridable Property LabelShort As String

            <DataMember(Name:="Ablesbar")>
            Public Overridable Property Readable As Boolean

            <DataMember(Name:="GeraeteKlasse")>
            Public Overridable Property [Class] As Nullable(Of DeviceClass)

            <DataMember(Name:="Limit")>
            Public Overridable Property Limit As Nullable(Of Decimal)
        End Class

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

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

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

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

            <DataMember(Name:="Kurzbezeichnung")>
            Public Overridable Property LabelShort As String

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

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

            <DataMember(Name:="Kurzbezeichnung")>
            Public Overridable Property LabelShort As String

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

    Namespace Eras2Amw.Service.Server.ServiceModel.Enums

        Public Enum CommunicationKind
            Telefon = 1
            Mobil = 2
            Fax = 3
            EMail = 4
            Web = 5
        End Enum

        Public Enum DeviceClass
            HKV
            WWZ
            KWZ
            WZ
            WMZ
            KMZ
            RM
            SZ
            FM
            Sonstige
            Null
            ENT
        End Enum
    End Namespace

    Namespace Eras2Amw.Service.Server.ServiceModel.Eras2Client.Stammdaten

        <DataContract>
        Public Partial Class GetStammdaten
        End Class

        Public Partial Class GetStammdatenResponse
            <DataMember(Name:="StammdatenInfo")>
            Public Overridable Property StammdatenInfo As StammdatenInfo

            <DataMember(Name:="GeraeteKatalog")>
            Public Overridable Property DeviceCatalog As IList(Of DeviceCatalog)

            <DataMember(Name:="Hersteller")>
            Public Overridable Property Manufacturers As IList(Of Manufacturer)

            <DataMember(Name:="Geraetetypen")>
            Public Overridable Property DeviceKinds As IList(Of DeviceKind)

            <DataMember(Name:="Artikel")>
            Public Overridable Property Articles As IList(Of Article)

            <DataMember(Name:="KommunikationFunktionen")>
            Public Overridable Property CommunicationFeatures As IList(Of CommunicationFeature)

            <DataMember(Name:="Ablesearten")>
            Public Overridable Property ReadingKinds As IList(Of ReadingKind)

            <DataMember(Name:="Infoschluessel")>
            Public Overridable Property AmwInfoKeys As IList(Of AmwInfoKey)

            <DataMember(Name:="Zusatzartikel")>
            Public Overridable Property AdditionalArticles As IList(Of AdditionalArticle)

            <DataMember(Name:="Raeume")>
            Public Overridable Property Rooms As IList(Of Room)

            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

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

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

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

VB.NET GetStammdaten 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 /App/{UserId}/Stammdaten HTTP/1.1 
Host: eca-abrechnungsservice-servamw.eras-online.de 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetStammdatenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2App.Get">
  <AdditionalArticles xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <AmwInfoKeys xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <Articles xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <CommunicationFeatures xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <DeviceCatalog xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <DeviceKinds xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <Manufacturers xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <ReadingKinds xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" 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>
  <Rooms xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <StammdatenInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2Client.Stammdaten">
    <d2p1:Anmerkung>String</d2p1:Anmerkung>
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
    <d2p1:Version>String</d2p1:Version>
  </StammdatenInfo>
</GetStammdatenResponse>