Skip to main content

District

Definition​

District Type
district.json
{
  "id": 0,
  "countryID": 0,
  "provinceID": 0,
  "cityID": 0,
  "districtName": "",
  "districtCode": "",
}

Get Districts​

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

Get District​

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

Apply District.ID​

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

Create District​

curl -X POST "https://${baseUrl}/district/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @district.json
info
district.json
{
  "countryID": 0,
  "provinceID": 0,
  "cityID": 0,
  "districtName": "",
  "districtCode": "",
}
tip

success status: 201

Update District​

curl -X PUT "https://${baseUrl}/district/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @district.json
info
district.json
{
  "countryID": 0,
  "provinceID": 0,
  "cityID": 0,
  "districtName": "",
  "districtCode": "",
}

Update District Partial​

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

Destroy District​

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