Skip to main content

Group

Definition​

Group Type
group.json
{
  "id": 0,
  "key": 0,
  "farmID": 0,
  "zoneID": 0,
  "groupName": "",
  "groupDescription": "",
  "status": 0,
  "deletedAt": "",
  "createdAt": "",
  "updatedAt": "",
}

Get Groups​

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

Get Group​

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

Apply Group.ID​

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

Create Group​

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

success status: 201

Update Group​

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

Update Group Partial​

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

Update Group Status​

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

Destroy Group​

curl -X DELETE "https://${baseUrl}/group/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"
curl -X POST "https://${baseUrl}/group/${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}/group/${id}/user/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d "[1,2,3,4]"