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

getRegionsWithResponse

@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionsOperation)"))
public final <Error class: unknown class><List<Region>> getRegionsWithResponse(List<GetRegionsOperationParams.Include> include, String language, String customerSessionId, String ancestorId, String area, List<String> countryCode, List<String> countrySubdivisionCode, String iataLocationCode, BigDecimal limit, String supplySource, List<String> type, String billingTerms, String partnerPointOfSale, String paymentTerms, String platformName)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionsOperation)"))
public final <Error class: unknown class><List<Region>> getRegionsWithResponse(List<GetRegionsOperationParams.Include> include, String language, String customerSessionId, String ancestorId, String area, List<String> countryCode, List<String> countrySubdivisionCode, String iataLocationCode, BigDecimal limit, String supplySource, List<String> type, String billingTerms, String partnerPointOfSale, String paymentTerms)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionsOperation)"))
public final <Error class: unknown class><List<Region>> getRegionsWithResponse(List<GetRegionsOperationParams.Include> include, String language, String customerSessionId, String ancestorId, String area, List<String> countryCode, List<String> countrySubdivisionCode, String iataLocationCode, BigDecimal limit, String supplySource, List<String> type, String billingTerms, String partnerPointOfSale)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionsOperation)"))
public final <Error class: unknown class><List<Region>> getRegionsWithResponse(List<GetRegionsOperationParams.Include> include, String language, String customerSessionId, String ancestorId, String area, List<String> countryCode, List<String> countrySubdivisionCode, String iataLocationCode, BigDecimal limit, String supplySource, List<String> type, String billingTerms)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionsOperation)"))
public final <Error class: unknown class><List<Region>> getRegionsWithResponse(List<GetRegionsOperationParams.Include> include, String language, String customerSessionId, String ancestorId, String area, List<String> countryCode, List<String> countrySubdivisionCode, String iataLocationCode, BigDecimal limit, String supplySource, List<String> type)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionsOperation)"))
public final <Error class: unknown class><List<Region>> getRegionsWithResponse(List<GetRegionsOperationParams.Include> include, String language, String customerSessionId, String ancestorId, String area, List<String> countryCode, List<String> countrySubdivisionCode, String iataLocationCode, BigDecimal limit, String supplySource)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionsOperation)"))
public final <Error class: unknown class><List<Region>> getRegionsWithResponse(List<GetRegionsOperationParams.Include> include, String language, String customerSessionId, String ancestorId, String area, List<String> countryCode, List<String> countrySubdivisionCode, String iataLocationCode, BigDecimal limit)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionsOperation)"))
public final <Error class: unknown class><List<Region>> getRegionsWithResponse(List<GetRegionsOperationParams.Include> include, String language, String customerSessionId, String ancestorId, String area, List<String> countryCode, List<String> countrySubdivisionCode, String iataLocationCode)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionsOperation)"))
public final <Error class: unknown class><List<Region>> getRegionsWithResponse(List<GetRegionsOperationParams.Include> include, String language, String customerSessionId, String ancestorId, String area, List<String> countryCode, List<String> countrySubdivisionCode)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionsOperation)"))
public final <Error class: unknown class><List<Region>> getRegionsWithResponse(List<GetRegionsOperationParams.Include> include, String language, String customerSessionId, String ancestorId, String area, List<String> countryCode)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionsOperation)"))
public final <Error class: unknown class><List<Region>> getRegionsWithResponse(List<GetRegionsOperationParams.Include> include, String language, String customerSessionId, String ancestorId, String area)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionsOperation)"))
public final <Error class: unknown class><List<Region>> getRegionsWithResponse(List<GetRegionsOperationParams.Include> include, String language, String customerSessionId, String ancestorId)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionsOperation)"))
public final <Error class: unknown class><List<Region>> getRegionsWithResponse(List<GetRegionsOperationParams.Include> include, String language, String customerSessionId)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionsOperation)"))
public final <Error class: unknown class><List<Region>> getRegionsWithResponse(List<GetRegionsOperationParams.Include> include, String language)

Deprecated

Use execute method instead

Replace with

execute(operation: GetRegionsOperation)
Content copied to clipboard

Regions Returns the geographic definition and property mappings of regions matching the specified parameters.

To request all regions in the world, omit the ancestor query parameter. To request all regions in a specific continent, country or other level, specify the ID of that region as the ancestor. Refer to the list of top level regions.

The response is a paginated list of regions. See the Link header in the 200 response section.

Return

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

Parameters

include

Options for which content to return in the response. This parameter can be supplied multiple times with different values. The standard and details options cannot be requested together. The value must be lower case. * standard - Include the metadata and basic hierarchy of each region. * details - Include the metadata, coordinates and full hierarchy of each region. * property_ids - Include the list of property IDs within the bounding polygon of each region. * property_ids_expanded - Include the list of property IDs within the bounding polygon of each region and property IDs from the surrounding area if minimal properties are within the region.

language

Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes.

Reference: * W3 Language Tags * Language Options

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)

ancestorId

Search for regions whose ancestors include the requested ancestor region ID. Refer to the list of top level regions. (optional)

area

Filter the results to regions that intersect with a specified area.

The area may be defined in one of two ways: * radius,region_id * radius,latitude,longitude Radius combined with region id would search an area that extends the number of kilometers out from the boundaries of the region in all directions.
Radius combined with a single point, specified by a latitude, longitude pair would search an area in a circle with the specified radius and the point as the center.
Radius should be specified in non-negative whole kilometers, decimals will return an error. A radius of 0 is allowed.
When specifying the area parameter, there will be a limit of 100 results, which can be narrowed further by the limit parameter.
Due to the number of results, unless point_of_interest is specified as the only type, regions of type point_of_interest will not be included in a request that filters to an area.

An example use case would be searching for the closest 3 airports within 50 kilometers of a specified point.
&type=airport&limit=3&area=50,37.227924,-93.310036 (optional)

countryCode

Filter the results to a specified ISO 3166-1 alpha-2 country code. For more information see: https://www.iso.org/obp/ui/#search/code/ (optional)

countrySubdivisionCode

Filter the results down to only the ISO 3166-2 country subdivision. (optional)

iataLocationCode

Search for regions by the requested 3-character IATA location code, which will apply to both iata_airport_code and iata_airport_metro_code. The code must be upper case. (optional)

limit

Limit the number of results returned. Using the area parameter will impose a max value of 100 for this whether specified or not. (optional)

supplySource

Options for which supply source you would like returned in the geography response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information. (optional)

type

Filter the results to a specified region type. (optional)

billingTerms

This parameter is to specify the terms of how a resulting booking should be billed. If this field is needed, the value for this will be provided to you separately. (optional)

partnerPointOfSale

This parameter is to specify what point of sale is being used to shop and book. If this field is needed, the value for this will be provided to you separately. (optional)

paymentTerms

This parameter is to specify what terms should be used when being paid for a resulting booking. If this field is needed, the value for this will be provided to you separately. (optional)

platformName

This parameter is to specify what platform is being used to shop and book. If this field is needed, the value for this will be provided to you separately. (optional)

Throws