• ron api

RON XML API Reference

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

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 and the link you will be using to develop and interface between your system and RON.

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.

Example function calls are provided in a syntax compatible with the php XML-RPC EPI implementation of the XML-RPC protocol. Refer to the documentation with your prefered implementation for details on assembling an XML-RPC request.

XML-RPC Home
http://www.xmlrpc.com/

XML-RPC EPI @ SourceForge
http://xmlrpc-epi.sourceforge.net/

Database records are returned as associative arrays where the field name maps on to the field value. Anywhere that an example result refers to a record (eg web details record) refer to the fields table for a list of all field names and a description of their values. When writing new reservations or updating existing reservations, assemble a record as an associative array using the reservations fields table as a guide.

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.

Index

• ping

• login

• readCurrentLogin

• readCreditStatus

• readPaymentOptions

• readHosts

• readHostDetails

• readTours

• readTourDetails

• readTourWebDetails

• readTourTimes

• readTourBases

• readTourPickups

• readTourPrices

• readTourAvailability

• readTourAvailabilityRange

• writeReservation

• writeCancellation

---

ping

string ping ()

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

Example

 $results = xu_rpc_http_concise(array(
    "method" => "ping",
    "args" => array(),
    "host" => $host,
    "uri" => $uri,
    "port" => $port
));

Results

 string(4) "pong"

---

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.

Optionally you can pass a distributor id with the login details. This will look up the equivalent agent in each operator's database and set that as the current agent instead of the agent associated with the login details.

NOTE! Distributor mappings are only functional in the live environment.

Example

 $results = xu_rpc_http_concise(array(
    "method" => "login",
    "args" => array("albert", "password"),
    "host" => $host,
    "uri" => $uri,
    "port" => $port
));

Results

 string(42) "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.

Example

 $results = xu_rpc_http_concise(array(
    "method" => "readCurrentLogin",
    "args" => array(),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
 ));

Results

 array(2) {
    ["arrCurrentUser"] => current user record,
    ["arrCurrentOrganisation"] => current organisation record
 }

Current User Fields

Current Organisation Fields

---

readCreditStatus

string readCreditStatus (string hostid)

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

Example

$results = xu_rpc_http_concise(array(
    "method" => "readTourAvailabilityRange",
    "args" => array("KIWIEX"),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
));

Results

 string(3) "dep"

Credit Statuses

---

readPaymentOptions

array readPaymentOptions ()

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

Example

 $results = xu_rpc_http_concise(array(
    "method" => "readPaymentOptions",
    "args" => array(),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
 ));

Results

 array(n) {
    [0] => payment option record,
    ...
    [n-1] => payment option record
 }

Payment Option Fields

---

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.

Example

$results = xu_rpc_http_concise(array(
    "method" => "readCurrentLogin",
    "args" => array(),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
));

Results

array(n) {
    [0] => host record
     ...
    [n-1] => host record
}

Host List Fields

About Host Status

There are two flags that must be enabled for tour content to be available. The flag boolServerUp indicates if the physical machine responded to the most recent attempt to contact it. The flag boolOnline is set by a RON administrator once the host has completed all the steps necessary to publish their tour content successfully. Function calls to any host with boolOnline disabled should be avoided as the results may not be valid.

---

readHostDetails

array readHostDetails (string hostid)

Returns an associative array of extended information for the host including contact information.

Example

$results = xu_rpc_http_concise(array(
    "method" => "readHostDetails",
    "args" => array("TW"),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
));

Results

host details record

Host Details Fields

---

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.

Example

$results = xu_rpc_http_concise(array(
    "method" => "readTours",
    "args" => array("ATA"),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
));

Results

array(n) {
    [0] => tour list record
     ...
    [n-1] => tour list record
}

Tour List Fields

---

readTourDetails

array readTourDetails (string hostid, string tourcode)

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

Example

$results = xu_rpc_http_concise(array(
    "method" => "readTourDetails",
    "args" => array("OZEX", "BRUCE"),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
));

Results

tour details record

Tour Details Fields

---

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.

Example

$results = xu_rpc_http_concise(array(
    "method" => "readTourWebDetails",
    "args" => array("KIWIEX", "FULLMONTY", true),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
));

Results

tour web details record

Tour Web Details Fields

---

readTourTimes

array readTourTimes (string hostid, string tourcode)

Returns an array of associative arrays from the host each containing the details of a departure time for the specified tour.

Example

$results = xu_rpc_http_concise(array(
    "method" => "readTourTimes",
    "args" => array("RT", "ATR"),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
));

Results

array(n) {
    [0] => tour time record
     ...
    [n-1] => tour time record
}

Tour Times Fields

---

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.

Example

$results = xu_rpc_http_concise(array(
    "method" => "readTourBases",
    "args" => array("KIWIEX", "FULLMONTY"),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
));

Results

array(n) {
    [0] => tour basis record
     ...
    [n-1] => tour basis record
}

Tour Bases Fields

---

readTourPickups

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

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.

To uniquely and correctly identify a pickup, you must specify the pickup route code, pickup time id and pickup id. The recommended method of doing this is to use the strPickupKey field when selecting a pickup and when writing a reservation.

Example

$results = xu_rpc_http_concise(array(
    "method" => "readTourPickups",
    "args" => array("RT", "BUNGY", 137, 744),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
));

Results

array(n) {
    [0] => tour pickup record
     ...
    [n-1] => tour pickup record
}

Tour Pickups Fields

---

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.

Example

$results = xu_rpc_http_concise(array(
    "method" => "readTourPrices",
    "args" => array("ATA", "AR3", 423, 1542, "31-AUG-2008", 57),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
));

Results

array(29) {
    ["curAdultTourSell"] => float(227)
    ["curAdultTourLevy"] => float(10)
    ["curChildTourSell"] => float(187)
    ["curChildTourLevy"] => float(10)
    ["curInfantTourSell"] => float(187)
    ["curInfantTourLevy"] => float(10)
    ["curFOCTourSell"] => float(0)
    ["curFOCTourLevy"] => float(0)
    ["curUDef1TourSell"] => float(0)
    ["curUDef1TourLevy"] => float(0)
    ["dblAdultCommission"] => float(18.75)
    ["dblChildCommission"] => float(12.75)
    ["dblInfantCommission"] => float(12.75)
    ["dblFOCCommission"]=> float(0)
    ["dblUDef1Commission"]=> float(0)
    ["curDeposit"] => float(0)
    ["curBookingFee"] => float(0)
    ["curCardFee"] => float(0)
    ["curPayOnBoard"] => float(0)
    ["curTourLevy"] => float(0)
    ["curTotal"] => float(0)
    ["strCurrencyType"] => string(3) "AUD"
    ["strCurrencySymbol"] => string(1) "$"
    ["strPaymentOption"] => string(6) "credit"
    ["boolAdultAssoc"] => bool(true)
    ["boolChildAssoc"] => bool(true)
    ["boolInfantAssoc"] => bool(true)
    ["boolFOCAssoc"] => bool(false)
    ["boolUDef1Assoc"] => bool(false)
}

Tour Prices Fields

---

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.

Example

$results = xu_rpc_http_concise(array(
    "method" => "readTourAvailability",
    "args" => array("KIWIEX", "DOGLEG", 317, 988, "15-JUN-2007", 82),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
));

Results

int(14)

---

readTourAvailabilityRange

array readTourAvailabilityRange (array productList)

Returns an array with availability integer for each product specified in parameter array. The function accepts a list of multiple product across multiple hosts and returns the same list with the availability attached.

Example

$results = xu_rpc_http_concise(array(
    "method" => "readTourAvailabilityRange",
    "args" => array( array(
        array("strHostID" => "KIWIEX",
              "strTourCode" => "DOGLEG",
              "intBasisID" => 317,
              "intSubBasisID" => 988,
              "dteTourDate" => "15-JUN-2007",
              "intTourTimeID" => 82
        ),
        array("strHostID" => "RT",
              "strTourCode" => "ATR",
              "intBasisID" => 12342,
              "intSubBasisID" => 2122,
              "dteTourDate" => "01-AUG-2007",
              "intTourTimeID" => 31
        )
    )),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
));

Results

    array(
array("strHostID" => "KIWIEX",
"strTourCode" => "DOGLEG",
"intBasisID" => 317,
"intSubBasisID" => 988,
"dteTourDate" => "15-JUN-2007",
"intTourTimeID" => 82,
"intAvailability" => 102
),
array("strHostID" => "RT",
"strTourCode" => "ATR",
"intBasisID" => 12342,
"intSubBasisID" => 2122,
"dteTourDate" => "15-JUN-2007",
"intTourTimeID" => 31,
"intAvailability" => 14
)
)

---

writeReservation

integer writeReservation (string hostid, int confirmation, array reservation, array payment)

• Sends the details of the reservations array to the host and returns a confirmation number if the reservation is successfully committed. Provide the specific confirmation number to update an existing reservation or a confirmation number of -1 to create a new reservation.

When updating an existing reservation, it is only necessary to add the altered fields to the reservations array. Fields that are to remain unchanged do not need to be provided to the function.

The previous system of writing pickups by manually providing strPickupRouteCode, intPickupRouteTimeID and intPickupID has been replaced with a single field strPickupKey. To specify that the reservation has no pickup you can do one of 4 things:

1. Do not provide the strPickupKey field.
2. Set strPickupKey field to null.
3. Set strPickupKey field to an empty string.
4. Set strPickupKey field to the string value 0:0:0.

All these options assume you are no longer passing the individual pickup related fields.

Payment defines how much money you are collecting in the booking. Payment options available to you when booking is determined by your Credit status with each operator. Credit Status can be either Full Payment or Deposit only. If you are trying to collect Full amount when you are a Deposit only agent, it will return an error. As a Full Credit agent, you will have a choice of collecting full or deposit only payments.

Example

$reservation = array(
    "strTourCode" => "COBBER",
    "intBasisID" => 338,
    "intSubBasisID" => 1477,
    "dteTourDate" => "31-OCT-2007",
    "intTourTimeID" => 144,
    "strPaxFirstName" => "Wernher",
    "strPaxLastName" => "von Braun",
    "strPaxEmail" => "wernher@example.com",
    "intNoPax_Adults" => 2,
    "strGeneralComment" => "Alergic to ginger toupees."
);
 
$payment = array(
    "strPaymentOption" => "agent"
);

$results = xu_rpc_http_concise(array(
    "method" => "writeReservation",
    "args" => array("OZEX", -1, $reservation, $payment),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
));

Results

int(69777)

Reservations Fields

Payment Options

---

writeCancellation

boolean 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 cofirmation number if successful.

Example

$results = xu_rpc_http_concise(array(
    "method" => "writeCancellation",
    "args" => array("OZEX", 69777, "Pax suffered a spleen injury."),
    "host" => $host,
    "uri" => $uri."&PHPSESSID=1bea4b6a9491805f986ad14389a1a25e",
    "port" => $port
));

Results

int(69777)