rapid-sdk/com.expediagroup.sdk.rapid.client/RapidClient/getReservationWithResponse

getReservationWithResponse

@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetReservationOperation)"))
public final <Error class: unknown class><List<Itinerary>> getReservationWithResponse(String customerIp, String affiliateReferenceId, String email, String customerSessionId, GetReservationOperationParams.Test test, List<GetReservationOperationParams.Include> include)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetReservationOperation)"))
public final <Error class: unknown class><List<Itinerary>> getReservationWithResponse(String customerIp, String affiliateReferenceId, String email, String customerSessionId, GetReservationOperationParams.Test test)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetReservationOperation)"))
public final <Error class: unknown class><List<Itinerary>> getReservationWithResponse(String customerIp, String affiliateReferenceId, String email, String customerSessionId)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetReservationOperation)"))
public final <Error class: unknown class><List<Itinerary>> getReservationWithResponse(String customerIp, String affiliateReferenceId, String email)

Deprecated

Use execute method instead

Replace with

execute(operation: GetReservationOperation)
Content copied to clipboard

Search for and retrieve Bookings with Affiliate Reference Id This can be called directly without a token when an affiliate reference id is provided. It returns details about bookings associated with an affiliate reference id, along with cancel links to cancel the bookings. Note: Newly created itineraries may sometimes have a small delay between the time of creation and the time that the itinerary can be retrieved. If you receive no results while trying to search for an itinerary that was successfully created, or if you receive a response with two fields, namely, itinerary_id and creation_date_time, then please wait a few minutes before trying to search for the itinerary again.

Return

a Response object with a body of type kotlin.collections.List

Parameters

customerIp

IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.

affiliateReferenceId

The affilliate reference id value. This field supports a maximum of 28 characters.

email

Email associated with the booking. Special characters in the local part or domain should be encoded.

customerSessionId

Insert your own unique value for each user session, beginning with the first API call. Continue to pass the same value for each subsequent API call during the user's session, using a new value for every new customer session.
Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it explicitly links together request paths for individual user's session. (optional)

test

The retrieve call has a test header that can be used to return set responses with the following keywords:
* standard - Requires valid test booking. * service_unavailable * internal_server_error (optional)

include

Options for which information to return in the response. The value must be lower case. * history - Include itinerary history, showing details of the changes made to this itinerary. Changes from the property/supplier have an event_source equal to other in the response. * history_v2 - Include itinerary history, showing details of the changes made to this itinerary. Changes from the property/supplier have an event_source equal to supplier in the response. See the Itinerary history for details. (optional)

Throws