Versionierung und Kompatibilität

Die Conigma SOAP API besitzt zwei Methoden, mit deren Hilfe die Version des Webservices sowie die Kompatibilität mit der benötigten Version überprüft werden kann.

Um die Kompatibilität der API Methoden so weit wie möglich sicherzustellen besitzen alle Methoden mit Ausnahme der Methoden GET_API_VERSION und CHECK_COMPATIBILITY einen Versionssuffix bestehend aus einem Unterstrich und einer dreistelligen Versionskennung. Auf diese Art und Weise kann bei inkompatiblen Änderungen die Versionskennung entsprechend verändert werden, so dass die Ursprüngliche Version der Methode weiterhin unter dem bisherigen Namen mit der bisherigen Funktionalität zur Verfügung steht.

Ermittlung der aktuellen Version der Conigma SOAP API

Die aktuelle Version der Conigma SOAP API kann mit Hilfe der Methode GET_API_VERSION ermittelt werden. Diese besitzt einen Ausgabeparameter namens API_VERSION vom Typ STRING, welcher die aktuelle API Version im Format [Major Version].[Minor Version] zurück liefert.

Methode: GET_API_VERSION

Parameter:

Richtung	Name	Typ	Beschreibung
Exporting	API_VERSION	STRING	Version der installierten API im Format [Major Version].[Minor Version]
Exception	NOT_AUTHORIZED		Der verwendete Benutzer besitzt keine Berechtigung zum Aufruf der Funktion.

Überprüfen der Kompatibilität mit der benötigten Version der Conigma SOAP API

Mit Hilfe der Methode CHECK_COMPATIBILITY kann überprüft werden ob die aktuelle Version der Conigma SOAP API mit der benötigten Version kompatibel ist. Hierfür muss die benötigte Version durch den Eingabeparameter API_VERSION (Typ STRING) an die Methode übergeben werden. Der Rückgabeparameter IS_COMPATIBLE enthält den Kompatibilitätsstatus. Da die Programmiersprache ABAP keine booleschen Werte unterstützt wird gemäß der in ABAP geltenden Konventionen ein einzelnes Zeichen zurück geliefert. Enthält dieses den Wert 'X', so bedeutet die True (also Kompatibilität), enthält dieses ein Leerzeichen, so bedeutet das, dass die aktuell vorhandene Version der Conigma SOAP API nicht mit der geforderten Version der Conigma SOAP API kompatibel ist.

Methode: CHECK_COMPATIBILITY