Get All Search Regions by Country
The Get All Search Regions by Country API returns the list of available cities along with their respective Regions for the Country RegionId passed in your request.
This API takes a CountryRegionId as input and returns a list of cities and their associated regions. The response includes City details such as CityId and CityName, along with Region details such as RegionId and RegionName mapped under each city
This API helps in filtering and displaying cities that belong to a specific country.
It is mainly used to populate region lists for hotel or region searches. It supports both XML and JSON request/response formats.
getAllSearchRegionsByCountry Request Syntax
Request Header
HTTP Method: [POST]
Content-Type: [application/xml or application/json]
Accept: [application/xml or application/json]
Authentication: [Based on Org, User, and Password in the request body.]
Request Parameters
| Node/Field | Type | Required | Description |
|---|---|---|---|
|
Org |
String | Yes |
Organization code assigned to your agency. |
|
User |
String | Yes |
Username provided by the system. |
|
Password |
String | Yes |
User password for authentication. |
|
RegionId |
integer | Yes |
Country region ID used to fetch its cities. |
Response Parameters
| Field | Type | Description |
|---|---|---|
|
Success |
Boolean |
Indicates successful operation (true). |
|
Message |
String |
Message confirming successful fetch. |
|
Data |
Array |
List of city records. |
|
Data.CityList.CityId |
Integer |
Unique city region ID. |
|
Data.CityList. CityName |
String |
City name with country reference. |
|
Data.CityList. CityWiseRegionList |
Array |
List of Region records. |
|
Data.CityList. CityWiseRegionList. RegionId |
Integer |
Unique Region ID. |
|
Data. CityList. CityWiseRegionList. RegionName |
String |
Region name with City reference. |
Response Samples
Samples
