Группы

Функция групп состоит в том, чтобы идентифицировать объединение пользователей и пользовательских данных или иерархию вашей компании. Среди групп могут быть Страны, Офисы, Команды и т.д.
Групповые элементы добавляются к группе и могут потом быть присвоены пользователю. Далее групповые элементы используются как часть прав доступа пользователя и служат для того, чтобы определить, как пользовательские записи KPI группируются для аналитики и отчетов.

Объект группы

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

Пример JSON

{
  "id":		1,
  "name":	"City"
}

Пример XML

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

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

GET /api/groups

Используя curl

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

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

Status: 200 OK
[
 {
    "id":         1,
    "name":       "City"
  },
  {
    "id":         2,
    "name":       "Country"
  }
]

Получить группу

GET /api/groups/{id}

Используя curl

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

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

Status: 200 OK
{
  "id":1,
  "name":"City",
  "sort_order":1
}

Добавить группу

POST /api/groups

Используя curl

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

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

Status: 201 Created
Location: https://app.waytobi.com/api/groups/{id}
{
  "id":3,
  "name":"My Group Name"
}

Обновить группу

PUT /api/groups/{id}

Используя curl

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

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

Status: 200 OK
{
  "id":3,
  "name":"My Group Name"
}

Удалить группу

DELETE /api/groups/{id}

Используя curl

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

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

Status: 200 OK