Browse
 
Tools
Rss Categories

2. Client Side API Method Definitions (V3.1)

Reference Number: AA-01000 Views: 4921 Created: 2015-12-11 08:27 Last Updated: 2018-03-19 13:09 100 Rating/ 1 Voters

Responsive Version of Web Booking Module Client-Side Method Definitions

The client side methods are just a wrapper to manage the Server side API calls. This allows the developers to use only JavaScript in their web-pages to interact with our Server API.

The following is a listing of all of the methods that make up the Client-Side of the Responsive Web Booking Module. 

They are broken down into the following sections:

  • Main Methods
  • Setup Function Calls
  • Methods to Load Lists
  • Methods to Get a value
  • Methods for Data Management
  • Methods to set Customer field data
  • Methods to get Customer field data
  • Methods for System Information

                   

Main Methods                        

Name

Description
GetStep1   This method returns the data sets that contain the information to allow you to display the information in the initial/ first booking step, the Request step.
GetStep2
This method returns the data sets that contain all of the information required to display and process the information for the second booking step, the Vehicle Selection step.  
GetStep3
This method returns the data sets that contain the information required to display and process the information for the third booking step, the Extras step. 
MakeBooking
This method saves the booking details into the RCM system and returns a reservation + reference number.
MakePayment   This method saves the payment information coming back from the vault to the database. Data returned is all data except for the credit card number.  
ConfirmPayment  Method used for 3rd party payment solutions to store payment details. 
GetUser
This method gets user details for existing users so the user does not need to enter it all again.
GetURL   This method gets the URL to 3rd party fault which is used to load the vault page into an iframe.

 

GetStep1

Parameters

No parameters are required.

Result

4 datasets*

        • rcmLocationInfo
        • rcmOfficeTimes
        • rcmCategoryTypeInfo
        • rcmDriverAgesInfo
        • rcmHolidays

* (for dataset reference see article about RCM datasets)

 

GetStep2

Example

oAPI.GetStep2(

document.getElementById("CategoryTypeID").value,

document.getElementById("PickupLocationID").value,

document.getElementById("PickupDate").value,

document.getElementById("PickupTime").value,

document.getElementById("DropOffLocationID").

document.getElementById("ReturnDate").value,

document.getElementById("ReturnTime").value,

document.getElementById("Age").value,

document.getElementById("PromoCode").value,

getDetails

);


Parameters                                                                                                                                                                    

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  

category_type_id

  
  

Int

  
  

 

  
  

Yes

  
  

Category Type ID matching the ID in RCM system

  

pickup_location_id

  
  

Int

  
  

 

  
  

Yes

  
  

Location ID matches the ID of that location within RCM system  

  

pickup_location_date

  
  

String

  
  

10

  
  

Yes

  
  

Date string using next format: dd/mm/yyyy 


It is important that the European date format is used and not the American format, so day first and then month

  

pickup_location_time

  
  

String

  
  

5

  
  

Yes

  
  

Time string using the next format: HH:mm


It is important you use 24 hour time and not 12 hour time with am/ pm!

  

dropoff_location_id

  
  

Int

  
  

 

  
  

Yes

  
  

Location ID matches the ID of that location within RCM system  

  

dropoff_location_date

  
  

String

  
  

10

  
  

Yes

  
  

Date string using next format: dd/mm/yyyy 


It is important that the European date format is used and not the American format, so day first and then month
  

  

Dropoff_location_time

  
  

String

  
  

5

  
  

Yes

  
  

Time string using the next format: HH:mm


It is important you use 24 hour time and not 12 hour time with am/ pm!

  

age_id

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID for age used within RCM system not the actual age!

  

CampaignCode

  
  

String

  
  

10

  
  

No

  
  

Optional code that has to match campaign code setup within the RCM system, defaults to ‘-‘  

  

details_flag

  
  

Bit

  
  

 

  
  

No

  
  

Indicates if you wish to download the payment detail breakdown for   each day.
  0=no details (default)
  1=details
  

 

Result 

The following datasets*:

        • rcmLocationInfo
        • rcmOfficeTimes
        • rcmCategoryTypeInfo
        • rcmDriverAgesInfo
        • rcmLocationFees
        • rcmAvailableCarDetails – Optional depending on details flag being set to 1
        • rcmAvailableCars
        • rcmMandatoryFees
        • rcmHolidays

* (for dataset reference see chapter about RCM datasets)

 

GetStep3 

Parameters                                                                                                                                                                                

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

category_type_id

  
  

Int

  
  

 

  
  

Yes

  
  

Category Type ID matching the ID in RCM system  

  

pickup_location_id

  
  

Int

  
  

 

  
  

Yes

  
  

Location ID matches the ID of that location within RCM system  

  

pickup_location_date

  
  

String

  
  

10

  
  

Yes

  
  

Date string using next format: dd/mm/yyyy 


It is important that the European date format is used and not the American format, so day first and then month.
  

  

pickup_location_time

  
  

String

  
  

5

  
  

Yes

  
  

Time string using the next format: HH:mm


It is important you use 24 hour time and not 12 hour time with am/ pm!
 

  

dropoff_location_id

  
  

Int

  
  

 

  
  

Yes

  
  

Location ID matches the ID of that location within RCM system  

  

dropoff_location_date

  
  

String

  
  

10

  
  

Yes

  
  

Date string using next format: dd/mm/yyyy 


It is important that the European date format is used and not the American   format, so day first  and then month.
 

  

Dropoff_location_time

  
  

String

  
  

5

  
  

Yes

  
  

Time string using the next format: HH:mm


 It is important you use 24 hour time and not 12 hour time with am/ pm!
 

  

age_id

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID for age used within RCM system not the actual age!

  

Category_id

  
  

Int

  
  

 

  
  

Yes

  
  

Category ID matching the ID of the category in RCM system.  

  

CampaignCode

  
  

String

  
  

10

  
  

No

  
  

Optional code that has to match campaign code setup within the RCM   system, defaults to ‘-‘  

  

details_flag

  
  

Bit

  
  

 

  
  

No

  
  

Indicates if you wish to download the payment detail breakdown for   each day.
  0=no details (default)
  1=details
  

 

Result 

The following datasets:

        • rcmDriverAgesInfo
        • rcmLocationFees
        • rcmAvailableCarDetails
        • rcmAvailableCars
        • rcmRentalSource
        • rcmCountries
        • rcmAreaOfUse

 

The following three variables are returned but it is best to use the appropriate method to get the value:

        • rcmTaxInclusive
        • rcmTaxRate
        • rcmStateTax

 

MakeBooking 

Parameters                                                                                                                                                                                   

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

category_type_id

  
  

Int

  
  

 

  
  

Yes

  
  

Category Type ID matching the ID in RCM system  

  

pickup_location_id

  
  

Int

  
  

 

  
  

Yes

  
  

Location ID matches the ID of that location within RCM system  

  

pickup_location_date

  
  

String

  
  

10

  
  

Yes

  
  

Date string using next format: dd/mm/yyyy


It is important that the European date format is used and not the American format, so day first and then month.

  

pickup_location_time

  
  

String

  
  

5

  
  

Yes

  
  

Time string using the next format: HH:mm


It is important you use 24 hour time and not 12 hour time with am/ pm!
  

  

dropoff_location_id

  
  

Int

  
  

 

  
  

Yes

  
  

Location ID matches the ID of that location within RCM system

  

dropoff_location_date

  
  

String

  
  

10

  
  

Yes

  
  

Date string using next format: dd/mm/yyyy 


It is important that the European date format is used and not the American format, so day first  and then month.
  

  

Dropoff_location_time

  
  

String

  
  

5

  
  

Yes

  
  

Time string using the next format: HH:mm


It is important you use 24 hour time and not 12 hour time with am/ pm!

  

age_id

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID for age used within RCM system not the actual age!

  

Category_id

  
  

Int

  
  

 

  
  

Yes

  
  

Category ID matching the ID of the category in RCM system.  

  

Booking_type

  
  

Int

  
  

 

  
  

Yes

  
  

Indicates the type of booking Quote or actual booking
  1=quote
  2=booking
  

  

Referral_ID

  
  

Int

  
  

 

  
  

No

  
  

Referral_ID   is a numeric value that is used to identify an affiliate or the referrer to the Web-site to credit that affiliate with the booking  

 
  CampaignCode (PromoCode) 

 String 30    No   

The campaign/promo code that was entered by the customer when making the booking request.

This must be a valid campaign code within RCM.

 
AgentCode
 String  20  No

 

The Agent Code that was entered by the Agent when making the booking request.

This must be a valid Agent code within RCM.

 
AgentName
 String  20  No  

The Agent Name that was entered by the Agent when making the booking request.

 
RefNo
 String  50  No  This is the reference passed in by the Agent.
 sendemail Int    Int   Determines the functionality when it comes to sending email confirmations
 0 - No Email
 1 - Default Behaviour *
 2 - Always send email

 

 * Default Behaviour for Sending email confirmations

  • Quotes - The confirmation email gets sent when either the method Booking is successful or, in the case of an Agent booking, if the agent has been setup to receive emails.
  • Bookings - The confirmation email gets sent in the following circumstances, the payment/card collection has been successful, the Rental Car Company has been setup not to save cards, or in the case of an Agent booking,the agent has been setup to receive emails.
NOTE: This is only available in Web Booking Module V3.1
 
  AgentEmail

 String  50  No  

The Agent Email address that was entered by the Agent when making the booking request.

NOTE: This is only available in Web Booking Module V3.1

 

Result 

The following variables are returned:

        • rcmReservationRef     –          String variable (Random Unique String)
        • rcmReservationNo      –          Numeric variable (sequential booking number)  

MakePayment 

Parameters                                            

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Rcm_reference_no

  

 

  
  

String

  
  

30

  
  

Yes

  
  

The unique Reference Key for the current Booking/quote. The Reference Key expires within 30 minutes of the initiation of the booking.

  

Data

  
  

String

  
  

-

  
  

Yes

  
  

This is the data string returned from the Vault Supplier (3rd party)

 

Result 

The following variables are returned:

        • rcmPaymentSaved          –          Boolean value (true/false)


ConfirmPayment

This method is used for 3rd party payment solutions.

Parameters 

Element

Type

Size(Max)

Mandatory

Description

Rcm_reference_no

 

String

30

Yes

The unique Reference Key for the current Booking/quote. The Reference Key expires within 30  minutes of the initiation of the booking.

Amount

Currency

-

Yes

Amount for transaction

Success

Boolean

-

Yes

Indicates if transaction was successful

Payment Type

String

30

Yes

Describes 3rd party payment solution

Payment Date

Date

-

Yes

Date for payment using format: 

dd-MMM-yyyy eq 01-Jun-2016

Token Supplier ID

Int

-

No

ID that matches the Token supplier within the RCM system

Transaction Billing ID

String

50

No

Returns token for later rebilling in RCM

   DpsTxnRef

  String    16   No  Optional parameter that can identify
the transaction used when access
3rd party payment system

   CardHolderName 

  String    50   No  Shows the credit card holders name
   PaymentSource

  String    50   No Set the payment source,
eg DPS online payment, Visa

   CardNumber

  String   20   No Set the partial credit card number for the payment 
   CardExpiry

  String    20   No Set the credit cards expiry date
   TransType

  String   20   No Indicates whether the payment is a purchase or authorisation
   Merchant Fee ID   Int    -    No  Optional Additional merchant fee id that applies for this payment     

 

Result 

The following variables are returned:

<!--[if !supportLists]-->·      <!--[endif]-->rcmPaymentSaved           –          Boolean value (true/false)


Sample of complete call to method:

oAPI.ConfirmPayment(pRefNo, 
pAmount, 
pSuccess, 
pPaymentType, 
pPaymentDate, 
pTokenSupplierID, 
pTransactionBillingID, 
pDpsTxnRef, 
pCardHolderName, 
pPaymentSource, 
pCardNumber, 
pCardExpiry, 
pTransType, 
pMerchantFeeID)


Sample Javascript code:
<!--[if !supportLineBreakNewLine]-->
<!--[endif]-->

    function gotoConfirmation() {

      var tstResult = oAPI.CheckPaymentSaved();

      if (tstResult == true)

        document.getElementById("frmStep4").submit();

      else

        alert("Was not able to confirm payment");

    }

 

    function ConfirmPayment() {

        oAPI.OnPaymentDone(gotoConfirmation);

        oAPI.ConfirmPayment(

              document.getElementById("ReservationRef").value,

              document.getElementById("txtAmount").value,

              document.getElementById("txtSuccess").value,

              document.getElementById("txtPaymentType").value,

              document.getElementById("txtDate").value

           );

    }


The optional parameters are added to the data (hash64) string using ';' as separator. The syntax for the data string is now (copy sample from our JS file):

var pData = rcmBase64.encode(pAmount + ";"

                           + pSuccess + ";"

                           + pPaymentType + ";"

                           + pPaymentDate + ";"

                           + pTokenSupplierID + ";"

                           + pTransactionBillingID + ";"

                           + pDpsTxnRef + ";"

                           + pCardHolderName + ";"

                           + pPaymentSource + ";"

                           + pCardNumber + ";"

                           + pCardExpiry + ";"

                           + pTransType + ";"

                           + pMerchantFeeID "|"

                           + new Date().getTime()); 


GetBookingInfo

Example

oAPI.OnReadyGetBookingInfo(<JavaScript function to be called when call is done>);

oAPI.GetBookingInfo(<rcm_reservation_reference>);

Parameters

Element  Type  Size (Max)  Mandatory  Description 
rcm_reference_no String  30  Yes  The unique Reference Key for the current Booking/ quote. 

Returning Datasets

Specification of these dataset contents can be found here:  4. API Datasets 

  • rcmBookingInfo
  • rcmCustomerInfo
  • rcmCompanyInfo
  • rcmRateInfo
  • rcmExtraFees
  • rcmPaymentInfo
  • rcmAgentInfo
  • rcmErrors


Important!
 Always check the rcmErrors dataset first – if this is empty, it is safe to proceed.


EditBooking 

// Before making API call 'EditBooking' make sure that next items are set within the API

// - Optional Items,

// - Customer Data,

// - Insurance,

// - Extra KM

// - and Transmission Type (Default set to 0 --> No Preference)

//     0= No Preference, 1= Auto, 2= Manual

 

// Optional Items

// By not setting transmission type preference the system assumes --> No Preference

oAPI.SetTransmission(0);

oAPI.SetNewsletter(0);

 

// Mendatory Items

oAPI.OnBookingDone(GoToStep4);

oAPI.SetCustomerData(

...

);

 

oAPI.EditBooking(

document.getElementById("ReservationRef").value,

document.getElementById("PickupLocationID").value,

BookingType,

document.getElementById("refid").value

);


Result

The following variables are returned:

  • rcmReservationRef     –          String variable (Random Unique String)
  • rcmReservationNo      –          Numeric variable (sequential booking number)  


GetUser 

Parameters                                            

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Date_of_birth

  
  

String

  
  

10

  
  

Yes

  
  

Date string using next format: dd/mm/yyyy 


It is important that the European date format is used and not the American format, so day first and then month.

  

Email

  
  

String

  
  

50

  
  

Yes

  
  

This is the email address provided by the customer. It is important that there are no spaces in this.

 

Result

The following datasets:

        • rcmUserData

 

GetURL 

Parameters                                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Rcm_reference_no

  

 

  
  

String

  
  

30

  
  

Yes

  
  

The unique Reference Key for the current Booking/quote. The Reference Key expires within 30 minutes of the initiation of the booking.

  

objID

  
  

String

  
  

-

  
  

Yes

  
  

This is the HTML object ID of the iframe that needs to display vault page.


Client side call:

oAPI.OnReadyGetLocationDetails(<JavaScript function to be called when call is done>);

oAPI.GetLocationDetails(<locationid>);

Parameters

Element 

Type 

Size (Max) 

Mandatory 

Description 

locationid

INT 

-

Yes 

Location ID from RCM system for which to get the information.

 

Returning Datasets

Specification of these dataset contents can be found here:  4. API Datasets 

  • rcmLocationDetails 


Setup Function Calls                                                                 

  

Name

  
  

Description

  
  

OnReady

  
  

Method to assign a general function call to be used in case no other function are setup to be executed when the API completes a call

  

OnReadyStep1

  
  

Method to assign function to run on completion of step 1

  

OnReadyStep2

  
  

Method to assign function to run on completion of step 2

  

OnReadyStep3

  
  

Method to assign function to run on completion of step 3

  
  

OnBookingDone

  
  

Method to assign function to run on completion of saving booking data

  
  

OnPaymentDone

  
  

Method to assign function to run on completion of saving payment data

  
  

OnReadyGetUser

  
  

Method to assign function to run on completion of GetUser method

  
  

OnLocationChange

  
  

Method to assign function to run in case the API detects a location change

  
  

OnReadyGetURL

  
  

Method to assign function to run on completion of GetURL method

  
  

OnAlerts

  
  

Method to assign function to run in case an alert has been set by the API

 

OnReady

Parameters                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

fnCall

  
  

function

  
  

 

  
  

 

  
  

 

   

 

OnReadyStep1 

Parameters                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

fnCall

  
  

function

  
  

 

  
  

 

  
  

 

   


Example

oAPI.OnReadyStep1(DisplStep1);

function DisplStep1() {

// your code here

}

 

OnReadyStep2 

Parameters                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

fnCall

  
  

function

  
  

 

  
  

 

  
  

 

  

 

OnReadyStep3 

Parameters                               

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

fnCall

  
  

function

  
  

 

  
  

 

  
  

 

   

 

OnBookingDone 

Parameters                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

fnCall

  
  

function

  
  

 

  
  

 

  
  

 

  

 

OnPaymentDone

Parameters                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

fnCall

  
  

function

  
  

 

  
  

 

  
  

 

  

 

OnReadyGetUser 

Parameters                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

fnCall

  
  

function

  
  

 

  
  

 

  
  

 

  

 

OnLocationChange 

Parameters                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

fnCall

  
  

function

  
  

 

  
  

 

  
  

 

  

 

OnReadyGetURL 

Parameters                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

fnCall

  
  

function

  
  

 

  
  

 

  
  

 

  

 

OnAlerts 

Parameters                            

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

fnCall

  
  

function

  
  

 

  
  

 

  
  

 

  

 

 Methods to load Lists                                                     

  

Name

  
  

Description

  
  

LoadPickupList

  
  

This method will populate the drop down list for the Pick up location

  

LoadDropOffList

  
  

This method will populate the drop down list for the Drop off location

  
  

LoadLocationsList

  
  

This method will populate both the pick up and the drop off drop down lists.

  
  

LoadAgeList

  
  

This method will populate the drop down list for the Renter’s Age.

  
  

LoadRentalSource

  
  

This method will populate the drop down list for the Rental Source, also known as Found Us.

  
  

LoadAreaOfUse

  
  

This method will populate the drop down list for the Area of use.

  
  

LoadCategoryType

  
  

This method will populate the drop down list for the Category type

  
  

LoadCountries

  
  

This method will populate all of the drop down lists for countries

  

 

LoadPickupList 

Parameters                                                          

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

obj

  

HTML form element
 
  
  

 

  
  

Yes

  
  

Allows you to load pickup objects by ID or name

  

Pickup_location_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID of the location which will be displayed as the default location

  

Intro_Item

  
  

String

  
  

 

  
  

No

  
  

This is an optional field.

  

It contains the text that will appear in the select box before a location is chosen e.g., “Select a Pickup Location”  

 

LoadDropOffList 

Parameters

Element

Type

Size(Max)

Mandatory

Description

obj

HTML form element

 

Yes

Allows you load dropoff objects by ID or name. 

Dropoff_location_ID

Int

 

Yes

This is the ID of the location which will be displayed as the default location

Intro_Item

String

 

No

This is an optional field.

It contains the text that will appear in the select box before a location is chosen e.g., “Select a Dropoff Location”

                                                                             

LoadLocationsList 

Parameters                                                                                                                        

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

objPickUp

  
  

HTML form element

  
  

 

  
  

Yes

  
  

Allows you to load the pickup object by ID or name. 

  

objDropOff

  
  

HTML form element

  
  

 

  
  

Yes

  
  

Allows you to load the dropoff object by ID or name. 

  

objAge

  
  

HTML form element

  
  

 

  
  

Yes

  
Allows you verify age by ID or name. 
  

Pickup_location_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID of the location which will be displayed as the default location

  

DropOff_location_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID of the location which will be displayed as the default location

  

Intro_PickUp

  
  

String

  
  

 

  
  

No

  
  

This is an optional field.

It contains the text that will appear in the select box before a location is chosen e.g., “Select a Pickup Location”

  

Intro_DropOff

  
  

String

  
  

 

  
  

No

  
  

This is an optional field.

  

It contains the text that will appear in the select box before a location is chosen e.g., “Select a Dropoff Location”

 

LoadAgeList 

Parameters                                                           

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Obj

  
  

HTML form element

  
  

 

  
  

Yes

  
  

Allows you to load age object by ID or name. 

  

AgeID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID associated with the age that will be displayed as the default age.

  

Intro_Item

  
  

String

  
  

 

  
  

No

  
  

This is an optional field.

  

It contains the text that will appear in the select box before an age is chosen e.g., “Please enter the renter’s age”  

 

LoadRentalSource 

Parameters                                                                                     

Element

Type

Size(Max)

Mandatory

Description

obj

HTML object

 

Yes

This is the dataset that contains the list of available rental sources.

Rental_Source_ID

Int

 

Yes

This is the ID associated with the rental source that will be displayed as the default.

Intro_Item

String

 

No

This is an optional field.

It contains the text that will appear in the select box before a rental source is chosen e.g., “How did you find out about us?”

 

LoadAreaOfUse 

Parameters                                                                         

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Obj

  
  

HTML object

  
  

 

  
  

Yes

  
  

This is the dataset that contains the list of available rental sources.

  

Area_Of_Use_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID associated with the area of use that will be displayed as the default.  

  

Pickup_Location_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID associated with the pickup location. It is used to filter the available areas of use.  

  

Intro_Item

  
  

String

  
  

 

  
  

No

  
  

This is an optional field.

  

It contains the text that will appear in the select box before an area of use is chosen e.g., “Enter your area of use”  

 

LoadCategoryType 

Parameters                                                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Obj

  
  

HTML object

  
  

 

  
  

Yes

  
  

This is the dataset that contains the list of available category types

  

Category_type_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID associated with the category type that will be displayed as the default.  

  

Intro_Item

  
  

String

  
  

 

  
  

No

  
  

This is an optional field.

  

It contains the text that will appear in the select box before a Category type is chosen e.g., “Select a Category Type”  

 

LoadCountries 

Parameters                                                           

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Obj

  

HTML object
  
  

 

  
  

Yes

  
  

This is the dataset that contains the list of  countries  

  

Country_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID associated with the country that will be displayed as the default.  

  

Intro_Item

  
  

String

  
  

 

  
  

No

  
  

This is an optional field.

  

It contains the text that will appear in the select box before a country is chosen e.g., “Select a Country”  

 

 Methods to get a value                                                                                                     

  

Name

  
  

Description

  
  

GetNoticePeriod

  
  

This method will return the minimum time that is required   before a booking can be made at a location.

  

CheckLocationAvailable

  
  

This method will check to see if a location is available for booking, based upon any relocation information that has been setup within RCM.  

  

CheckCustomerDataOK

  
  

 

  
  

GetAge

  
  

This method returns the Age from the RCM system that corresponds to the Age ID passed into it. 

  

GetCountry

  
  

This method returns the country name from the RCM system that corresponds to the country ID passed into it.  

  

GetCategoryType

  
  

This method returns the Category Type name from the RCM system that corresponds to the Category_Type_ID passed into it.  

  

TaxInclusive

  
  

This method returns whether the RCM system has been setup to be Tax Inclusive or not.  

  

ReservationRef

  
  

This method returns the value for the reservation reference.  

  

ReservationNo

  
  

This method returns the value for the reservation number 

  

MinTimePickup

  
  

This method returns the earliest time a vehicle can be picked up for the location and weekday that was passed to it.  

  

MinTimeDropOff

  
  

This method returns the earliest time a vehicle can be dropped off for the location and weekday that was passed to it.  

  

MaxTimePickup

  
  

This method returns the latest time a vehicle can be picked up for the location and weekday that was passed to it.

  

MaxTimeDropOff

  
  

This method returns the latest time a vehicle can be dropped off for the location and weekday that was passed to it.  

  

MinBookingDay

  
  

This method returns the minimum number of days for the location that was passed to it.  

  

OfficeOpen

  
  

This method will pass back the opening time for the location and the weekday that has been passed to it.  

  

OfficeClose

  
  

This method will pass back the closing time for the location and the weekday that has been passed to it.  

 

GetNoticePeriod 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Pickup_Location_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID associated with the pickup location  

 

CheckLocationAvailable 

Parameters 

        • No parameters are needed

 

CheckCustomerDataOK 

Parameters

        • No parameters are needed

 

GetAge 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Age_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID associated with the age.

 

GetCountry 

Parameters                          

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Country_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID associated with the country

 

GetCategoryType 

Parameters                           

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Category_Type_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID associated with the Category Type.

 

TaxInclusive 

Parameters

        • No parameters are needed

 

ReservationRef 

Parameters

        • No parameters are needed

 

ReservationNo 

Parameters

        • No parameters are needed

 

MinTimePickup 

Parameters                                           

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Location_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID within RCM for the Location  

  

Day_of_week_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID for the day of the week, where Sunday is 1.  

 

MinTimeDropOff 

Parameters                                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Location_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID within RCM for the Location  

  

Day_of_week_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID for the day of the week, where Sunday is 1.  

 

MaxTimePickup 

Parameters                                            

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Location_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID within RCM for the Location  

  

Day_of_week_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID for the day of the week, where Sunday is 1.  

 

MaxTimeDropOff 

Parameters                                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Location_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID within RCM for the Location  

  

Day_of_week_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID for the day of the week, where Sunday is 1.  

 

MinBookingDay

Parameters                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Location_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID within RCM for the location  

 

OfficeOpen 

Parameters                                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Location_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID within RCM for the location  

  

Day_of_week_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID for the day of the week, where Sunday is 1.

 

OfficeClose 

Parameters                                          

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Location_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID within RCM for the location  

  

Day_of_week_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID for the day of the week, where Sunday is 1.  

 

 Methods for Data management                                                                                                                                    

  

Name

  
  

Description

  
  

AddToOptionalItems

  
  

This method will add the extra item passed to the booking.  

  

ClearOptionalItems

  
  

This method will clear out any option al extra items that have been saved against this booking.

  

GetOptionalItems

  
  

This method will return a listing of all of the available optional extra items in the format of a JSON string  

  

InitOptionalItems

  
  

This method allows the user to initialize the Optional items using a JSON string. String needs to be a valid JSON string and contain correct values.  

  

InitCustomerData

  
  

This method allows the user to initialise the Customer data using a JSON string. String needs to be a valid JSON string and contain correct values.  

  

SetCustomerData

  
  

This method will save the customer information.  

  

GetCustomerData

  
  

This method will return the customer information in the format of a JSON string  

  

ClearCustomerData

  
  

This method will clear out the customer information.

  

SetTransmission

  
  

This method will set the transmission preference.

  
  

SetInsurance

  
  

This method will set the insurance selected.

  
  

SetExtraKms

  
  

This method will set the Extra Kms option to what has been selected.

  

 

AddToOptionalItems 

Parameters                                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Optional_Item_Id

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID associated with the optional extra fee within RCM. 

  

Item_Qty

  
  

Int

  
  

 

  
  

Yes

  
  

This is the quantity required for the extra item  

 

ClearOptionalItems 

Parameters 

        • No parameters are needed

 

GetOptionalItems 

Parameters 

        • No parameters are needed

 

InitOptionalItems 

Parameters                            

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Item_String

  
  

String

  
  

 

  
  

Yes

  
  

This is a string which allows you to pass more than one extra fee at a time to be added.  

The string must be in the following format: {"id":id,"qty”:qty}    

 

InitCustomerData 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Customer_String

  
  

String

  
  

 

  
  

Yes

  
  

This is a string which allows you to pass all of the customer information at once to be saved.

  

The string must be in the following format:  

{"fnm":first_name,            

  

"lnm": Last_name,

  

"eml": email,

  

"phn": phone,

  

"mob": mobile,

  

"dob": date_of_birth,

  

"lcn": license_no,

  

"lci": licence_country,

  

"lce": licence_expiry,

  

"adr": address,

  

"cty": city,

  

"sta": state,

  

"pcd": postcode,

  

"cnt": country,

  

"fax": fax,

  

"fus": found_us,

  

"rmk": remarks,

  

"not": number_traveling,

  

"fln": flight,

  

"flo": flightout,

  

"flc": collection_point,

  

"flr": return_point,

  

"aru": area_of_use}

  

Country and licence_country must both be passed as the ID within RCM that is associated with the country.

  

Found_us must be passed as the ID within RCM that is associated with the rental_source.

  

Area_of_use must be passed as the ID within RCM that is associated with the Area of Use.

  

The format for the date fields is dd/mm/yyyy.

 

SetCustomerData                                                                                                                                                                                                                                                                                                                                                                   

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

First_name

  
  

String

  
  

 

  
  

Yes

  
  

This is the first name of the customer

  
  

Last_name

  
  

String

  
  

 

  
  

Yes

  
  

This is the last name of the customer

  
  

Email

  
  

String

  
  

 

  
  

 

  
  

This is the email address of the customer. It will need to be in a valid format, e.g., name@name.something

  

Phone

  
  

 

  
  

 

  
  

 

  
  

The phone number of the customer

  

Mobile

  
  

 

  
  

 

  
  

 

  
  

The mobile phone number of the customer

  

Date_of_birth

  
  

String

  
  

10

  
  

 

  
  

The customer’s date of birth. It must be in the format dd/mm/yyyy.

  

It is important that the European date format is used and not the American format, so day first  and then month  

  

Licence_no

  
  

Int

  
  

 

  
  

 

  
  

The licence number of the customer

  

Licence_country

  
  

Int

  
  

 

  
  

 

  
  

This is ID within RCM that is associated with the country entered as the licence country.  

  

Licence_expiry

  
  

String

  
  

10

  
  

 

  
  

The expiry date of the licence. It must be in the format dd/mm/yyyy.  

It is important that the European date format is used and not the American format, so day first and then month 

  

Address

  
  

String

  
  

 

  
  

 

  
  

The street address of the customer.

  

City

  
  

String

  
  

 

  
  

 

  
  

The customer’s city.

  
  

State

  
  

 

  
  

 

  
  

 

  
  

The customer’s state.

  
  

Postcode

  
  

 

  
  

 

  
  

 

  
  

The customer’s postcode.

  
  

Country

  
  

 

  
  

 

  
  

 

  
  

This is ID within RCM that is associated with the country entered as the customer’s country.

  

Fax

  
  

 

  
  

 

  
  

 

  
  

The customer’s fax number.

  
  

Found_us

  
  

 

  
  

 

  
  

 

  
  

The ID within RCM that is associated with the rental source entered by the customer.

  

Remarks

  
  

 

  
  

 

  
  

 

  
  

Any remarks entered by the customer.

  

Number_traveling

  
  

Int

  
  

 

  
  

 

  
  

The number of people travelling.

  

Flight_number

  
  

String

  
  

 

  
  

 

  
  

The arrival flight number if it has been entered by the customer.

  

Flight_out

  
  

 

  
  

 

  
  

 

  
  

The departure flight number if it has been entered by the customer.

  

Collection_point

  
  

 

  
  

 

  
  

 

  
  

The collection point entered by the customer.

  

Return_point

  
  

 

  
  

 

  
  

 

  
  

The return point entered by the customer.

  

Area_of_use

  
  

 

  
  

 

  
  

 

  
  

The ID within RCM that is associated with the Area of Use entered by the customer.

 

GetCustomerData 

Parameters

        • No parameters are needed

 

ClearCustomerData 

Parameters

        • No parameters are needed

 

SetTransmission 

Parameters                            

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Transmission_flag

  
  

Int

  
  

 

  
  

Yes

  
  

This is a   flag which states what the customer’s preference is for the transmission of   the vehicle.

  

It is passed in as an integer and has to be either 0,1, or 2.

  

0 = No Preference

1 = Auto

2 = Manual    

 

SetInsurance 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Insurance_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID that is associated with the insurance within RCM.

 

SetExtraKms 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

ExtraKm_ID

  
  

Int

  
  

 

  
  

Yes

  
  

This is the ID that is associated with the Extra Kms within RCM. 

 

Methods to set Customer field data                                                                                                                                                      

  

Name

  
  

Description

  
  

SetFirstName

  
  

This method saves the first name of the customer.

  
  

SetLastName

  
  

This method saves the last name of the customer.

  

SetEmail

  
  

This method saves the email address of the customer.

  
  

SetPhone

  
  

This method saves the phone number of the customer.

  
  

SetMobile

  
  

This method saves the mobile number of the customer.

  
  

SetDOB

  
  

This method saves the date of birth of the customer.

  
  

SetLicenseNo

  
  

This method saves the licence number of the customer.

  
  

SetLicenseIssuedIn

  
  

This method saves the country the licence was issued in for the customer.

  
  

SetLicenseExpires

  
  

This method saves the expiry date of the licence for the customer.

  
  

SetAddress

  
  

This method saves the street address of the customer.

  
  

SetCity

  
  

This method saves the city of the customer.

  
  

SetState

  
  

This method saves the state of the customer.

  
  

SetPostcode

  
  

This method saves the post code of the customer.

  
  

SetCountry

  
  

This method saves the country of the customer.

  
  

SetFax

  
  

This method saves the fax number of the customer.

  
  

SetFoundus

  
  

This method saves the rental source entered by the customer.

  
  

SetRemarks

  
  

This method saves the remarks entered by the customer.

  
  

SetNoTraveling

  
  

This method saves the number of people travelling.

  
  

SetFlightNo

  
  

This method saves the arrival flight number of the customer.

  
  

SetFlightNoOut

  
  

This method saves the departure flight number of the customer.

  
  

SetCollectionPoint

  
  

This method saves the collection point specified by the customer.

  
  

SetReturnPoint

  
  

This method saves the return point specified by the customer.

  
  

SetAreaOfUse

  
  

This method saves the area of use specified by the customer.

  
  

SetDateFormat

  
  

This method saves the dtae format for the customer.

  

 

SetFirstName

 

Parameters

 

                             
  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

First_name

  
  

String

  
  

 

  
  

 

  
  

This is the first name of the customer

  

 

SetLastName 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Last_name

  
  

String

  
  

 

  
  

 

  
  

This is the last name of the customer

 

SetEmail 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Email

  
  

String

  
  

 

  
  

 

  
  

This is the email address of the customer. It will need to be in a valid format, e.g., name@name.something

 

SetPhone 

Parameters                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Phone

  
  

String

  
  

 

  
  

 

  
  

This is the phone number of the customer

  

 

SetMobile 

Parameters                            

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Mobile_Number

  
  

String

  
  

 

  
  

 

  
  

This is the mobile phone of the customer

  

 

SetDOB 

Parameters                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Date   of Birth

  
  

String

  
  

10

  
  

 

  
  

The customer’s date of birth. It must be in the format dd/mm/yyyy.

  

It is important that the European date format is used and not the American format, so day first  and then month

 

SetLicenseNo 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Licence_no

  
  

String

  
  

 

  
  

 

  
  

This is the licence number of the customer

  

 

SetLicenseIssuedIn 

Parameters                             

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Licence_country

  
  

Int

  
  

 

  
  

 

  
  

This is ID within RCM that is associated with the country entered as the licence country.

 

SetLicenseExpires 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Licence_expiry

  
  

String

  
  

10

  
  

 

  
  

The expiry date of the   licence. It must be in the format dd/mm/yyyy.

  

It is important that the European date format is used and not the American format, so day first  and then month

 

SetAddress 

Parameters                              

  

Element

  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Address

  
  

String

  
  

 

  
  

 

  
  

The street address of the customer

 

SetCity 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

City

  
  

String

  
  

 

  
  

 

  
  

The city of the customer

  

 

SetState 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

State

  
  

String

  
  

 

  
  

 

  
  

The state of the customer

  

 

SetPostcode 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Post_code

  
  

String

  
  

 

  
  

 

  
  

The post code of the customer

  

 

SetCountry

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Country

  
  

Int

  
  

 

  
  

 

  
  

This is ID within RCM that is associated with the country entered as the customer’s country.

 

SetFax 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Fax_number

  
  

Int

  
  

 

  
  

 

  
  

This is the fax number of the customer

  

 

SetFoundUs 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Found_us

  
  

Int

  
  

 

  
  

 

  
  

The ID within RCM that is associated with the rental source entered by the customer.

 

SetRemarks 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Remarks

  
  

String

  
  

 

  
  

 

  
  

This is the remarks entered by the customer  

 

SetNoTraveling 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Number_travelling

  
  

Int

  
  

 

  
  

 

  
  

This is the number of people travelling.

  

 

SetFlightNo

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Flight_number

  
  

String

  
  

 

  
  

 

  
  

This is the arrival flight number

  

 

SetFlightNoOut 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Flight_out

  
  

String

  
  

 

  
  

 

  
  

This the is departure flight number

  

 

SetCollectionPoint 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Collection_point

  
  

String

  
  

 

  
  

 

  
  

The collection point entered by the customer.

  

 

SetReturnPoint 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Return_point

  
  

String

  
  

 

  
  

 

  
  

The return point entered by the customer

  

 

SetAreaOfUse 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Area_of_use

  
  

Int

  
  

 

  
  

 

  
  

The ID within RCM that is associated with the Area of Use entered by the customer.

 

SetDateFormat 

Parameters                              

  

Element

  
  

Type

  
  

Size(Max)

  
  

Mandatory

  
  

Description

  
  

Date_format

  
  

String

  
  

 

  
  

 

  
  

The date format to be used by the booking module.

  

The two valid options to be passed are : 'd/m/Y' or 'm/d/Y'

               

Methods to get Customer field data                                                                                                                                                                 

  

Name

  
  

Description

  
  

GetFirstName

  
  

This method returns the first name of the customer.

  
  

GetLastName

  
  

This method returns the last name of the customer.

  
  

GetEmail

  
  

This method returns the email address of the customer.

  
  

GetPhone

  
  

This method returns the phone number of the customer.

  
  

GetMobile

  
  

This method returns the mobile number of the customer.

  
  

GetDOB

  
  

This method returns the date of birth of the customer.

  
  

GetLicenseNo

  
  

This method returns the licence number of the customer.

  
  

GetLicenseIssuedIn

  
  

This method returns the country the licence was issued in for the customer.

  
  

GetLicenseExpires

  
  

This method returns the expiry date of the licence for the customer.

  
  

GetAddress

  
  

This method returns the street address of the customer.

  
  

GetCity

  
  

This method returns the city of the customer.

  
  

GetState

  
  

This method returns the state of the customer.

  
  

GetPostcode

  
  

This method returns the post code of the customer.

  
  

GetCountryID

  
  

This method returns the country of the customer.

  
  

GetFax

  
  

This method returns the fax number of the customer.

  
  

GetFoundusID

  
  

This method returns the rental source entered by the customer.

  
  

GetRemarks

  
  

This method returns the remarks entered by the customer.

  
  

GetNoTraveling

  
  

This method returns the number of people travelling.

  
  

GetFlightNo

  
  

This method returns the arrival flight number of the customer.

  
  

GetFlightNoOut

  
  

This method returns the departure flight number of the customer.

  
  

GetCollectionPoint

  
  

This method returns the collection point specified by the customer.

  
  

GetReturnPoint

  
  

This method returns the return point specified by the customer.

  
  

GetAreaOfUse

  
  

This method returns the area of use specified by the customer.

  
  

GetDateFormat

  
  

This method returns the date format for the customer.

  
  

GetTax

  
  

This method returns the tax rate for the customer.

  
  

GetStateTax

  
  

This method returns the state tax rate for the customer.

  

 

GetFirstName 

Parameters 

        • No parameters are needed

 

GetLastName 

Parameters

        • No parameters are needed

 

GetEmail 

Parameters 

        • No parameters are needed

 

GetPhone 

Parameters

        • No parameters are needed

 

GetMobile 

Parameters 

        • No parameters are needed

 

GetDOB 

Parameters 

        • No parameters are needed

 

GetLicenseNo 

Parameters 

        • No parameters are needed

 

GetLicenseIssuedIn 

Parameters

        • No parameters are needed

 

GetLicenseExpires 

Parameters 

        • No parameters are needed

 

GetAddress 

Parameters 

        • No parameters are needed

 

GetCity 

Parameters 

        • No parameters are needed

 

GetState 

Parameters 

        • No parameters are needed

 

GetPostcode 

Parameters

        • No parameters are needed

 

GetCountryID 

Parameters 

        • No parameters are needed

 

GetFax 

Parameters

        • No parameters are needed

 

GetFoundUsID 

Parameters 

        • No parameters are needed

 

GetRemarks 

Parameters 

        • No parameters are needed

 

GetNoTraveling 

Parameters

        • No parameters are needed

 

GetFlightNo 

Parameters

        • No parameters are needed

 

GetFlightNoOut 

Parameters 

        • No parameters are needed

 

GetCollectionPoint 

Parameters 

        • No parameters are needed

 

GetReturnPoint 

Parameters 

        • No parameters are needed

 

GetAreaOfUse 

Parameters 

        • No parameters are needed

 

GetDateFormat 

Parameters 

        • No parameters are needed

 

GetTax

 Parameters 

        • No parameters are needed

 

GetStateTax 

Parameters 

        • No parameters are needed

 

GetSession 

Parameters

        • No parameters are needed

 

 Methods for system info                            

  

Name

  
  

Description

  
  

DebugInfo

  
  

Gets rcmDebug info from system

  

Msg

  
  

Gets rcmMsg string from system

  
  

Error

  
  

Gets rcmError string from system

  
  

Version

  
  

Gets rcmMsg version number

  

 

DebugInfo 

Parameters 

        • No parameters are needed

 

Result

Debug info string

 

Msg 

Parameters 

        • No parameters are needed

 

Result

            Msg String


Error 

Parameters 

        • No parameters are needed

 

Result

            Error String

 

Version 

Parameters 

        • No parameters are needed

 

Result

            Version Number string