Retrive Cities by CityCode

1min
GET
Retrieves cities associated with a given city code.
Path Parameters
cityCode
CityCode
*
countryCode
CountryCode
*
stateCode
StateCode
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-USERINFO
string
X-COREOS-ACCESS
string
*
Query Parameters
limit
integer
offset
integer
Responses
200
OK
SuccessGetCityResponse
All Of
object  +
data
object
request
Request
400
Error Occurred
GetErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
401
Error Occurred
GetErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
403
Error Occurred
GetErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
404
Error Occurred
GetErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
503
Error Occurred
GetErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubDomain}.fxtrt.io/core/api/v1/locations/countries/{countryCode}/states/{stateCode}/cities/{cityCode}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubDomain}.fxtrt.io/core/api/v1/locations/countries/{countryCode}/states/{stateCode}/cities/{cityCode}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
403
404
503
// OK 
{
  "data": {
    "meta": {
      "totalCount": 0
    },
    "cities": [
      {
        "tenantId": "",
        "countryName": "",
        "cityId": "",
        "city": "",
        "cityCode": "",
        "county": "",
        "zipCode": "",
        "state": "",
        "geoCodeCity": {
          "long": "",
          "lat": ""
        },
        "geoCodeZip": {
          "long": "",
          "lat": ""
        },
        "alias": [
          ""
        ],
        "createdAt": "",
        "createdBy": {
          "id": "",
          "name": "",
          "appId": ""
        },
        "updatedAt": "",
        "updatedBy": {
          "id": "",
          "name": "",
          "appId": ""
        }
      }
    ]
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK 
{
  "data": {
    "meta": {
      "totalCount": 0
    },
    "cities": [
      {
        "tenantId": "",
        "countryName": "",
        "cityId": "",
        "city": "",
        "cityCode": "",
        "county": "",
        "zipCode": "",
        "state": "",
        "geoCodeCity": {
          "long": "",
          "lat": ""
        },
        "geoCodeZip": {
          "long": "",
          "lat": ""
        },
        "alias": [
          ""
        ],
        "createdAt": "",
        "createdBy": {
          "id": "",
          "name": "",
          "appId": ""
        },
        "updatedAt": "",
        "updatedBy": {
          "id": "",
          "name": "",
          "appId": ""
        }
      }
    ]
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 27 Sep 2023
Did this page help you?
Create a new City
Update a City