CarRentalAgentService. Method

Retrieves the available weekend specials if any.

public WeekendSpecialsResponse (
WeekendSpecialsRequest request
);

Parameters

WeekendSpecialsRequest: A WeekendSpecialsRequest containing the necessary reference data.

Return Value

A WeekendSpecialsResponse containing the desired information.

Remarks

Due to the fact, that weekend specials are special offers with restrictions, they are not delivered by GetRates - Method. Weekend specials are available in a defined timeframe, that is mostly from thursday(or friday) till sunday(or monday). So if a customer likes to rent a car within this timeframe your booking-module should call the GetWeekendSpecials - Method to request these special offers. Sometimes it's useful to know whether there are weekend specials or not, to display some kind of Message, asking the user if he likes to see the available weekend specials. The IsWeekendSpecialAvailable - Method was designed for this purpose.

You will have to specify the departure and arrival Locations or Regions and there's a major difference in using both entities.

If you're using Locations as departure and arrival, this method will return you the vehicles and rates for given departure location.

In contrast, if you're using Regions as departure and arrival, this method will return you the best choices of vehicles and rates based on the locations assigned to the given departure region. This "Regional Rate Query" - or "Best Offer" rate calculation - is probably one of the most exciting features of this Web Service. You can find an in-depth discussion of both calculation schemes in the "CarRentalAgentService SDK - Reference Manual".

Note
Depending on which calculation scheme you are using, the overall car rental process changes significantly. Consider this when designing your client implementation of this Web Service.

Attention:
Neither the GetWeekendSpecials - Method nor the above mentioned IsWeekendSpecialAvailable - Method take care about the time-portion of given departure and arrival. Due to the fact, that each weekend special has its own validity period it is not possible to take the time portion into account without a significant loss on performance. Furthermore it may not be worthwhile to keep a weekend special back from the user, because of a choosen departure date-time that is to early in terms of time-portion, not date-portion. The validation of time-portion has to be done for each weekend special separately, which may be done at a detail-page, after the user has selected a weekend special. It's recommended to use the ValidateWeekendSpecial - Method to do this.

List Of defined call-variants

parameters	GetWeekendSpecialsP1	GetWeekendSpecialsP2	GetWeekendSpecialsP3	GetWeekendSpecialsP4
token	required	required	required	required
departureDate	required	required	required	required
arrivalDate	required	required	required	required
departureRegionId	required	required	not applicable	not applicable
arrivalRegionId	optional	optional	not applicable	not applicable
departureLocationId	not applicable	not applicable	required	required
arrivalLocationId	not applicable	not applicable	optional	optional
fleetNumber	optional	optional	not applicable	not applicable
currencyCode	optional	optional	optional	optional
promotionCode	optional	optional	optional	optional
bestPriceOnly	not applicable	optional	not applicable	optional

Description :	Returns all weekend specials, available within the specified timeframe at the Locations of the given departure Region. Thereby it is possible to filter the results by Fleet.	Returns all weekend specials, available within the specified timeframe at the Locations of the given departure Region. Thereby it is possible to filter the results by Fleet. Additionally its possible to request solely the most reasonably priced offer, if it's not possible to display all weekend specials in your booking module.	Returns all weekend specials, available within the specified timeframe at the given departure Location.	Returns all weekend specials, available within the specified timeframe at the given departure Location. Additionally its possible to request solely the most reasonably priced offer, if it's not possible to display all weekend specials in your booking module.

List Of Errors Returned

Error Code	Description
E_ARRIVAL_DATE_TIME_TOO_EARLY	The given arrival date / time is too early. This error occurs if: The date / time is in past relative to departure date / time.
E_DEPARTURE_DATE_TIME_TOO_EARLY	The given departure date / time is too early. This error occurs if: The date / time is in past relative to tomorrow.
E_XML_DATETIME_FORMAT	This error occurs if one of the DateTime-Values has an invalid format. The values have to be ISO 8601 formatted date and time strings. For detailed information about date-time format please refer to the description of the property mentioned in CausingField.
E_DATE_TIME_INVALID	This error occurs if one of the DateTime-Values has an invalid format, even if the format seems to be okay at the first view. The database hasn't identified a real formatting issue, but wasn't able to convert the string into a DateTime value nevertheless. For detailed information about date-time format please refer to the description of the property mentioned in CausingField.
E_DEPARTURE_PLACE_NOT_SET	Neither the DepartureRegionId nor the DepartureLocationId was set in request-parameters.
E_ID_INVALID	One of the id's handed over in DepartureRegionId, DepartureLocationId, ArrivalRegionId or ArrivalLocationId isn't known by the system.
E_PARAMETER_REQUIRED	A required parameter was missing in the performed request. For detailed information please refer to the description of the property mentioned in CausingField.
E_PROMOTION_CODE_INVALID	The given PromotionCode is not valid.
E_BOOKING_LEADTIME	The timespan between the booking date and the given DepartureDate is to short to be handled by our automatic booking system.
E_SUBSIDIARY_CLOSED	The timespan between the booking date and the given DepartureDate is to short to be handled by our automatic booking system, because the subsidiary is closed during this timeframe.

List Of Warnings Returned

Warning Code	Description
W_CURRENCY_CODE_INVALID	The requested currency code is not known by the system. Using default currency instead.
W_CURRENCY_NOT_SUPPORTED	The requested currency code is not supported. Using default currency instead.