Server

<back to all web services

UpdateStammdaten

Requires Authentication
The following routes are available for this service:
POST/Stammdaten
"use strict";
export class UpdateStammdatenResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
}
export class StammdatenInfo {
    /** @param {{Guid?:string,Version?:string,Anmerkung?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    Version;
    /** @type {string} */
    Anmerkung;
}
export class DeviceCatalog {
    /** @param {{Guid?:string,ArtikelName?:string,ArtikelNummer?:string,ArtikelBeschreibung?:string,ArtikelnummerHersteller?:string,Kurzbezeichnung?:string,Abzug?:boolean,Hkvv?:boolean,Funk?:boolean,Bestellnummer?:string,Baulaenge?:string,Anschluss?:string,Qn?:string,SontexFunkID?:string,SontexHKVKennung?:string,Memo?:string,DeviceKindGuid?:string,ManufacturerGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    ArtikelName;
    /** @type {string} */
    ArtikelNummer;
    /** @type {string} */
    ArtikelBeschreibung;
    /** @type {string} */
    ArtikelnummerHersteller;
    /** @type {string} */
    Kurzbezeichnung;
    /** @type {boolean} */
    Abzug;
    /** @type {boolean} */
    Hkvv;
    /** @type {boolean} */
    Funk;
    /** @type {string} */
    Bestellnummer;
    /** @type {string} */
    Baulaenge;
    /** @type {string} */
    Anschluss;
    /** @type {string} */
    Qn;
    /** @type {string} */
    SontexFunkID;
    /** @type {string} */
    SontexHKVKennung;
    /** @type {string} */
    Memo;
    /** @type {string} */
    DeviceKindGuid;
    /** @type {string} */
    ManufacturerGuid;
}
export class Manufacturer {
    /** @param {{Guid?:string,Name?:string,Anmerkung?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    Name;
    /** @type {string} */
    Anmerkung;
}
/** @typedef {'HKV'|'WWZ'|'KWZ'|'WZ'|'WMZ'|'KMZ'|'RM'|'SZ'|'FM'|'Sonstige'|'Null'|'ENT'} */
export var DeviceClass;
(function (DeviceClass) {
    DeviceClass["HKV"] = "HKV"
    DeviceClass["WWZ"] = "WWZ"
    DeviceClass["KWZ"] = "KWZ"
    DeviceClass["WZ"] = "WZ"
    DeviceClass["WMZ"] = "WMZ"
    DeviceClass["KMZ"] = "KMZ"
    DeviceClass["RM"] = "RM"
    DeviceClass["SZ"] = "SZ"
    DeviceClass["FM"] = "FM"
    DeviceClass["Sonstige"] = "Sonstige"
    DeviceClass["Null"] = "Null"
    DeviceClass["ENT"] = "ENT"
})(DeviceClass || (DeviceClass = {}));
export class DeviceKind {
    /** @param {{Guid?:string,GeraeteTypLang?:string,GeraeteTypKurz?:string,Ablesbar?:boolean,GeraeteKlasse?:DeviceClass,Limit?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    GeraeteTypLang;
    /** @type {string} */
    GeraeteTypKurz;
    /** @type {boolean} */
    Ablesbar;
    /** @type {?DeviceClass} */
    GeraeteKlasse;
    /** @type {?number} */
    Limit;
}
export class Article {
    /** @param {{Guid?:string,Artikelnummer?:string,Bezeichnung?:string,Anmerkung?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    Artikelnummer;
    /** @type {string} */
    Bezeichnung;
    /** @type {string} */
    Anmerkung;
}
/** @typedef {number} */
export var CommunicationKind;
(function (CommunicationKind) {
    CommunicationKind[CommunicationKind["Telefon"] = 1] = "Telefon"
    CommunicationKind[CommunicationKind["Mobil"] = 2] = "Mobil"
    CommunicationKind[CommunicationKind["Fax"] = 3] = "Fax"
    CommunicationKind[CommunicationKind["EMail"] = 4] = "EMail"
    CommunicationKind[CommunicationKind["Web"] = 5] = "Web"
})(CommunicationKind || (CommunicationKind = {}));
export class CommunicationFeature {
    /** @param {{Guid?:string,Funktion?:string,Typ?:CommunicationKind,IstVorgegeben?:boolean,Anmerkung?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    Funktion;
    /** @type {?CommunicationKind} */
    Typ;
    /** @type {boolean} */
    IstVorgegeben;
    /** @type {string} */
    Anmerkung;
}
export class ReadingKind {
    /** @param {{Guid?:string,Kurzbezeichnung?:string,Langbezeichnung?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    Kurzbezeichnung;
    /** @type {string} */
    Langbezeichnung;
}
export class AmwInfoKey {
    /** @param {{Guid?:string,Key?:number,Info?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {number} */
    Key;
    /** @type {string} */
    Info;
}
export class AdditionalArticle {
    /** @param {{Guid?:string,Nummer?:string,Bezeichnung?:string,Anmerkung?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    Nummer;
    /** @type {string} */
    Bezeichnung;
    /** @type {string} */
    Anmerkung;
}
export class Room {
    /** @param {{Guid?:string,Kurzbezeichnung?:string,Bezeichnung?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    Kurzbezeichnung;
    /** @type {string} */
    Bezeichnung;
}
export class UpdateStammdaten {
    /** @param {{StammdatenInfo?:StammdatenInfo,GeraeteKatalog?:IList<DeviceCatalog>,Hersteller?:IList<Manufacturer>,Geraetetypen?:IList<DeviceKind>,Artikel?:IList<Article>,KommunikationFunktionen?:IList<CommunicationFeature>,Ablesearten?:IList<ReadingKind>,Infoschluessel?:IList<AmwInfoKey>,Zusatzartikel?:IList<AdditionalArticle>,Raeume?:IList<Room>}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {StammdatenInfo} */
    StammdatenInfo;
    /** @type {IList<DeviceCatalog>} */
    GeraeteKatalog;
    /** @type {IList<Manufacturer>} */
    Hersteller;
    /** @type {IList<DeviceKind>} */
    Geraetetypen;
    /** @type {IList<Article>} */
    Artikel;
    /** @type {IList<CommunicationFeature>} */
    KommunikationFunktionen;
    /** @type {IList<ReadingKind>} */
    Ablesearten;
    /** @type {IList<AmwInfoKey>} */
    Infoschluessel;
    /** @type {IList<AdditionalArticle>} */
    Zusatzartikel;
    /** @type {IList<Room>} */
    Raeume;
}

JavaScript UpdateStammdaten 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.

POST /Stammdaten HTTP/1.1 
Host: mi-waerme-servamw.eras-online.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateStammdaten xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2Client.Stammdaten">
  <Ablesearten xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <Artikel xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <GeraeteKatalog xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <Geraetetypen xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <Hersteller xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <Infoschluessel xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <KommunikationFunktionen xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <Raeume xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <StammdatenInfo>
    <Anmerkung>String</Anmerkung>
    <Guid>00000000-0000-0000-0000-000000000000</Guid>
    <Version>String</Version>
  </StammdatenInfo>
  <Zusatzartikel xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
</UpdateStammdaten>

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

<UpdateStammdatenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2Client.Stammdaten">
  <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>
</UpdateStammdatenResponse>