Get All Search Regions by Country
The Get All Search Regions by Country API returns a list of available cities along with their respective regions for the specified CountryRegionId provided in the request.
This API accepts 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 is useful for filtering and displaying cities that belong to a specific country. It is primarily used to populate region lists for hotel or region search functionalities. The API supports both XML and JSON request and response formats.
getAllSearchRegionsByCountry Request Syntax
Endpoint URL
https://{{URL}} /webapi/staticData/getAllSearchRegionsByCountry
Request Header
HTTP Method: [POST]
Content-Type: [application/xml or application/json]
Accept: [application/xml or application/json]
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
|
Org |
String | Yes |
The organisation short code identifying the agent responsible for the request (Agency ID). |
|
User |
String | Yes |
The user’s logon, unique within the given organisation (User Name). |
|
Password |
String | Yes |
The given user’s password. |
|
RegionId |
integer | Yes |
Country region ID used to fetch its Search Regions. |
Response Parameters
| Field | Type | Description |
|---|---|---|
|
Success |
Boolean |
Indicates successful operation (true). |
|
Message |
String |
Descriptive message about the API result. |
|
Data |
Array |
Contains the list of cities. |
|
CityList |
Array |
Collection of cities. |
|
CityId |
Integer |
Unique City ID. |
|
CityName |
String |
Name of the city. |
|
CityWiseRegionList |
Array |
Contains Sub-region details for the city. |
|
RegionId |
Integer |
Unique Region ID. |
|
RegionName |
String |
Name of the region. |
Response Samples
Samples
