Группы/Групповые элементы

Групповые элементы относятся к группам и являются частью объединения пользователей или иерархии компании. Для группы 'Страны' возможны такие варианты групповых элементов, как, например, США, Украина, Бразилия и т.д.
Групповые элементы добавляются к группе и могут потом быть присвоены пользователю. Далее групповые элементы используются как часть прав доступа пользователя и служат для того, чтобы определить, как пользовательские записи KPI группируются для аналитики и отчетности.

Объект группового элемента

Объект имеет следующие свойства:

Пример JSON

{
  "id":         2,
  "group_id":   1,
  "name":       "New York"
}

Пример XML

<GroupItem xmlns="http://schemas.datacontract.org/2004/07/Waytobi.App.Api.Models" 
           xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <id>2</id>
  <group_id>1</group_id>
  <name>New York</name>
</GroupItem>

Получить все групповые элементы

GET /api/groups/{group_id}/items

Используя curl

curl https://app.waytobi.com/api/groups/{group_id}/items 
  -v -u {token}

Пример ответа

Status: 200 OK
[
  {
    "id":         2,
    "group_id":   1,
    "name":       "New York"
  },
  {
    "id":         3,
    "group_id":   1,
    "name":       "Kiev"
  }
]

Получить групповой элемент

GET /api/groups/{group_id}/items/{id}

Используя curl

curl https://app.waytobi.com/api/groups/{group_id}/items/{id} 
  -v -u {token}

Пример ответа

Status: 200 OK
{
  "id":         2,
  "group_id":   1,
  "name":       "New York"
}

Добавить групповой элемент 

POST /api/groups/{group_id}/items

Используя curl

curl https://app.waytobi.com/api/groups/{group_id}/items
  -H "Content-Type: application/json" -d '{"name": "My Group item"}'
  -v -u {token} -X POST

Пример ответа

Status: 201 Created
Location: https://app.waytobi.com/api/groups/{group_id}/items/{id}
{
  "id":         2,
  "group_id":   1,
  "name":       "My Group item"
}

Обновить групповой элемент

PUT /api/groups/{group_id}/items/{id}

Используя curl

curl https://app.waytobi.com/api/groups/{group_id}/items/{id}
  -H "Content-Type: application/json" -d '{"name": "My Group Item"}'
  -v -u {token} -X PUT

Пример ответа

Status: 200 OK
{
  "id": 2,
  "group_id": 1,
  "name": "My Group item"
}

Удалить групповой элемент

DELETE /api/groups/{group_id}/items/{id}

Используя curl

curl https://app.waytobi.com/api/groups/{group_id}/items/{id}
  -v -u {token}

Пример ответа

Status: 200 OK