Server

<back to all web services

GetStammdaten

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/Stammdaten
GetStammdatenResponse Parameters:
NameParameterData TypeRequiredDescription
StammdatenInfoformStammdatenInfoNo
DeviceCatalogformIList<DeviceCatalog>No
ManufacturersformIList<Manufacturer>No
DeviceKindsformIList<DeviceKind>No
ArticlesformIList<Article>No
CommunicationFeaturesformIList<CommunicationFeature>No
ReadingKindsformIList<ReadingKind>No
AmwInfoKeysformIList<AmwInfoKey>No
AdditionalArticlesformIList<AdditionalArticle>No
RoomsformIList<Room>No
ResponseStatusformResponseStatusNo
StammdatenInfo Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
VersionformstringNo
NoteformstringNo
DeviceCatalog Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
ArticleNameformstringNo
ArticleNumberformstringNo
ArticleDescriptionformstringNo
ArticleNumberManufacturerformstringNo
LabelformstringNo
SubtractionformboolNo
HkvvformboolNo
RadioformboolNo
OrderCodeformstringNo
InstallationLengthformstringNo
ConnectorformstringNo
DiameterformstringNo
SontexRadioIdentifierformstringNo
SontexHkvIdentifierformstringNo
NoteformstringNo
DeviceKindGuidformGuidNo
ManufacturerGuidformGuidNo
Manufacturer Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
NameformstringNo
NoteformstringNo
DeviceKind Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LabelLongformstringNo
LabelShortformstringNo
ReadableformboolNo
ClassformDeviceClass?No
Limitformdecimal?No
DeviceClass Enum:
HKV
WWZ
KWZ
WZ
WMZ
KMZ
RM
SZ
FM
Sonstige
Null
ENT
Article Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
NumberformstringNo
LabelformstringNo
NoteformstringNo
CommunicationFeature Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
FeatureformstringNo
KindformCommunicationKind?No
IsPresetformboolNo
NoteformstringNo
CommunicationKind Enum:
NameValue
Telefon1
Mobil2
Fax3
EMail4
Web5
ReadingKind Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LabelShortformstringNo
LabelLongformstringNo
AmwInfoKey Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
KeyformintNo
InfoformstringNo
AdditionalArticle Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
NumberformstringNo
LabelformstringNo
NoteformstringNo
Room Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LabelShortformstringNo
LabelformstringNo

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: heat-syke-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>