Page Comparison

Introduction

The Respax Operator Network (RON) XML API is the window into a real-time tour operator portal network connecting in real-time to major Australian and New Zealand tour operators. The Respax Operator Network enables development of interfaces to directly interact with each operator retrieving tour details with imagery, check availability, check prices and commit bookings directly into the remote operators system. For a more detailed overview of RON, please checkout the RON Introduction page to get started with your interface. You will need to register as a user on http://ron.respax.com.au. As part of the registration process, you will be sent an email with your user details.

...

Code Block

title	Live Database

https://ron.respax.com.au:30443/section/xmlrpc/server-ron.php?config=live

Contents

Table of Contents

API Overview

This XML-RPC (Extensible Markup Language - Remote Procedure Calling) API (Application Programming Interface) provides a simplified method to access a central database which in turn connects to multiple tour operator ResPax databases. The functions listed here allow a client application to view tour content as well as assemble the necessary information to commit a reservation into a host operator's database.

...

With the exception of ping, searchHost and searchKeyWord, the client must have successfully logged in using the login function before calling other functions. In addition, the session id returned by login must be appended to the server address as an additional request variable for these functions. Examples are provided below.

Nulls and Empty

...

Strings

Currently XML-RPC cannot represent null values. As a result, null values in the RON or operator databases are converted to empty strings. For the purposes of this API, any string field that contains an empty string should be considered an empty string. Any non string field that contains an empty string should be considered a null value.

Date Formats

Dates in the API can be passed as a string representation in the format dd-MMM-yyyy. For Example:

...

Note

week number and ordinal date formats are not supported

http://www.w3.org/TR/NOTE-datetime

http://en.wikipedia.org/wiki/ISO_8601

Passing dates in any other format may produce unexpected results.

YSN Fields Fields

Fields prefixed with ysn are legacy boolean variants. For such fields a value of 0 (zero) equates to False and a value of -1 (negative one) equates to True.

Training Mode

...

Mappings

To speed up development and testing, a set of generic mappings for each host are automatically in place when accessing the API in training mode. If you are seeing variations in results between live and training, keep in mind that you are using the generic test mappings in training mode and not mappings specific to your account.

...

Function Reference

ping

string ping ()

This simple test function returns the string "pong" if your xmlrpc call has been successful.

...

Code Block

theme	Confluence
language	xml

string(4) "pong"

...

login
Anchor
Login
Login

string login (string userid, string password, string distributor)

Validates the userid and password against the RON database. If the user is valid, associated globals in the server session are set and a string containing the session id variable name and value is returned. This string needs to be appended as an additional request variable to the server address for most subsequent function calls.

...

Code Block

language	xml

string(117) "https://ron.respax.com.au:30443/section/xmlrpc/server-ron.php?config=train&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e"

...

readCurrentLogin

array readCurrentLogin ()

Returns an array of two elements. The first element containing the details of the currently logged in user and the second element the details of the current user's organisation.

...

Field Name	Description
Organisation Update Fields
strReservations	Contact name for any reservations related communications.
strReservationsEmail	Email address for reservations.
strReservationsPhone	Phone number for reservations.
strTechnical	Contact name for any technical support related communications.
strTechnicalEmail	Email address for technical support.
strTechnicalPhone	Phone number for technical support.
strAccounts	Contact name for any accounts related communications.
strAccountsEmail	Email address for accounts.
strAccountsPhone	Phone number for accounts.

...

readCreditStatus

string readCreditStatus (string hostid)

Returns the credit status of the current user at the host specified.

...

readPaymentOptions
Anchor
readPaymentOptions
readPaymentOptions

array readPaymentOptions (string hostid)

Returns an array of zero or more associative arrays each representing a payment option that is valid for the currently logged in user at the host specified.

...

Field Name	Description	Type
Credit Card Type Fields
strCCTypeID	Unique identifier for the credit card type.	string(10)
strCCDesc	Description of the credit card type.	string(50)
dblWebCardFee	The processing fee charged by the host. This is a percentage applied to the amount being charged.	float

...

readHosts

array readHosts ()

Returns an array of associative arrays each containing the host id, name and a boolean value indicating the current state of the host.

...

Field Name	Description
Host Details Fields
strHostID	Unique identifier for the host.
strHostName	Host organisation's name.
boolServerUp	Flag to indicate if the host server is currently reachable.
boolOnline	Flag to indicate if the host configuration process is complete.
strConfigMode	Indicates if the host data was drawn from the live or train registrations.
strLocation	Approximate geographical location of the host.
strReservations	Name of reservations staff contact.
strReservationsEmail	Reservations email address.
strReservationsPhone	Reservations phone number.
strTechnical	Name of technical support contact.
strTechnicalEmail	Technical support email address.
strTechnicalPhone	Technical support phone number.
strAccounts	Name of accounts department contact.
strAccountsEmail	Accounts department email address.
strAccountsPhone	Accounts department phone number.
strHostType	Indicates whether the host takes live bookings or requests.
boolPOBCreditCard	deprecated
boolMandatoryOrigin	Host requires the pax origin field in reservations.
boolMandatorySource	Host requires the pax source field in reservations.
intCancellationOffset	Number of days prior to tour date that reservations for this host can be cancelled via this API. Note that other system rules may still prevent cancellations.
intMinimumTourDateOffset	Number of days prior to tour date that reservations for this host can be booked via this API. Note that resource expiries may still prevent new reservations.
strInterfaceVersion	Version of the API in use by the host.

...

readPaxTypes

array readPaxTypes (string hostid)

Returns an indexed array of associative arrays containing the pax type information for the host.

...

-32601: server error. method not found

...

readSources

array readSources (string hostid)

Returns an indexed array of associative arrays containing the pax source information for the host. This may be required by write Reservation for some hosts. See readHostDetails to determine if source is mandatory for a given host.

...

Code Block

language	xml

-32601: server error. method not found

...

readTours

array readTours (string hostid)

Returns an array of associative arrays each containing the tour code and tour name for all the publicly visible tours from the specified host.

...

Field Name	Description
Tour List Fields
strTourCode	Identifier for the tour record.
strTourName	Name of the tour.
boolAvailable	Indicator of tour availability. This does not mean there are seats, just that the tour is enabled and bookable.

...

readTourDetails

array readTourDetails (string hostid, string tourcode)

Returns an associative array of extended tour information from the host for the specified tour code.

...

Field Name	Description
Travel Terms Fields
strOrgID	Identifier for the organisation.
strOrgName	Name of the organisation enforcing the travel terms.
strTravelTerms	The terms and conditions for travel.

...

readTourWebDetails

array readTourWebDetails (string hostid, string tourcode, boolean images)

Returns an associative array of promotional and descriptive information for the tour. Due to the size of base 64 encoded images, you can optionally request that image information not be returned by sending false as the third parameter.

...

Field Name	Description
Tour Times Fields
intTourTimeID	Identifier for the tour time record.
strTourCode	Identifier for the tour.
dteTourTime	Associative array containing integer timestamp, scalar and ISO8601 formats for the time. The ISO8601 format is recommended for use in interfaces as the timestamp and scalar representations are now deprecated.
ysnIsReturnTrip(currently not supported)	Indicates if the departure time has a return trip.
ysnIsDefault	Indicates if the departure time is the default that should be offered up first to the client.
ysnActive	Indicates if the departure time is currently active. Inactive departure times should not be presented to the client.

...

readTourBases

array readTourBases (string hostid, string tourcode)

Returns an array of associative arrays from the host each containing the details of a fare basis and type for the specified tour. Only records where both ysnWebEnabledBasis and ysnWebEnabledSubBasis are true should be presented to the client. Bookings with disabled bases or subbases will be rejected by the host.

...

Field Name	Description
Tour Bases Fields
strTourCode	Identifier for the tour.
intBasisID	Identifier for the basis.
strBasisDesc	Short description of the basis.
strBasisDesc2	Long description of the basis.
ysnWebEnabledBasis	Indicates if the basis is enabled. Records with a disabled basis should not be presented to the client even if the subbasis is enabled.
intSubBasisID	Identifier for the subbasis.
strSubBasisDesc	Description of the subbasis.
ysnWebEnabledSubBasis	Indicates if the subbasis is enabled. Disabled subbases should not be presented to the client even if the basis is enabled.
intFixedNoPax	If this is not zero, the number of pax booked on the basis must be a multiple of this value. Generally only used for accommodations.
intDurationDays	Duration in days of Basis.

...

readTourPickups

array readTourPickups (string hostid, string tourcode, integer tourtimeid, integer basisid, string tourdate)

Returns an array of associative arrays from the host each containing the details of a pickup location and time for the specified tour, time and basis combination. Tour date is optional and if provided, the pickup list will be filtered by the operational bus routes for the day. Note that operational bus routes is a feature not yet supported by all hosts. If a host does not support operational bus routes the pickup list will not change when a tour date is provided.

...

readTourPrices
Anchor
readTourPrices
readTourPrices

array readTourPrices (string hostid, string tourcode, integer basisid, integer subbasisid, string tourdate, integer tourtimeid, integer pickupid, integer dropoffid)

Returns an associative array from the host containing price, levy and commission information for adult, child, infant, foc and udef pax types. If the tour sell value for a pax type is calculated as zero or the pax type assoc flag is false, that pax type should be disabled on the client. Pickup and dropoff ids are optional but should be provided if a pickup is selected in the booking.

...

Code Block

language	xml

array(   
	array(   
	"strHostID" => "AS",
	"strTourCode" => "WDWWMBWC",   
	"intBasisID" => 317,   
	"intSubBasisID" => 988,   
	"dteTourDate" => "21-Dec-2012",   
	"intTourTimeID" => 82,   
	"curAdultTourSell" => 575.00,   
	"curAdultTourLevy" => 25.00,   
	"curInfantTourSell" => 0.00,   
	"curInfantTourLevy" => 0.00,   
	"curChildTourSell" => 460.00,   
	"curChildTourLevy" => 25.00,   
	"curFOCTourSell" => 0.00,   
	"curFOCTourLevy" => 0.00,   
	"curUDef1TourSell" => 0.00,   
	"curUDef1TourLevy" => 0.00,   
	"strCurrencyType" => "AUD",   
	"strCurrencySymbol" => "$",   
	"strPaymentOption" => "comm-agent/bal-pob",   
	"dblAdultCommission" => 19.6667,   
	"dblInfantCommission" => 0.00,   
	"dblChildCommission" => 0.00,   
	"dblFOCCommission" => 0.00,   
	"dblUDef1Commission" => 0.00,   
	"boolAdultAssoc" => true,   
	"boolInfantAssoc" => false,   
	"boolChildAssoc" => true,   
	"boolFOCAssoc" => false,   
	"boolUDef1Assoc" => false   
),
array( 
	"strHostID" => "EC",   
	"strTourCode" => "BYDTWD",   
	"intBasisID" => 22342,   
	"intSubBasisID" => 4122,   
	"dteTourDate" => "21-Dec-2012",   
	"intTourTimeID" => 711,   
	"curAdultTourSell" => 0.00,   
	"curAdultTourLevy" => 0.00,   
	"curInfantTourSell" => 0.00,   
	"curInfantTourLevy" => 0.00,  
	"curChildTourSell" => 0.00,   
	"curChildTourLevy" => 0.00,   
	"curFOCTourSell" => 0.00,   
	"curFOCTourLevy" => 0.00,   
	"curUDef1TourSell" => 0.00,   
	"curUDef1TourLevy" => 0.00,   
	"strCurrencyType" => "AUD",   
	"strCurrencySymbol" => "$",   
	"strPaymentOption" => "comm-agent/bal-pob",   
	"dblAdultCommission" => 0.00,   
	"dblInfantCommission" => 0.00,   
	"dblChildCommission" => 0.00,   
	"dblFOCCommission" => 0.00,   
	"dblUDef1Commission" => 0.00,   
	"boolAdultAssoc" => false,   
	"boolInfantAssoc" => false,   
	"boolChildAssoc" => false,   
	"boolFOCAssoc" => false,   
	"boolUDef1Assoc" => false,   
	"faultCode" => 201,   
	"faultString" => "ERROR (server-ron) : ERROR (respax-external) : Specified basis does not exist."   
    )  
 )

...

readTourAvailability

integer readTourAvailability (string hostid, string tourcode, integer basisid, integer subbasisid, string tourdate, integer tourtimeid)

Returns an integer representing the number of places remaining on the specified trip.

...

checkReservation
Anchor
checkReservation
checkReservation

array checkReservation (string hostid, array reservation, array payment)

Runs a series of precommit checks on a reservation without attempting to commit. See writeReservation for the structure of the reservation and payment array parameters. Returns an array of errors in the reservation. An empty array means no errors were found in the precommit check.

...

checkReservationAndPrices

array checkReservationAndPrices (string hostid, array reservation, array payment)

This function accepts the exact same parameters as checkReservation

...

Code Block

language	xml

reservation = array(
    'strTourCode' => 'COBBER',
    'intBasisID' => 338,
    'intSubBasisID' => 677,
    'dteTourDate' => "31-OCT-2007",
    'intTourTimeID' => 144,
    'strPaxFirstName' => 'Wernher',
    'strPaxLastName' => 'von Braun',
    'strPaxEmail' => 'wernher@example.com',
    'intNoPax_Adults' => 1,
 )
 
 payment = array(
    'strPaymentOption' => 'full-agent'
 )
 results = api.checkReservationAndPrices('OZEX', reservation, payment)

Results

Code Block

language	xml

array(2) {   
	["arrCheckReservation"] => checkReservation result or fault   
	["arrReadTourPrices"] => readTourPrices result or fault  
 }

...

See readCreditCardTypes for each hosts' supported credit card types. Note that 'strCardTypeID' in this creditcard array is 'strCCTypeID' from readCreditCardTypes

...

writeCancellation

integer writeCancellation (string hostid, integer confirmation, string reason)

Cancels a reservation at the host with the specified confirmation number and updates the reservation with the cancellation reason. It returns the confirmation number if successful. A reservation must meet the following criteria to be able to be cancelled.

...

Versions Compared

Old Version 29

New Version 30

Key

API Overview

Nulls and Empty

Strings

Date Formats

YSN Fields Fields

Training Mode

Mappings

Function Reference

ping

login
Anchor
Login
Login

readCurrentLogin

readCreditStatus

readPaymentOptions
Anchor
readPaymentOptions
readPaymentOptions

readHosts

readPaxTypes

readSources

readTours

readTourDetails

readTourWebDetails

readTourBases

readTourPickups

readTourPrices
Anchor
readTourPrices
readTourPrices

readTourAvailability

checkReservation
Anchor
checkReservation
checkReservation

checkReservationAndPrices

writeCancellation

Page Comparison

Versions Compared

Old Version 29

New Version 30

Key

API Overview

Nulls and Empty

Strings

Date Formats

YSN Fields Fields

Training Mode

Mappings

Function Reference

ping

login AnchorLoginLogin

readCurrentLogin

readCreditStatus

readPaymentOptions AnchorreadPaymentOptionsreadPaymentOptions

readHosts

readPaxTypes

readSources

readTours

readTourDetails

readTourWebDetails

readTourBases

readTourPickups

readTourPrices AnchorreadTourPricesreadTourPrices

readTourAvailability

checkReservation AnchorcheckReservationcheckReservation

checkReservationAndPrices

writeCancellation

login
Anchor
Login
Login

readPaymentOptions
Anchor
readPaymentOptions
readPaymentOptions

readTourPrices
Anchor
readTourPrices
readTourPrices

checkReservation
Anchor
checkReservation
checkReservation