Skip to main content

CitiesResponse

Response containing a list of cities with pagination metadata.

data object[]

A list of city objects

  • Array [
  • code string

    Unique code identifier for the city.

    name string

    City name.

    state_id integer

    Reference ID for State

  • ]
  • meta object

    Additional metadata like pagination data.

    currentPage integer

    The current requested page number.

    nextPage integer

    The next available page number, null if current page is already the last page.

    prevPage integer

    The previous available page number, null if current page is the first page.

    totalPages integer

    Total number of available pages.

    totalCount integer

    Total number of available records.

    CitiesResponse
    {
    "data": [
    {
    "code": "AGR",
    "name": "Agra",
    "state_id": 132
    },
    {
    "code": "AGX",
    "name": "Agatti Island"
    }
    ],
    "meta": {
    "currentPage": 1,
    "nextPage": 2,
    "prevPage": null,
    "totalPages": 137,
    "totalCount": 2724
    }
    }