Server

<back to all web services

GetStammdaten

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/Stammdaten
namespace Eras2Amw.Service.Server.ServiceModel.Common

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

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

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

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

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

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

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

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

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

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

        [<DataMember(Name="Abzug")>]
        member val Subtraction:Boolean = new Boolean() with get,set

        [<DataMember(Name="Hkvv")>]
        member val Hkvv:Boolean = new Boolean() with get,set

        [<DataMember(Name="Funk")>]
        member val Radio:Boolean = new Boolean() with get,set

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

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

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

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

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

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

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

        [<DataMember(Name="DeviceKindGuid")>]
        member val DeviceKindGuid:Guid = new Guid() with get,set

        [<DataMember(Name="ManufacturerGuid")>]
        member val ManufacturerGuid:Guid = new Guid() with get,set

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

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

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

    type DeviceClass =
        | HKV = 0
        | WWZ = 1
        | KWZ = 2
        | WZ = 3
        | WMZ = 4
        | KMZ = 5
        | RM = 6
        | SZ = 7
        | FM = 8
        | Sonstige = 9
        | Null = 10
        | ENT = 11

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

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

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

        [<DataMember(Name="Ablesbar")>]
        member val Readable:Boolean = new Boolean() with get,set

        [<DataMember(Name="GeraeteKlasse")>]
        member val Class:Nullable<DeviceClass> = new Nullable<DeviceClass>() with get,set

        [<DataMember(Name="Limit")>]
        member val Limit:Nullable<Decimal> = new Nullable<Decimal>() with get,set

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

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

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

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

    type CommunicationKind =
        | Telefon = 1
        | Mobil = 2
        | Fax = 3
        | EMail = 4
        | Web = 5

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

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

        [<DataMember(Name="Typ")>]
        member val Kind:Nullable<CommunicationKind> = new Nullable<CommunicationKind>() with get,set

        [<DataMember(Name="IstVorgegeben")>]
        member val IsPreset:Boolean = new Boolean() with get,set

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

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

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

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

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

        [<DataMember(Name="Key")>]
        member val Key:Int32 = new Int32() with get,set

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

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

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

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

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

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

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

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

    [<AllowNullLiteral>]
    type GetStammdatenResponse() = 
        [<DataMember(Name="StammdatenInfo")>]
        member val StammdatenInfo:StammdatenInfo = null with get,set

        [<DataMember(Name="GeraeteKatalog")>]
        member val DeviceCatalog:IList<DeviceCatalog> = null with get,set

        [<DataMember(Name="Hersteller")>]
        member val Manufacturers:IList<Manufacturer> = null with get,set

        [<DataMember(Name="Geraetetypen")>]
        member val DeviceKinds:IList<DeviceKind> = null with get,set

        [<DataMember(Name="Artikel")>]
        member val Articles:IList<Article> = null with get,set

        [<DataMember(Name="KommunikationFunktionen")>]
        member val CommunicationFeatures:IList<CommunicationFeature> = null with get,set

        [<DataMember(Name="Ablesearten")>]
        member val ReadingKinds:IList<ReadingKind> = null with get,set

        [<DataMember(Name="Infoschluessel")>]
        member val AmwInfoKeys:IList<AmwInfoKey> = null with get,set

        [<DataMember(Name="Zusatzartikel")>]
        member val AdditionalArticles:IList<AdditionalArticle> = null with get,set

        [<DataMember(Name="Raeume")>]
        member val Rooms:IList<Room> = null with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetStammdaten() = 
        class end

F# 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: mitchell-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>