Versioning and compatibility

The Conigma SOAP API has two methods to check the version of the web service and its compatibility with the required version.

To ensure compatibility of the API methods as far as possible, all methods except the GET_API_VERSION and CHECK_COMPATIBILITY methods have a version suffix consisting of an underscore and a three-character version ID. In this way, if changes are incompatible, the version ID can be changed accordingly, so that the original version of the method is still available under the previous name with the previous functionality.

Determining the current version of the Conigma SOAP API

The current version of the Conigma SOAP API can be determined using the GET_API_VERSION method. This has an output parameter called API_VERSION of type STRING, which contains the current API version in the format [Major Version].[Minor Version].

Method: GET_API_VERSION

Parameters:

Direction	Name	Bloke	Description
Exporting	API_VERSION	STRING	Version of the installed API in format [Major Version].[Minor version]
Exception	NOT_AUTHORIZED		The user used does not have authorization to call the function.

Checking compatibility with the required version of the Conigma SOAP API

The CHECK_COMPATIBILITY method can be used to check whether the current version of the Conigma SOAP API is compatible with the required version. The required version must be passed to the method using the input parameter API_VERSION (type STRING). The return parameter IS_COMPATIBLE contains the compatibility status. Since the ABAP programming language does not support boolean values, a single character is returned according to ABAP conventions. If this contains the value 'X', it means True (i.e. compatibility), if it contains a space, this means that the current version of the Conigma SOAP API is not compatible with the required version of the Conigma SOAP API.

Method: CHECK_COMPATIBILITY