Get State List

Get State List by Country ID

api/Location

Query String

ParameterRequiredValue
actionMandatory2
countryIdMandatoryUser Input
startOptionalUser Input

Request Header

ParameterRequiredValue
TokenKeyMandatoryUser Input
PageOptionalUser Input
PerPageOptionalUser Input

Response

ContentList 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 NameData Type
StateIDInteger
StateNameString
**TimeZoneObject

TimeZone Entity

Property NameData Type
TimeZoneIDInteger
TimeZoneNameString

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.