Versioning Service Elements Across Personify APIs

Personify APIs and Personify Web Service Designer/Data Services follow their own independent release schedule and carry their own version labels. Any version of the Personify WSD and PDS will work with any version of Personify APIs 7.4.0 SP1 or higher. It is important to understand how the system handles the scenario when Data Service built against a higher version of APIs is running against a lower version of API. To be more specific, if there is a new Service Operation built against the latest version of APIs, it is consumed against a Data Service running against lower version of APIs.

For example, you upgraded your PDS to 1.3.0, but you’re still running on 7.4.0 SP1 version of APIs. In PDs 1.3.0, based delivered a new service operation called “RenewMembership”. This service operation “RenewMembership” may have been built against 7.4.1 APIs. Therefore, “RenewMembership” would work against 7.4.1 APIs and not against any lower versions of APIs. To consume the “RenewMembership” service operation, a new attribute called “Floor API Version” has been added to the Personify WSD at the element level. If the attribute “Floor API Version” were blank, it would work against any version of APIs; if not, it would work against only the specified or higher versions of APIs.

So, in this scenario, when “RenewMembership” service operation is consumed, the system raises a custom exception “PersonifyAPIVersionNotSupportedException”.