Cities

Gets a list of all cities.

get

Query parameters

KeywordsstringOptional

The keywords for filter.

CountryCodestringOptional

The CountryCode for filter.

StateCodestringOptional

The StateCode for filter.

NamestringOptional

The Name for filter.

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

Specifies the sorting order type for a collection.

Possible values:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/cities

HTTPcURLJavaScriptPython

GET /api/v1/cities HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "countryCode": "US",
        "stateCode": "NY",
        "name": "New York",
        "tags": "City, US, NY"
      }
    ],
    "totalItems": 1,
    "pageNumber": 0,
    "pageSize": 20
  },
  "errors": []
}