Skip to main content

City

Definition​

City Type
city.json
{
  "id": 0,
  "countryID": 0,
  "provinceID": 0,
  "cityName": "",
  "cityCode": "",
  "areaCode": "",
}

Get Cities​

curl -X GET "https://${baseUrl}/city/?\$filter=&\$orderBy=&\$page=1&\$pageSize=10" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Get City​

curl -X GET "https://${baseUrl}/city/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Apply City.ID​

curl -X POST "https://${baseUrl}/apply/city/id/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Create City​

curl -X POST "https://${baseUrl}/city/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @city.json
info
city.json
{
  "countryID": 0,
  "provinceID": 0,
  "cityName": "",
  "cityCode": "",
  "areaCode": "",
}
tip

success status: 201

Update City​

curl -X PUT "https://${baseUrl}/city/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @city.json
info
city.json
{
  "countryID": 0,
  "provinceID": 0,
  "cityName": "",
  "cityCode": "",
  "areaCode": "",
}

Update City Partial​

curl -X PATCH "https://${baseUrl}/city/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -H "Attrs: countryID,provinceID,cityName,cityCode,areaCode" \
   -d @city.json
info
city.json
{
  "countryID": 0,
  "provinceID": 0,
  "cityName": "",
  "cityCode": "",
  "areaCode": "",
}

Destroy City​

curl -X DELETE "https://${baseUrl}/city/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"