Skip to main content

Zone

Definition​

Zone Type
zone.json
{
  "id": 0,
  "key": 0,
  "farmID": 0,
  "zoneName": "",
  "zoneDescription": "",
  "status": 0,
  "deletedAt": "",
  "createdAt": "",
  "updatedAt": "",
}

Get Zones​

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

Get Zone​

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

Apply Zone.ID​

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

Create Zone​

curl -X POST "https://${baseUrl}/zone/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @zone.json
info
zone.json
{
  "key": 0,
  "farmID": 0,
  "zoneName": "",
  "zoneDescription": "",
  "status": 0,
}
tip

success status: 201

Update Zone​

curl -X PUT "https://${baseUrl}/zone/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @zone.json
info
zone.json
{
  "key": 0,
  "farmID": 0,
  "zoneName": "",
  "zoneDescription": "",
  "status": 0,
}

Update Zone Partial​

curl -X PATCH "https://${baseUrl}/zone/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -H "Attrs: key,farmID,zoneName,zoneDescription,status" \
   -d @zone.json
info
zone.json
{
  "key": 0,
  "farmID": 0,
  "zoneName": "",
  "zoneDescription": "",
  "status": 0,
}

Update Zone Status​

curl -X PATCH "https://${baseUrl}/zone/${id}/status/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @zone.json
info
zone.json
{
  "status": 0
}

Destroy Zone​

curl -X DELETE "https://${baseUrl}/zone/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"
curl -X POST "https://${baseUrl}/zone/${id}/user/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d "[1,2,3,4]"
curl -X DELETE "https://${baseUrl}/zone/${id}/user/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d "[1,2,3,4]"