Перейти к основному содержимому

Создать агента

Используйте этот метод, чтобы обновить информацию об агенте.

    ----
Permissions:INTEGRATOR,SUPERVISOR
----

Переменные пути запроса

ПеременнаяОписание
userVariableЗначение id или login агента

Параметры запроса

ПараметрОписание
userVariableNameВозможные значения: id/login - переменная агента

Поля тела запроса

ПараметрТипОписание
loginStringЛогин агента
passwordStringПароль агента
nameStringИмя агента, которое будет видно клиентам
aliasString (необязательно)Псевдоним агента
genderEnum (необязательно)Пол агента: MALE или FEMALE
skillsArray of longs (необязательно)Навыки агента
photoUrlString (необязательно)Ссылка на фото агента
emailString (необязательно)Email агента
settingsArray of objects (необязательно)Настройки агента
supervisorString (необязательно)Логин супервайзера, к группе которого принадлежит агент. Этот параметр необходим для того, чтобы назначить агента в группу к супервайзеру.
unitIdLongИдентификатор группы к которой принадлежит агент. Этот параметр необходим для того, чтобы назначить агента в группу к супервайзеру.

Пример curl

$ curl 'http://localhost:8080/api/v1/agents/24?userVariableName=id' -i -X PUT \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <integrator_token>' \
-H 'X-Tenant-Name: local' \
-d '{
"login" : null,
"name" : "name",
"alias" : "alias",
"gender" : "MALE",
"role" : null,
"skills" : [ 2, 3, 5 ],
"photoUrl" : "photo url",
"email" : "email",
"settings" : [ ],
"supervisor" : "supervisor1",
"unitId" : null,
"password" : "password"
'

Пример HTTP запроса

PUT /api/v1/agents/24?userVariableName=id HTTP/1.1
Content-Type: application/json
Authorization: Bearer <integrator_token>
X-Tenant-Name: local
Content-Length: 271
Host: localhost:8080

{
"login" : null,
"name" : "name",
"alias" : "alias",
"gender" : "MALE",
"role" : null,
"skills" : [ 2, 3, 5 ],
"photoUrl" : "photo url",
"email" : "email",
"settings" : [ ],
"supervisor" : "supervisor1",
"unitId" : null,
"password" : "password"

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

ПараметрТипОписание
idLongИдентификатор пользователя в базе данных
loginStringЛогин агента
HTTP/1.1 200 OK
X-Request-Id: 8425da7b-af94-48fa-98ba-3dd6e86f49d5
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY