Documentation of the CarRentalAgentService

CarRentalAgentService. Method 

Checks whether the formerly requested weekend special identified by the ValidateWeekendSpecialRequest is valid for the given timeframe.

public ValidateWeekendSpecialResponse (
   ValidateWeekendSpecialRequest request
);

Parameters

ValidateWeekendSpecialRequest
A ValidateWeekendSpecialRequest containing the necessary reference data.

Return Value

A ValidateWeekendSpecialResponse containing the desired information.

Remarks

Attention:
This method is the only method of the weekend-special feature, that takes the time-portion of given departure and arrival into account. So the main cause to use this function is, to check whether or not the given rental-timeframe is fully covered by the validity period of the weekend special identified by the given parameters.

This method allows you to validate a weekend special, that has been requested before by a call to GetWeekendSpecials - Method. This will be very useful if the same weekend special should be displayed, but one of the following parameters, used to initially request the weekend special is changed by the user:

Therefore this functionality should be used by booking modules at the offer detail page shown after the user has selected a weekend special.

List Of defined call-variants

parameters ValidateWeekendSpecialP1 ValidateWeekendSpecialP2
token required required
departureDateTime required required
arrivalDateTime required required
departureRegionId required not applicable
arrivalRegionId required not applicable
departureLocationId not applicable required
arrivalLocationId not applicable required
currencyCode optional optional
salesSeasonId required required
vehicleId required required
promotionCode optional optional



Description : Validates the given weekend special at the given Region, which means that there's at least one Location where the weekend special is bookable if validation was succesful (see: IsValid). Validates the given weekend special at the given Location, which means that the weekend special is bookable at the given Location if validation was succesful (see: IsValid).

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_SALES_SEASON_INVALID The given SalesSeasonId is not knwon by the database, the SalesSeasonId has to be taken from SalesSeasonId-property of the weekend specials requested before.
E_NOT_IN_TIME_FRAME Indicates, that the given DepartureDateTime and/or ArrivalDateTime are not fully covered by the validity period of the weekend special identified by the given parameters.

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.

See Also

CarRentalAgentService Class | SunnyCars.Services.Osi.WsReservation Namespace