MBCS_Referenz_Extern
Beschreibung des ASMX-Webservices MBCS_Referenz_Extern für den Abruf der MultiBaseCS-Referenzlisten.
URL des Webservices:
https://service.34u.de/MBCS_Referenz_Extern.asmx
Mit diesem Webservice rufen Sie die MultiBaseCS-Referenzlisten ab, zum Beispiel um sie in eigenen Anwendungen aktuell zu halten. Bei jedem Aufruf übergeben Sie die Kennung Ihrer Anwendung (GUID_Application).
Neben den unten beschriebenen Funktionen bietet der Webservice weitere, zum Beispiel für die Ortssuche (Ortssuche_GetOrte, Ortssuche_NearestName). Eine Übersicht aller Funktionen zeigt die Adresse des Webservices im Browser.
Funktionen
CheckApplication
| Beschreibung | Gibt den Status an, ob es sich um eine gültige Applikation handelt. |
| Argumente | GUID_Application: Schlüssel für die aufrufende Anwendung |
| Rückgabewerte | True: Applikation ist gültig False: Applikation ist nicht gültig |
GetCount
| Beschreibung | Gibt die Anzahl der neuen Zeilen mit neueren Referenzdatenbeständen für eine Referenztabelle zurück. Es werden alle Daten gezählt, die eine höhere ID_Version als LastIDVersion oder bei gleicher ID_Version eine höhere ID_Value als LastIDValue aufweisen. |
| Argumente | GUID_Application: Schlüssel für die aufrufende Anwendung TableName: Tabellenname der Referenztabelle LastIDVersion: Höchste bisher vorhandene ID_Version aller Datensätze in der Referenztabelle LastIDValue: Höchste bisher vorhandene ID_Value aller Datensätze in der Referenztabelle mit der höchsten bisher vorhandenen ID_Version |
| Hinweise | Sind bisher keine Datensätze in der Referenztabelle vorhanden, müssen für LastIDVersion und LastIDValue die Werte 0 übergeben werden. Die Werte aus ID_Value müssen aus dem ID-Feld der Referenztabelle entnommen werden. Die entsprechenden Informationen lassen sich über den Aufruf von GetReferenzTables ermitteln. |
| Rückgabewerte | Anzahl der Zeilen mit neueren Referenzdatenbeständen. |
GetDataFromIDList
| Beschreibung | Gibt Datenzeilen für eine Referenztabelle zurück. Es werden alle Datenzeilen zurückgegeben, die im jeweiligen ID-Feld der Referenztabelle einen der Werte aus IDValueList aufweisen. IDValueList enthält die Werte als kommaseparierte Liste. |
| Argumente | GUID_Application: Schlüssel für die aufrufende Anwendung TableName: Tabellenname der Referenztabelle IDValueList: Kommaseparierte Liste mit Werten aus dem ID-Feld der Referenztabelle |
| Hinweise | Die Werte aus IDValueList müssen aus dem ID-Feld der Referenztabelle entnommen werden. Die entsprechenden Informationen lassen sich über den Aufruf von GetReferenzTables ermitteln. |
| Rückgabewerte | System.Data.Dataset mit einer System.Data.DataTable mit den angeforderten Werten. |
GetDataFromIDList_JSON
| Beschreibung | Gibt Datenzeilen für eine Referenztabelle als JSON-String zurück. Es werden alle Datenzeilen zurückgegeben, die im jeweiligen ID-Feld der Referenztabelle einen der Werte aus IDValueList aufweisen. IDValueList enthält die Werte als kommaseparierte Liste. |
| Argumente | GUID_Application: Schlüssel für die aufrufende Anwendung TableName: Tabellenname der Referenztabelle IDValueList: Kommaseparierte Liste mit Werten aus dem ID-Feld der Referenztabelle |
| Hinweise | Die Werte aus IDValueList müssen aus dem ID-Feld der Referenztabelle entnommen werden. Die entsprechenden Informationen lassen sich über den Aufruf von GetReferenzTables ermitteln. |
| Rückgabewerte | JSON-String mit den angeforderten Werten. |
GetDataFromIDVersion
| Beschreibung | Gibt Datenzeilen für eine Referenztabelle zurück. Es werden alle Daten zurückgegeben, die eine höhere ID_Version als LastIDVersion oder bei gleicher ID_Version eine höhere ID_Value als LastIDValue aufweisen. CountItems gibt die Anzahl der maximal zurückzugebenden Elemente an. |
| Argumente | GUID_Application: Schlüssel für die aufrufende Anwendung TableName: Tabellenname der Referenztabelle LastIDVersion: Höchste bisher vorhandene ID_Version aller Datensätze in der Referenztabelle LastIDValue: Höchste bisher vorhandene ID_Value aller Datensätze in der Referenztabelle mit der höchsten bisher vorhandenen ID_Version CountItems: Anzahl der zu übermittelnden Datenzeilen |
| Hinweise | Sind bisher keine Datensätze in der Referenztabelle vorhanden, müssen für LastIDVersion und LastIDValue die Werte 0 übergeben werden. Die Werte aus ID_Value müssen aus dem ID-Feld der Referenztabelle entnommen werden. Die entsprechenden Informationen lassen sich über den Aufruf von GetReferenzTables ermitteln. Die Datensätze werden sortiert nach ID_Version und ID_Value zurückgegeben. Für den kompletten Download des Referenzdatenbestandes einer Referenztabelle sind in Abhängigkeit der Anzahl der neuen Datenzeilen und CountItems mehrere Aufrufe dieser Schnittstelle nötig. |
| Rückgabewerte | System.Data.Dataset mit einer System.Data.DataTable mit den angeforderten Werten. |
GetIDFromValue
| Beschreibung | Gibt eine gültige MultiBaseCS-Referenz ID für einen Textwert zurück. Kann für den übergebenen Wert keine ID ermittelt werden, wird der Wert 0 zurückgegeben. |
| Argumente | GUID_Application: Schlüssel für die aufrufende Anwendung TableName: Tabellenname der Referenztabelle Value: Zu prüfender Textwert ID_Kategorie: ID_Kategorie der Beobachtung ID_Modul: ID_Modul der Beobachtung |
| Hinweise | Der Referenzwert wird durch Übereinstimmung mit einem textlichen Feld der Referenztabelle ermittelt. Bei mehreren übereinstimmenden Werten wird eine kommaseparierte Liste zurückgegeben. Das Feld ID_Kategorie dient bei der Abfrage der “tblArten” zur Einschränkung der Suche auf eine bestimmte Kategorie. Bei anderen Referenztabellen wird das Feld ID_Kategorie zur Prüfung der Gültigkeit herangezogen. Wird der Wert ID_Kategorie für eine Tabelle mit einer Kategorieeinschränkung mit 0 übergeben, wird als Result ebenfalls 0 zurückgegeben. Der Wert ID_Modul kann übergeben werden, um Referenzwerte mit einer Modulgültigkeit abzufragen. In diesem Fall wird der Wert in ID_Kategorie ignoriert. |
| Rückgabewerte | String mit einem oder mehreren Refrenz-IDs. |
GetDataFromIDVersion_JSON
| Beschreibung | Gibt Datenzeilen für eine Referenztabelle als JSON-String zurück. Es werden alle Daten zurückgegeben, die eine höhere ID_Version als LastIDVersion oder bei gleicher ID_Version eine höhere ID_Value als LastIDValue aufweisen. CountItems gibt die Anzahl der maximal zurückzugebenden Elemente an. |
| Argumente | GUID_Application: Schlüssel für die aufrufende Anwendung TableName: Tabellenname der Referenztabelle LastIDVersion: Höchste bisher vorhandene ID_Version aller Datensätze in der Referenztabelle LastIDValue: Höchste bisher vorhandene ID_Value aller Datensätze in der Referenztabelle mit der höchsten bisher vorhandenen ID_Version CountItems: Anzahl der zu übermittelnden Datenzeilen |
| Hinweise | Sind bisher keine Datensätze in der Referenztabelle vorhanden, müssen für LastIDVersion und LastIDValue die Werte 0 übergeben werden. Die Werte aus ID_Value müssen aus dem ID-Feld der Referenztabelle entnommen werden. Die entsprechenden Informationen lassen sich über den Aufruf von GetReferenzTables ermitteln. Die Datensätze werden sortiert nach ID_Version und ID_Value zurückgegeben. Für den kompletten Download des Referenzdatenbestandes einer Referenztabelle sind in Abhängigkeit der Anzahl der neuen Datenzeilen und CountItems mehrere Aufrufe dieser Schnittstelle nötig. |
| Rückgabewerte | System.Data.Dataset mit einer System.Data.DataTable mit den angeforderten Werten. |
GetReferenzTables
| Beschreibung | Gibt eine Liste von gültigen Referenztabellen zurück. |
| Argumente | GUID_Application: Schlüssel für die aufrufende Anwendung |
| Rückgabewerte | System.Data.Dataset mit einer System.Data.DataTable mit den angeforderten Werten. |
GetReferenzTables_JSON
| Beschreibung | Gibt eine Liste von gültigen Referenztabellen als JSON-String zurück. |
| Argumente | GUID_Application: Schlüssel für die aufrufende Anwendung |
| Rückgabewerte | System.Data.Dataset mit einer System.Data.DataTable mit den angeforderten Werten. |