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

getRegionWithResponse

@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionOperation)"))
public final <Error class: unknown class><Region> getRegionWithResponse(String regionId, String language, List<GetRegionOperationParams.Include> include, String customerSessionId, String billingTerms, String partnerPointOfSale, String paymentTerms, String platformName, String supplySource)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionOperation)"))
public final <Error class: unknown class><Region> getRegionWithResponse(String regionId, String language, List<GetRegionOperationParams.Include> include, String customerSessionId, String billingTerms, String partnerPointOfSale, String paymentTerms, String platformName)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionOperation)"))
public final <Error class: unknown class><Region> getRegionWithResponse(String regionId, String language, List<GetRegionOperationParams.Include> include, String customerSessionId, String billingTerms, String partnerPointOfSale, String paymentTerms)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionOperation)"))
public final <Error class: unknown class><Region> getRegionWithResponse(String regionId, String language, List<GetRegionOperationParams.Include> include, String customerSessionId, String billingTerms, String partnerPointOfSale)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionOperation)"))
public final <Error class: unknown class><Region> getRegionWithResponse(String regionId, String language, List<GetRegionOperationParams.Include> include, String customerSessionId, String billingTerms)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionOperation)"))
public final <Error class: unknown class><Region> getRegionWithResponse(String regionId, String language, List<GetRegionOperationParams.Include> include, String customerSessionId)
@JvmOverloads()
@Deprecated(message = "Use execute method instead", replaceWith = @ReplaceWith(imports = {}, expression = "execute(operation: GetRegionOperation)"))
public final <Error class: unknown class><Region> getRegionWithResponse(String regionId, String language, List<GetRegionOperationParams.Include> include)

Deprecated

Use execute method instead

Replace with

execute(operation: GetRegionOperation)
Content copied to clipboard

Region Returns the geographic definition and property mappings for the requested Region ID. The response is a single JSON formatted region object.

Return

a Response object with a body of type Region

Parameters

regionId

ID of the region to retrieve.

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. See https://www.w3.org/International/articles/language-tags/ Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options

include

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

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)

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)

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)

Throws