Top of GSFF Index Table of Contents Feedback

 

Web Services

For further insights to Web Services, see Maintain Web Service Configuration (GENF5000) and Maintain Web Service External Address Mapping (GENF5010).

Introduction

The intention of the Service Oriented Architecture is to utilise Web Services to provide integration between Callista and other 3rd party applications. This form is not meant to be exhaustive. Because of the background nature of Web Services, this document is only meant to give the user an overview of functions.

Note:

The Web Service (course) method update should be called with all corresponding parameters filled in. Do not attempt to call the update method with only the fields that have had changes made to them. This will result in data potentially being cleared from the Callista SMS database, because when a record is updated all the fields that are passed to the Web Service (as parameters) are updated in the database, even NULL fields. That is why it is important to populate the parameters for the Web Service even with fields that have had no changes made to them.

 

Document Description
Course - Insert/Update Courses

This method seeks to pass course and course version information from an external system into Callista.
This Web Service includes an Insert only indicator. If this indicator is set to Y, this function inserts the course and course version details.

If this indicator is set to N, this function checks if the course version currently exists based on the course code and version number. If it does exist this function updates the existing course version record. If the course version doesn’t exist a record is inserted into the course and course version tables.

When the record is being updated all values except the course code and version number fields are updated. Therefore, the call to this Web Service must pass through all values in every Web Service call.

All exceptions raised (i.e. table constraints, trigger validations) from the insert or update are returned as an exception to the Web Service and the changes are not committed. The Web Service then returns the exception to the Web Service initiator.
PersonAddress - Insert/Update Person Address

This Web Service shows two methods that allow an external system to access and modify person address information within Callista SMS. The two methods are:

  • Return person address records where the entered date (or current date if that is NULL) is equal to or between the person address start date and the person address end date (or the end date is null). All of these current addresses identified are returned irrespective of if they are the correspondence address or not.
  • Identify existing records with the same person ID and address type and alter the records, if no existing address records are found then insert a new record with the details provided.

This method follows existing Callista SMS address handling conventions, especially in terms of updating existing addresses (an address update will not actually update the records in the PERSON_ADDR table, but rather insert a new record and update the existing address records to close off their end-date or update their start date).

All exceptions raised (i.e. table constraints, trigger validations) from these two methods are returned as an exception to the Web Service and the changes are not committed. The Web Service then returns the exception to the Web Service initiator.
Unit - Insert/Update Units

This method passes unit and unit version information from an external system into Callista. This Web Service includes an Insert only indicator. If this indicator is set to Y, this function inserts the unit and unit version details.

If this indicator is set to N, this function checks if the unit version currently exists based on the unit code and version number. If it does exist it updates the existing unit version record to match the data passed into the Web Service. If the unit version doesn’t exist a record is inserted into the unit and unit version tables.

When the record is being updated all values except the unit code and version number fields are updated. Therefore, the call to this Web Service must pass through all values in every Web Service call.

All exceptions raised (i.e. table constraints, trigger validations) from the insert or update are returned as an exception to the Web Service and the changes arel not committed. The Web Service then returns the exception to the Web Service initiator.
UnitSet - Insert/Update Unit Sets

This method passes unit set information from an external system into Callista. This Web Service includes an Insert only indicator. If this indicator is set to Y, this function inserts the unit set details.

If this indicator is set to N, it checks if the unit set currently exists based on the unit set code and version number. If it does exist, it updates the existing unit set record. If the unit set doesn’t exist a record is inserted into the unit set table.

When the record is being updated all values except the unit set code and version number fields are updated. Therefore, the call to this Web Service should set all of the Web Service parameters with their corresponding values in the client system (even if they are NULL).

All exceptions raised (i.e. table constraints, trigger validations) from the insert or update are returned as an exception to the Web Service and the changes are not committed. The Web Service then returns the exception to the Web Service initiator.

 

 

Last Modified on 22 November, 2006

History Information

Release Version Project Change to Document
9.1.0.0.0.0 1264 - Service Oriented Architecture New form