Пользователь также может быть отнесен к групповым элементам, которые будут группировать его входные данные для аналитики и отчётов. Все групповые элементы, присвоенные пользователю, будут автоматически отнесены к записи KPI при добавлении новых вводных данных.
Объект группового элемента пользователя
Объект имеет следующие свойства:
| Название | Тип | Только для чтения | Обязательный | Макс. длина | Комментарии |
|---|---|---|---|---|---|
| user_id | integer | да | нет | Идентификатор пользователя, который присваивается групповому элементу | |
| id | integer | нет | да | Идентификатор группового элемента, который присваивается пользователю | |
| group_id | integer | да | нет | Идентификатор группы к которой принадлежит элемент | |
| group_name | string | да | нет | 50 | Название группы |
| name | string | да | нет | 50 | Название группового элемента |
Пример JSON
{
"user_id": 111,
"id": 222,
"group_id": 221,
"group_name": "City",
"name": "New York",
"created_at": "2020-01-11T09:35:00"
}
Пример XML
<UserGroupItem xmlns="http://schemas.datacontract.org/2004/07/Waytobi.App.Api.Models"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<user_id>111</user_id>
<id>222</id>
<group_id>221</group_id>
<group_name>City</group_name>
<name>New York</name>
<created_at>2020-01-11T09:35:00</created_at>
</UserGroupItem>
Получить все групповые элементы пользователя
GET /api/users/{user_id}/groupitems
Используя curl
curl https://app.waytobi.com/api/users/{user_id}/groupitems
-v -u {token}
Пример ответа
Status: 200 OK
[
{
"user_id": 111,
"id": 222,
"group_id": 221,
"group_name": "City",
"name": "New York",
"created_at": "2020-01-11T09:35:00"
},
{
"user_id": 111,
"id": 232,
"group_id": 231,
"group_name": "Country",
"name": "USA",
"created_at": "2020-01-11T09:35:00"
}
]
Получить групповой элемент пользователя
GET /api/users/{user_id}/groupitems/{id}
Используя curl
curl https://app.waytobi.com/api/users/{user_id}/groupitems/{id}
-v -u {token}
Пример ответа
Status: 200 OK
{
"user_id": 111,
"id": 222,
"group_id": 221,
"group_name": "City",
"name": "New York",
"created_at": "2020-01-11T09:35:00"
}
Добавить групповой элемент пользователя
POST /api/users/{user_id}/groupitems
Используя curl
curl https://app.waytobi.com/api/users/{user_id}/groupitems
-H "Content-Type: application/json"
-d '{"id": "222"}'
-v -u {token} -X POST
Пример ответа
Status: 201 Created
Location: https://app.waytobi.com/api/users/{user_id}/groupitems/{id}
{
"user_id": 111,
"id": 222,
"group_id": 221,
"group_name": "City",
"name": "New York",
"created_at": "2020-01-11T09:35:00"
}
Удалить групповой элемент пользователя
DELETE /api/users/{user_id}/groupitems/{id}
Используя curl
curl https://app.waytobi.com/api/users/{user_id}/groupitems/{id}
-v -u {token}
Пример ответа
Status: 200 OK