Server

<back to all web services

GetStammdaten

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/Stammdaten
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class GetStammdaten
{
}

open class GetStammdatenResponse
{
    @DataMember(Name="StammdatenInfo")
    @SerializedName("StammdatenInfo")
    var stammdatenInfo:StammdatenInfo? = null

    @DataMember(Name="GeraeteKatalog")
    @SerializedName("GeraeteKatalog")
    var deviceCatalog:IList<DeviceCatalog>? = null

    @DataMember(Name="Hersteller")
    @SerializedName("Hersteller")
    var manufacturers:IList<Manufacturer>? = null

    @DataMember(Name="Geraetetypen")
    @SerializedName("Geraetetypen")
    var deviceKinds:IList<DeviceKind>? = null

    @DataMember(Name="Artikel")
    @SerializedName("Artikel")
    var articles:IList<Article>? = null

    @DataMember(Name="KommunikationFunktionen")
    @SerializedName("KommunikationFunktionen")
    var communicationFeatures:IList<CommunicationFeature>? = null

    @DataMember(Name="Ablesearten")
    @SerializedName("Ablesearten")
    var readingKinds:IList<ReadingKind>? = null

    @DataMember(Name="Infoschluessel")
    @SerializedName("Infoschluessel")
    var amwInfoKeys:IList<AmwInfoKey>? = null

    @DataMember(Name="Zusatzartikel")
    @SerializedName("Zusatzartikel")
    var additionalArticles:IList<AdditionalArticle>? = null

    @DataMember(Name="Raeume")
    @SerializedName("Raeume")
    var rooms:IList<Room>? = null

    var responseStatus:ResponseStatus? = null
}

@DataContract
open class StammdatenInfo
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:UUID? = null

    @DataMember(Name="Version")
    @SerializedName("Version")
    var version:String? = null

    @DataMember(Name="Anmerkung")
    @SerializedName("Anmerkung")
    var note:String? = null
}

@DataContract
open class DeviceCatalog
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:UUID? = null

    @DataMember(Name="ArtikelName")
    @SerializedName("ArtikelName")
    var articleName:String? = null

    @DataMember(Name="ArtikelNummer")
    @SerializedName("ArtikelNummer")
    var articleNumber:String? = null

    @DataMember(Name="ArtikelBeschreibung")
    @SerializedName("ArtikelBeschreibung")
    var articleDescription:String? = null

    @DataMember(Name="ArtikelnummerHersteller")
    @SerializedName("ArtikelnummerHersteller")
    var articleNumberManufacturer:String? = null

    @DataMember(Name="Kurzbezeichnung")
    @SerializedName("Kurzbezeichnung")
    var label:String? = null

    @DataMember(Name="Abzug")
    @SerializedName("Abzug")
    var subtraction:Boolean? = null

    @DataMember(Name="Hkvv")
    @SerializedName("Hkvv")
    var hkvv:Boolean? = null

    @DataMember(Name="Funk")
    @SerializedName("Funk")
    var radio:Boolean? = null

    @DataMember(Name="Bestellnummer")
    @SerializedName("Bestellnummer")
    var orderCode:String? = null

    @DataMember(Name="Baulaenge")
    @SerializedName("Baulaenge")
    var installationLength:String? = null

    @DataMember(Name="Anschluss")
    @SerializedName("Anschluss")
    var connector:String? = null

    @DataMember(Name="Qn")
    @SerializedName("Qn")
    var diameter:String? = null

    @DataMember(Name="SontexFunkID")
    @SerializedName("SontexFunkID")
    var sontexRadioIdentifier:String? = null

    @DataMember(Name="SontexHKVKennung")
    @SerializedName("SontexHKVKennung")
    var sontexHkvIdentifier:String? = null

    @DataMember(Name="Memo")
    @SerializedName("Memo")
    var note:String? = null

    @DataMember(Name="DeviceKindGuid")
    @SerializedName("DeviceKindGuid")
    var deviceKindGuid:UUID? = null

    @DataMember(Name="ManufacturerGuid")
    @SerializedName("ManufacturerGuid")
    var manufacturerGuid:UUID? = null
}

@DataContract
open class Manufacturer
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:UUID? = null

    @DataMember(Name="Name")
    @SerializedName("Name")
    var name:String? = null

    @DataMember(Name="Anmerkung")
    @SerializedName("Anmerkung")
    var note:String? = null
}

@DataContract
open class DeviceKind
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:UUID? = null

    @DataMember(Name="GeraeteTypLang")
    @SerializedName("GeraeteTypLang")
    var labelLong:String? = null

    @DataMember(Name="GeraeteTypKurz")
    @SerializedName("GeraeteTypKurz")
    var labelShort:String? = null

    @DataMember(Name="Ablesbar")
    @SerializedName("Ablesbar")
    var readable:Boolean? = null

    @DataMember(Name="GeraeteKlasse")
    @SerializedName("GeraeteKlasse")
    @SerializedName("class") var Class:DeviceClass? = null

    @DataMember(Name="Limit")
    @SerializedName("Limit")
    var limit:BigDecimal? = null
}

enum class DeviceClass
{
    Hkv,
    Wwz,
    Kwz,
    Wz,
    Wmz,
    Kmz,
    Rm,
    Sz,
    Fm,
    Sonstige,
    Null,
    Ent,
}

@DataContract
open class Article
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:UUID? = null

    @DataMember(Name="Artikelnummer")
    @SerializedName("Artikelnummer")
    var number:String? = null

    @DataMember(Name="Bezeichnung")
    @SerializedName("Bezeichnung")
    var label:String? = null

    @DataMember(Name="Anmerkung")
    @SerializedName("Anmerkung")
    var note:String? = null
}

@DataContract
open class CommunicationFeature
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:UUID? = null

    @DataMember(Name="Funktion")
    @SerializedName("Funktion")
    var feature:String? = null

    @DataMember(Name="Typ")
    @SerializedName("Typ")
    var kind:CommunicationKind? = null

    @DataMember(Name="IstVorgegeben")
    @SerializedName("IstVorgegeben")
    var isPreset:Boolean? = null

    @DataMember(Name="Anmerkung")
    @SerializedName("Anmerkung")
    var note:String? = null
}

enum class CommunicationKind(val value:Int)
{
    Telefon(1),
    Mobil(2),
    Fax(3),
    EMail(4),
    Web(5),
}

@DataContract
open class ReadingKind
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:UUID? = null

    @DataMember(Name="Kurzbezeichnung")
    @SerializedName("Kurzbezeichnung")
    var labelShort:String? = null

    @DataMember(Name="Langbezeichnung")
    @SerializedName("Langbezeichnung")
    var labelLong:String? = null
}

@DataContract
open class AmwInfoKey
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:UUID? = null

    @DataMember(Name="Key")
    @SerializedName("Key")
    var key:Int? = null

    @DataMember(Name="Info")
    @SerializedName("Info")
    var info:String? = null
}

@DataContract
open class AdditionalArticle
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:UUID? = null

    @DataMember(Name="Nummer")
    @SerializedName("Nummer")
    var number:String? = null

    @DataMember(Name="Bezeichnung")
    @SerializedName("Bezeichnung")
    var label:String? = null

    @DataMember(Name="Anmerkung")
    @SerializedName("Anmerkung")
    var note:String? = null
}

@DataContract
open class Room
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:UUID? = null

    @DataMember(Name="Kurzbezeichnung")
    @SerializedName("Kurzbezeichnung")
    var labelShort:String? = null

    @DataMember(Name="Bezeichnung")
    @SerializedName("Bezeichnung")
    var label:String? = null
}

Kotlin 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: inea-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>