Get State List

Get State List by Country ID

api/Location

Query String

Parameter

Required

Value

action

Mandatory

2

countryId

Mandatory

User Input

start

Optional

User Input

Request Header

Parameter

Required

Value

TokenKey

Mandatory

User Input

Page

Optional

User Input

PerPage

Optional

User Input

Response

Content

List of State under specific country

Example of Response

TokenKey → Your-Key
[
  {
    "StateID": 416,
    "StateName": "West Bengal",
    "TimeZone": {
      "TimeZoneID": 33,
      "TimeZoneName": "(GMT+05:30) Chennai, Kolkata, Mumbai, New Delhi"
    }
  }
]

State Entity

Property Name

Data Type

StateID

Integer

StateName

String

  • *TimeZone

Object

TimeZone Entity

Property Name

Data Type

TimeZoneID

Integer

TimeZoneName

String

Remarks:

  1. For getting all records at a time do not add Page parameter in request header.

  2. Use PerPage parameter to change maximum number of records per page during population of paginated data; by default each page contains at most 10 records at a time.

  3. Response header parameter Accept–Ranges will not come with paginated data and other response header parameters will not come for all records population.

  4. If the paginated result is empty then response header parameter Max–Page will be 0 (zero) and there will be no other page related response header parameter.

  5. Add start in query string only for filtering state list by StateName.