Global Matrix API

Documentation

 

 

How to use the Web Booking API:

 

When making a web reference to the Global Matrix Web Booking API using the URL specified below, two web service methods are exposed and will be available for the calling client. These methods are described below.

 

 

 

 

 

Web Booking API Methods:

 

  1. authenticate() – This method is responsible in authenticating the supplied user information against the Global Matrix Security database. Only valid Matrix user is allowed to continue in processing an XML booking record.

 

Input parameters: authenticate – this is a complex type, named authenticate, which encapsulates the userid and password information. Both userid and password is of type string.

                       

Output parameters: authenticateResponse – this is a complex type, named authenticateResponse, which encapsulates the securityToken of type string, and its content is in XML format. This will need to be persistent in the client system, and it needs to be passed on for each call to the processXML web service method.

 

  1. processXML() – TThis method is responsible for processing the XML booking record. This XML booking record must conform to the Global Matrix Booking XML Schema. Successful or not, this method will return a response of type string in XML format. Please click here to see the Global Matrix Response XML Schema for complete details of its structure and layout.

 

Input parameters: processXML – this is a complex type, named processXML, which encapsulates the securityToken, xmlBookingRecord and the xmlBookingResponse. All three data elements are of type string, having XML format content. Each of these parameters instances must conform to their respective XML Schema.

                       

Output parameters: processXMLResponse – this is a complex type, named processXMLResponse, which encapsulates the xmlBookingResponse of type string. It’s content is in XML format, adhering to the Global Matrix Response XML Schema.

 

For the xmlBookingRecord parameter, it must conform to the Global Matrix Booking XML Schema. Please click here for complete details of its schema.

 

For the xmlBookingResponse parameter, it must conform to the Global Matrix Response XML Schema. Please click here for complete details of schema.

 

 

Please note, the securityToken, xmlBookingRecord and the xmlBookingResponse cannot have a null value when they are being passed to the Global Matrix Web Booking API. For instance, when a the processXML web method is called for the first time for a given booking, please ensure that the xmlBookingResponse has spaces or has a zero length string value. The xmlBookingResponse is the response that was returned to the client from the most recent previous call of the processXML method. Sending back the xmlBookingResponse when making a new call to the processXML method informs the API that the new request is a correction to a problem that took place from the previous call.

 

 

Code Snippets For Calling Global Matrix Web Booking API:

 

Below is a code snippet for calling the Global Matrix Web BookingAPI.