Server

<back to all web services

GetStammdaten

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/Stammdaten

// @DataContract
export class StammdatenInfo
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="Version")
    public Version: string;

    // @DataMember(Name="Anmerkung")
    public Anmerkung: string;

    public constructor(init?: Partial<StammdatenInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class DeviceCatalog
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="ArtikelName")
    public ArtikelName: string;

    // @DataMember(Name="ArtikelNummer")
    public ArtikelNummer: string;

    // @DataMember(Name="ArtikelBeschreibung")
    public ArtikelBeschreibung: string;

    // @DataMember(Name="ArtikelnummerHersteller")
    public ArtikelnummerHersteller: string;

    // @DataMember(Name="Kurzbezeichnung")
    public Kurzbezeichnung: string;

    // @DataMember(Name="Abzug")
    public Abzug: boolean;

    // @DataMember(Name="Hkvv")
    public Hkvv: boolean;

    // @DataMember(Name="Funk")
    public Funk: boolean;

    // @DataMember(Name="Bestellnummer")
    public Bestellnummer: string;

    // @DataMember(Name="Baulaenge")
    public Baulaenge: string;

    // @DataMember(Name="Anschluss")
    public Anschluss: string;

    // @DataMember(Name="Qn")
    public Qn: string;

    // @DataMember(Name="SontexFunkID")
    public SontexFunkID: string;

    // @DataMember(Name="SontexHKVKennung")
    public SontexHKVKennung: string;

    // @DataMember(Name="Memo")
    public Memo: string;

    // @DataMember(Name="DeviceKindGuid")
    public DeviceKindGuid: string;

    // @DataMember(Name="ManufacturerGuid")
    public ManufacturerGuid: string;

    public constructor(init?: Partial<DeviceCatalog>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Manufacturer
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="Name")
    public Name: string;

    // @DataMember(Name="Anmerkung")
    public Anmerkung: string;

    public constructor(init?: Partial<Manufacturer>) { (Object as any).assign(this, init); }
}

export enum DeviceClass
{
    HKV = 'HKV',
    WWZ = 'WWZ',
    KWZ = 'KWZ',
    WZ = 'WZ',
    WMZ = 'WMZ',
    KMZ = 'KMZ',
    RM = 'RM',
    SZ = 'SZ',
    FM = 'FM',
    Sonstige = 'Sonstige',
    Null = 'Null',
    ENT = 'ENT',
}

// @DataContract
export class DeviceKind
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="GeraeteTypLang")
    public GeraeteTypLang: string;

    // @DataMember(Name="GeraeteTypKurz")
    public GeraeteTypKurz: string;

    // @DataMember(Name="Ablesbar")
    public Ablesbar: boolean;

    // @DataMember(Name="GeraeteKlasse")
    public GeraeteKlasse?: DeviceClass;

    // @DataMember(Name="Limit")
    public Limit?: number;

    public constructor(init?: Partial<DeviceKind>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Article
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="Artikelnummer")
    public Artikelnummer: string;

    // @DataMember(Name="Bezeichnung")
    public Bezeichnung: string;

    // @DataMember(Name="Anmerkung")
    public Anmerkung: string;

    public constructor(init?: Partial<Article>) { (Object as any).assign(this, init); }
}

export enum CommunicationKind
{
    Telefon = 1,
    Mobil = 2,
    Fax = 3,
    EMail = 4,
    Web = 5,
}

// @DataContract
export class CommunicationFeature
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="Funktion")
    public Funktion: string;

    // @DataMember(Name="Typ")
    public Typ?: CommunicationKind;

    // @DataMember(Name="IstVorgegeben")
    public IstVorgegeben: boolean;

    // @DataMember(Name="Anmerkung")
    public Anmerkung: string;

    public constructor(init?: Partial<CommunicationFeature>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ReadingKind
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="Kurzbezeichnung")
    public Kurzbezeichnung: string;

    // @DataMember(Name="Langbezeichnung")
    public Langbezeichnung: string;

    public constructor(init?: Partial<ReadingKind>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AmwInfoKey
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="Key")
    public Key: number;

    // @DataMember(Name="Info")
    public Info: string;

    public constructor(init?: Partial<AmwInfoKey>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AdditionalArticle
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="Nummer")
    public Nummer: string;

    // @DataMember(Name="Bezeichnung")
    public Bezeichnung: string;

    // @DataMember(Name="Anmerkung")
    public Anmerkung: string;

    public constructor(init?: Partial<AdditionalArticle>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Room
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="Kurzbezeichnung")
    public Kurzbezeichnung: string;

    // @DataMember(Name="Bezeichnung")
    public Bezeichnung: string;

    public constructor(init?: Partial<Room>) { (Object as any).assign(this, init); }
}

export class GetStammdatenResponse
{
    // @DataMember(Name="StammdatenInfo")
    public StammdatenInfo: StammdatenInfo;

    // @DataMember(Name="GeraeteKatalog")
    public GeraeteKatalog: IList<DeviceCatalog>;

    // @DataMember(Name="Hersteller")
    public Hersteller: IList<Manufacturer>;

    // @DataMember(Name="Geraetetypen")
    public Geraetetypen: IList<DeviceKind>;

    // @DataMember(Name="Artikel")
    public Artikel: IList<Article>;

    // @DataMember(Name="KommunikationFunktionen")
    public KommunikationFunktionen: IList<CommunicationFeature>;

    // @DataMember(Name="Ablesearten")
    public Ablesearten: IList<ReadingKind>;

    // @DataMember(Name="Infoschluessel")
    public Infoschluessel: IList<AmwInfoKey>;

    // @DataMember(Name="Zusatzartikel")
    public Zusatzartikel: IList<AdditionalArticle>;

    // @DataMember(Name="Raeume")
    public Raeume: IList<Room>;

    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetStammdatenResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetStammdaten
{

    public constructor(init?: Partial<GetStammdaten>) { (Object as any).assign(this, init); }
}

TypeScript 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>