Это главные пользовательские учётные записи, которые дают пользователям доступ к системе. Этот API позволит вносить изменения в учётную запись пользователя и ограничивать доступ, при необходимости.
Объект пользователя
Объект имеет следующие свойства:
| Название | Тип | Только для чтения | Обязательный | Макс. длина | Комментарии |
|---|---|---|---|---|---|
| id | integer | да | нет | Присваивается по умолчанию при создании пользователя | |
| language_id | integer | нет | да | Идентификатор языка | |
| role_id | integer | нет | да | Тип пользователя должен быть (2)Администратор, (4)Директор, (6)Менеджер или (10)Пользователь | |
| status | tinyInteger | нет | да | Поле status может быть только (1)Активный или (0)Заблокированный | |
| first_name | string | нет | да | 50 | Имя пользователя |
| last_name | string | нет | нет | 50 | Фамилия пользователя |
| string | нет | да | 150 | Действительный адрес электронной почты пользователя, который будет использоваться для входа в систему | |
| password | string | нет | да | 20 | Система требует пароль только при создании нового пользователя и его нельзя изменить через API. |
| created_at | datetime | да | нет | Дата и время UTC, когда пользователь был создан | |
| updated_at | datetime | да | нет | Дата и время UTC, когда данные пользователя в последний раз были обновлены |
Пример JSON
{
"id": 111,
"user_type": 6,
"user_status_id": 1,
"first_name": "Jon",
"last_name": "Snow",
"email": "jon@wayotbi.com",
"password": null,
"created_at": "2020-04-15T12:15:00",
"updated_at": "2020-09-20T15:21:00"
}
Пример XML
<User xmlns="http://schemas.datacontract.org/2004/07/Waytobi.App.Api.Models" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <id>111</id> <user_type>6</user_type> <user_status_id>1</user_status_id> <first_name>Jon</first_name> <last_name>Snow</last_name> <email>jon@wayotbi.com</email> <password>null</password> <created_at>2020-04-15T12:15:00</created_at> <updated_at>2020-09-20T15:21:00</updated_at> </User>
Получить всех пользователей
GET /api/users
Используя curl
curl https://app.waytobi.com/api/users
-v -u {token}
Пример ответа
Status: 200 OK
[
{
"id": 111,
"user_type": 6,
"user_status_id": 1,
"first_name": "Jon",
"last_name": "Snow",
"email": "jon@waytobi.com",
"password": null,
"created_at": "2020-04-15T12:15:00",
"updated_at": "2020-09-20T15:21:00"
},
{
"id": 112,
"user_type": 10,
"user_status_id": 1,
"first_name": "Alex",
"last_name": "Rain",
"email": "alex@waytobi.com",
"password": null,
"created_at": "2020-02-11T10:35:00",
"updated_at": "2020-04-25T08:46:00"
}
]
Получить пользователя
GET /api/users/{id}
Используя curl
curl https://app.waytobi.com/api/users/{id}
-v -u {token}
Пример ответа
Status: 200 OK
{
"id": 111,
"user_type": 6,
"user_status_id": 1,
"first_name": "Jon",
"last_name": "Snow",
"email": "jon@waytobi.com",
"password": null,
"created_at": "2020-04-15T12:15:00",
"updated_at": "2020-09-20T15:21:00"
}
Добавить пользователя
POST /api/users
Используя curl
curl https://app.waytobi.com/api/users
-H "Content-Type: application/json"
-d '{"user_type": 6, "user_status_id": 1, "first_name": "Jon", "last_name": "Snow",
"email": "jon@waytobi.com", "password": "Password123"}'
-v -u {token} -X POST
Пример ответа
Status: 201 Created
Location: https://app.waytobi.com/api/users/{id}
{
"id": 111,
"user_type": 6,
"user_status_id": 1,
"first_name": "Jon",
"last_name": "Snow",
"email": "jon@waytobi.com",
"password": null,
"created_at": "2020-04-15T12:15:00",
"updated_at": "2020-09-20T15:21:00"
}
Обновить пользователя
PUT /api/users/{id}
Используя curl
curl https://app.waytobi.com/api/users/{id}
-H "Content-Type: application/json"
-d '{"user_type": 6, "user_status_id": 1, "first_name": "Jon", "last_name": "Snow",
"email": "jon@waytobi.com", "password": "Password123"}'
-v -u {token} -X PUT
Пример ответа
Status: 200 OK
{
"id": 111,
"user_type": 6,
"user_status_id": 1,
"first_name": "Jon",
"last_name": "Snow",
"email": "jon@waytobi.com",
"password": null,
"created_at": "2020-04-15T12:15:00",
"updated_at": "2020-09-20T15:21:00"
}
Удалить пользователя
DELETE /api/users/{id}
Используя curl
curl https://app.waytobi.com/api/users/{id}
-v -u {token}
Пример ответа
Status: 200 OK