Tools Add

Rental Car Manager Agent Web Service API

Reference Number: AA-00435 Views: 1814 Created: 2011-11-24 04:03 Last Updated: 2012-11-14 13:54

0 Rating/ Voters

In This Section

The RCM Agent Web Service
Web Service Methods

RCM Web Service Overview

Description

This web service is available to third party agents and brokers who wish to book vehicles via Rental Car Manager. The rental operator using Rental Car Manager must first provide the third party Agent or Broker with a valid authorization key. If you are an Agent or Broker please contact the rental operator directly if you require an authorization key.

Web Services

Name	Description
RCMAgentWS	This web service is available to authorised agents wishing to book vehicles directly into the rental operators system.

RCMAgentWS

Description

The URL for the web service will differ depending on the rental operators servers. The link below is provided for demostration purposes only.

URL : http://dev.rentalcarmanager.com.au/rcmagentws/

See Also

· Elements

Web Methods Summary.

Below is an overview of the methods available in this service. Note that a full description of these follow this summary.

No.	Web Method Name	Description
1	requestVehicleCategoryLocations	Web method to request the available pickup and dropoff locations and the category types of vehicles available.
2	requestVehicleAvailability	Web method to request for the available vehicle categories according to the category type selected in the previous method.
3	confirmVehicleSelection	Web method to confirm the vehicle category required. The method also returns country identifiers to be used when posting the customer information.
4	confirmVehicleBooking	Web method to confirm the booking and post customer details. Returns either a successful booking status or failure.

To use the Web Methods in the above table you must invoke them in the order listed in the table above.

The initial call to 'requestVehicleCategoryLocations' requires only the passing of the secure authorisation key. This key is supplied by the rental operator and is referred to in Rental Car Manager as the 'Company Key'.
The second call to 'requestVehicleAvailability' also requires a valid Agent Code which will be have been added in Rental Car Manager by the rental operator and provided to the agent wishing to use this web service. Also passed to this method are the identifiers for the required pickup and dropoff locations and vehicle type. This information was returned from the initial 'requestVehicleCategoryLocations' call. (see above). The information returned from this method includes the vehicle category identifiers available for booking based on the dates and locations requested. Also returned from this method is a transaction reference key (referred to in the documentation below as the 'refkey'). This key must be used for the final two calls and is valid for up to 30 minutes after which the transaction will expire and availability will need to be requested again.
The third method 'confirmVehiclSelection' listed in the table above recieves the vehicle category identifier the agent wishes to book and the 'refkey'. (see above for description of this) This information was returned by the method 'requestVehicleAvailability' - see above.
The final method 'confirmVehicleBooking' is the confirmation of the booking request. This inserts the booking into the rental operators system and returns a status indicating the success or failure of the request. This method takes the required customer information fields some of which are compulsory.

Note : There is no style content delivered in the XML. A sample program demonstrating the use of the service is available on request.

Element: uns: requestVehicleCategoryLocations

Description

Web Method to request the Available locations and the Category types of the Vehicle

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
uns:SecureKey	string	0..1	This is the Company Key (14 character alphanumeric) provided by the rental operator.

Example

<location>Brisbane Airport</location>

</PickupLocation>

<location>Brisbane City</location>

</PickupLocation>

<location>Sydney Airport</location>

</PickupLocation>

</PickUpLoc>

<location>Brisbane Airport</location>

</DropOffLocation>

<location>Brisbane City</location>

</DropOffLocation>

<location>Sydney Airport</location>

</DropOffLocation>

</DropOffLoc>

</vehicletype>

<categorytype>Truck</categorytype>

</vehicletype>

</CarType>

</CarTypeLocationDetails>

Element: uns: requestVehicleAvailability

Description

Web Method to request for the available vehicles according to the given data

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
uns:AgentCode	string	0..1	The Agent Code provided by the rental operator to the agent.
uns:AgentName	string	0..1	Name of the Agent
uns:EmailID	string	0..1	Email Id of the Agent
uns:PickupLoc	string	0..1	The preferred Pick-Up Location ID of the vehicle received during the previous web method call i.e. 'requestVehicleCategoryLocations'
uns:PickupDate	string	0..1	The Date of the Pick-Up of the Vehicle. Format MM/dd/yyyy
uns:PickupTime	string	0..1	The Time preferred of the Pick-Up of the Vehicle.Format HH:mm (24 hr Format)
uns:DropOffLoc	string	0..1	The preferred Drop-Off Location ID of the vehicle received during the previous web method call i.e. 'requestVehicleCategoryLocations'
uns:DropOffDate	string	0..1	The Date of the Drop-Off of the Vehicle. Format MM/dd/yyyy
uns:DropOffTime	string	0..1	The Time preferred of the Drop-Off of the Vehicle. Format HH:mm (24 hr Format)
uns:DriverAge	string	0..1	The Age of the person who would drive the vehicle
uns:CategoryTypeID	string	0..1	The category type ID of the vehicles, i.e Car, Truck ..etc. This was received from the previous method call. 'requestVehicleCategoryLocations'.
uns:SecureKey	string	0..1	The company key (14 character alphanumeric) provided by the rental operator.

Example

<RefKey>+AT2bc2mRkLd0spZ+A+sJFuSpm79KQIgd3KNCRlXAeA_</RefKey>

<LocationName>Brisbane Airport</LocationName>

</PickUpDetails>

<LocationName>Brisbane Airport</LocationName>

</DropOffDetails>

<VehicleName>GETZ MANUAL</VehicleName>

<VehicleImgLink>http://202.191.55.45/DB/RCMDemo7/smallcar_1.gif</VehicleImgLink>

<CarAvailable>Limited Availability</CarAvailable>

</NoOfCase>

</NoOfPerson>

<SeasonName>Standard Rates</SeasonName>

</EachSeason>

</Season>

</VehicleDetails>

<VehicleImgLink>http://202.191.55.45/DB/RCMDemo7/smallcar_1.gif</VehicleImgLink>

</NoOfCase>

</NoOfPerson>

<SeasonName>Standard Rates</SeasonName>

</EachSeason>

</Season>

</VehicleDetails>

</VehicleAvailable>

</ReqVehicleAvailable>

</RequestVehicleData>

Element: uns:confirmVehicleSelection

Description

Web Method to confirm the car type selected for the booking. Note that a AgentRefKey is also passed, this is not the 'Company Key'. This key was received from the previous method call 'requestVehicleAvailability' and is essentially a unique transaction key that must be passed in this call and the last method call. Data received from this call includes country information identifiers for the customer infomation required in the final method call.

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
uns:CarSizeID	string	0..1	The Car ID provided during the call to the web method 'requestVehicleAvailability'.
uns:AgentRefKey	string	0..1	The alphanumeric transaction reference key provided by the web service 'requestVehicleAvailability' while booking the vehicle

Example

<RefKey>+AT2bc2mRkLd0spZ+A+sJFuSpm79KQIgd3KNCRlXAeA_</RefKey>

<LocationName>Brisbane Airport</LocationName>

<Date>Thursday, 21/Sep/2011 10:00</Date>

</PickUpDetails>

<LocationName>Brisbane Airport</LocationName>

<Date>Wednesday, 27/Sep/2011 21:00</Date>

</DropOffDetails>

<VehicleName>GETZ MANUAL</VehicleName>

<VehicleImgLink>http://202.191.55.45/DB/RCMDemo7/smallcar_1.gif</VehicleImgLink>

</VehicleDetails>

<EachSeasonName>Standard Rates</EachSeasonName>

</EachSeason>

</Tax>

</TotalCharge>

<Name>Antarctica</Name>

</Country>

<Name>Argentina</Name>

</Country>

<Name>Australia</Name>

</Country>

<Name>Austria</Name>

</Country>

<Name>Azerbaijan</Name>

</Country>

<Name>Bangladesh</Name>

</Country>

</CountryListing>

</CarConfirm>

</CarConfirmDetails>

Element: uns: confirmVehicleBooking

Description

Final method call to confirm the booking request and receive either a succesful booking or a failure notification.

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
uns:CustomerFirstName	string	0..1	The First Name of the Customer
uns:CustomerLastName	string	0..1	The Last Name of the Customer
uns:CusCompanyID	string	0..1	The Company Identifier if the booking is from a company booking.
uns:Address	string	0..1	Customer Address
uns:City	string	0..1	Customer City
uns:State	string	0..1	The State where the Customer lives
uns:PostalCode	string	0..1	Postal Code/Zip code of the Customer
uns:CountryID	string	0..1	The country ID provided to you during to your previous call to the web method 'confirmVehicleSelection'
uns:CustomerEmailID	string	0..1	Email Id of the Customer
uns:Phone	string	0..1	Contact number of the Customer
uns:Facsimile	string	0..1	Fax number of the Customer
uns:NoOfTravelling	string	0..1	Number of person travelling
uns:OtherDetails	string	0..1	Any other detials that needs to be mentioned
uns:ReferenceNo	string	0..1	Optional transaction reference number normally a PO number or the Agent reference number
uns:AgentRefKey	string	0..1	The alphanumneric reference key provided by the web service method 'requestVehicleAvailability' while booking the vehicle.

Example

<RentalsName>gargi datta</RentalsName>

<RentalsAddress>100 Queens ST</RentalsAddress>

<RentalsCity>Samford</RentalsCity>

<RentalsCountry>Antarctica</RentalsCountry>

<RentalsEmailID>andrew.graeme@gmail.com</RentalsEmailID>

</CustomerDetails>

<VehicleType>GETZ MANUAL</VehicleType>

<LocationName>Brisbane Airport</LocationName>

<Date>Thursday, 21/Sep/2011 10:00</Date>

</PickUpDetails>

<LocationName>Brisbane Airport</LocationName>

<Date>Wednesday, 27/Sep/2011 21:00</Date>

</DropOffDetails>

</BookingDetails>

<Season>Standard Rates</Season>

</EachSeason>

</Season>

</Tax>

</TotalCharges>

</RatesNPayments>

</BookingRequestDetials>

</RequestBookingDetails>

Elements: RCMAgentWS

Elements

Name	Description
uns:Address [element confirmVehicleBooking]	Customer Address
uns:AgentCode [element requestVehicleAvailability]	The Agent Code setup by the rental operator and provided to the rental operator who wishes to use the service.
uns:AgentName [element requestVehicleAvailability]	Name of the agent making the booking.
uns:AgentRefKey [element confirmVehicleBooking]	An alphanumneric agent reference key provided by the web service while booking the vehicle. This is essentially a unique transaction reference key recieved from the method 'requestVehicleAvailability' and subequently passed to the final two method calls to validate and authorise the calls to the methods.
uns:AgentRefKey [element confirmVehicleSelection]	An alphanumneric agent reference key provided by the web service while booking the vehicle. This is essentially a unique transaction reference key recieved from the method 'requestVehicleAvailability' and subequently passed to the final two method calls to validate and authorise the calls to the methods.
uns:CarSizeID [element confirmVehicleSelection]	The vehicle category identifier provided during the call to the web method 'requestVehicleAvailability'.
uns:CarAvailable[element requestVehicleAvailability]	Indicates whether a vehicle is available.
uns:CategoryTypeID [element requestVehicleAvailability]	The category type of the vehicles, i.e Car. Truck.
uns:City [element confirmVehicleBooking]	Customers City
uns:CountryID [element confirmVehicleBooking]	The country ID provided by the call to the web method 'confirmVehicleSelection'
uns:CustomerEmailID [element confirmVehicleBooking]	Email address of the Customer
uns:CustomerFirstName [element confirmVehicleBooking]	The First Name of the Customer
uns:CustomerLastName [element confirmVehicleBooking]	The Last Name of the Customer
uns:CusCompanyID [element confirmVehicleBooking]	Optional : The company identifier the booking belongs to.
uns:DriverAge [element requestVehicleAvailability]	The Age of the person who would drive the vehicle
uns:DropOffDate [element requestVehicleAvailability]	The Drop-Off date. Format MM/dd/yyyy
uns:DropOffLoc [element requestVehicleAvailability]	The preferred Drop-Off Location ID of the location received by the web method call 'requestVehicleCategoryLocations'
uns:DropOffTime [element requestVehicleAvailability]	The Drop-Off time of the Vehicle. Format HH:mm (24 hr Format)
uns:EmailID [element requestVehicleAvailability]	Email address of the Agent
uns:Facsimile [element confirmVehicleBooking]	Fax number of the Customer
uns:NoOfTravelling [element confirmVehicleBooking]	Number of persons travelling
uns:OtherDetails [element confirmVehicleBooking]	Optional text.
uns:ReferenceNo [element confirmVehicleBooking]	Optional text, agent transaction number
uns:Phone [element confirmVehicleBooking]	Contact number of the Customer
uns:PickupDate [element requestVehicleAvailability]	The Pick-Up date. Format MM/dd/yyyy
uns:PickupLoc [element requestVehicleAvailability]	The preferred Pick-Up Location ID of the location received by the web method call i.e. 'requestVehicleCategoryLocations'
uns:PickupTime [element requestVehicleAvailability]	The Pick-Up time. Format HH:mm (24 hr Format)
uns:PostalCode [element confirmVehicleBooking]	Postal Code/Zip code of the Customer
uns:SecureKey [element requestVehicleAvailability]	The rental companies company key (14 character alphanumeric) provided by the rental operator. Required for web service authorisation.
uns:SecureKey [element requestVehicleCategoryLocations]	The rental companies company key (14 character alphanumeric) provided by the rental operator. Required for web service authorisation.
uns:State [element confirmVehicleBooking]	State of the Customer.

Element: uns:Address [element confirmVehicleBooking]

Description

Customer Address

Derived By

Type string

Referenced By

· Element uns:confirmVehicleBooking

Remarks

Optional

Example

A-20, Block C, R.K Road, Australia

Element: uns:AgentCode [element requestVehicleAvailability]

Description

The Agent Code provided by the rental operator.

Derived By

Type string

Referenced By

· Element uns:requestVehicleAvailability

Remarks

Mandatory

Example

GMHbris

Element: uns:AgentName [element requestVehicleAvailability]

Description

Name of the Agent

Derived By

Type string

Referenced By

· Element uns:requestVehicleAvailability

Remarks

Optional

Example

John Anderson

Element: uns:AgentRefKey [element confirmVehicleBooking]

Description

An alphanumneric transaction reference key returned by the web method 'requestVehicleAvailability'

Derived By

Type string

Referenced By

· Element uns:confirmVehicleBooking

Remarks

Mandatory

Example

dfdjfoiejmdlpihrewndscnmasdfoped_

Element: uns:AgentRefKey [element confirmVehicleSelection]

Description

An alphanumneric transaction reference key returned by the web method 'requestVehicleAvailability'

Derived By

Type string

Referenced By

· Element uns:confirmVehicleSelection

Remarks

Mandatory

Example

dfdjfoiejmdlpihrewndscnmasdfoped_

Element: uns:CarSizeID [element confirmVehicleSelection]

Description

The vehicle category identifier reruned by the web method 'requestVehicleAvailability'.

Derived By

Type string

Referenced By

· Element uns:confirmVehicleSelection

Remarks

Mandatory

Example

Element: uns:CarSizeID [element confirmVehicleSelection]

Description

The vehicle category identifier reruned by the web method 'requestVehicleAvailability'.

Derived By

Type string

Referenced By

· Element uns:confirmVehicleSelection

Remarks

Mandatory

Example

Element: uns:CategoryTypeID [element requestVehicleAvailability]

Description

The category type of the vehicles, i.e Car. Truck

Derived By

Type string

Referenced By

· Element uns:requestVehicleAvailability

Remarks

Mandatory

Example

Element: uns:City [element confirmVehicleBooking]

Description

Customer City

Derived By

Type string

Referenced By

· Element uns:confirmVehicleBooking

Remarks

Optional

Example

Description

The age of the person driving the vehicle

Derived By

Type string

Referenced By

· Element uns:requestVehicleAvailability

Remarks

Mandatory

Example

Element: uns:DropOffDate [element requestVehicleAvailability]

Description

The Drop-Off date. Format MM/dd/yyyy

Derived By

Type string

Referenced By

· Element uns:requestVehicleAvailability

Remarks

Mandatory

Example

03/24/2011

Description

The Pick-Up location identifier received returned from method call i.e. 'requestVehicleCategoryLocations'

Derived By

Type string

Referenced By

· Element uns:requestVehicleAvailability

Remarks

Mandatory

Example

Element: uns:PickupTime [element requestVehicleAvailability]

Description

The Pick-Up time. Format HH:mm (24 hr Format)

Derived By

Type string

Referenced By

· Element uns:requestVehicleAvailability

Remarks

Mandatory

Example

16:45

Element: uns:PostalCode [element confirmVehicleBooking]

Description

Customer postal code/zip code.

Derived By

Type string

Referenced By

· Element uns:confirmVehicleBooking

Remarks

Optional

Example

34567

Element: uns:SecureKey [element requestVehicleAvailability]

Description

Rental company authorisation key (14 character alphanumeric) provided by the rental operator to the agent using the web service.

Derived By

Type string

Referenced By

· Element uns:requestVehicleAvailability

Remarks

Madatory

Example

IyrslhvgrXcu9OfAe=

Element: uns:SecureKey [element requestVehicleCategoryLocations]

Description

Rental company authorisation key (14 character alphanumeric) provided by the rental operator to the agent using the web service.

Derived By

Type string

Referenced By

· Element uns:requestVehicleCategoryLocations

Remarks

Madatory

Example

IyrslhvgrXcu9OfAe=

Element: uns:State [element confirmVehicleBooking]

Description

The State where the Customer lives

Derived By

Type string

Referenced By

· Element uns:confirmVehicleBooking

Remarks

Optional

Example

Brisbane

Error Details

Error Code	Error Messages
001	Invalid Agent Code
002	Invalid Date Format for Pickup/DropOff Date. Format MM-dd-yyyy
003	Invalid Time Format for Pickup/DropOff Time. Format HH:mm
004	Return Date is earlier then Pick up date.
005	This location has a minimum renting age of <age> years.
006	Reservation requests made for <pickup location> must be made <min notice period > days or…prior to vehicle pick up.
007	The minimum Rental period for <pickup location> Internet booking is <minimum booking> days.
008	Minimum rental period for and booking is <days>…in details
009	Minimum rental period for and booking is <days>
010	One way booking not possible
011	Requested pickup date is unavailable
012	Requested DropOff date is unavailable
013	Pickup/DropOff Locatlion <PickupLocation>/<DropOffLocation> will not take bookings outside office hours(<PickupOfficeOpeningTime>/<DropOffOfficeOpeningTime> -<PickupOfficeClosingTime>/<DropOffOfficeClosingTime>).Please contact the bookings office directly.
014	Driver's Age cannot be empty
015	Pick up Location cannot be empty
016	Drop Off Location cannot be empty
017	Category type ID cannot be empty
018	Error:18. Please contact customer care in case you receive this error
019	Agent Code Cannot be blank
020	Minimum age to rent this category of vehicle is <age>
021	Invalid Reference Key or Session Timed Out.
022	First Name cannot be blank.
023	Last Name cannot be blank.
024	County ID cannot be blank
025	Email ID cannot be blank.
026	Invalid Email ID.
027	No of persons travelling cannot be blank or it should be a number.
028	Invalid Country ID
039	Reference Key cannot be blank
040	CarSizeID cannot be blank.
041	Invalid CarSizeID.
042	You must specify a valid email address of the Customer.
043	Invalid Secure Key

Back to Top

Comments

There are no comments for this article.

Add Comment

Ask a Question