Отделы¶

На этой странице представлены описания методов API, предназначенных для работы с отделами техников из раздела Команда.

Управление отделом¶

Список отделов¶

Получить список всех отделов команды можно с помощью метода team/department/list.

Запрос:

HTTPcURL

GET /v1/team/department/list
  ?search=<string>
  &offset=<number>
  &limit=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -G "https://api.pro32connect.ru/v1/team/department/list" \
  --data-urlencode "search=<string>" \
  --data-urlencode "offset=<number>" \
  --data-urlencode "limit=<number>" \
  -H "X-Api-Key: YOUR_API_KEY"

Параметр	Тип	Описание
`search`	`string`	Фильтр по названию отдела без учета регистра.
`offset`	`number`	Смещение относительно первого элемента списка. Значение по умолчанию: `0`.
`limit`	`number`	Количество элементов в списке. Значение по умолчанию: `20`; максимальное значение: `100`.

Ответ:

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

Данные ответа

{
    "data": [ {
        "id": 1001,
        "name": "Техническая поддержка мобильных устройств",
        "ldap": true,
        "worker": false,
        "create_time": 1788503133,
        "modify_time": 1788503133,
        "size": 2
    } ]
}

Название	Тип	Описание
`data`	`array`	Список отделов.
`data[].id`	`number`	Внутренний идентификатор отдела.
`data[].name`	`string`	Название отдела.
`data[].ldap`	`boolean`	Указывает, был ли отдел импортирован из поставщика удостоверений через LDAP.
`data[].worker`	`boolean`	Указывает, предназначен ли отдела для рабочих мест.
`data[].create_time`	`number`	Время создания отдела в формате Unix timestamp.
`data[].modify_time`	`number`	Время последнего обновления отдела в формате Unix timestamp.
`data[].size`	`number`	Количество участников отдела.

Информация об отделе¶

Получить подробную информацию об отделе можно с помощью метода team/department/info.

Запрос:

HTTPcURL

GET /v1/team/department/info
  ?id=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -G "https://api.pro32connect.ru/v1/team/department/info" \
  --data-urlencode "id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY" \

Параметр	Тип	Описание
`id`	`number`	Внутренний идентификатор отдела.

Ответ:

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

Данные ответа

{
    "data": {
        "id": 1001,
        "name": "Техническая поддержка мобильных устройств",
        "ldap": false,
        "worker": false,
        "members": [ {
            "id": 1002,
            "email": "frolov.a@mail.ru"
        }, {
            "id": 1003,
            "email": "zorin.e@mail.ru
        } ]
    },
    "status": 0
}

Название	Тип	Описание
`data`	`object`	Данные отдела.
`data.id`	`number`	Внутренний идентификатор отдела.
`data.name`	`string`	Название отдела.
`data.ldap`	`boolean`	Указывает, был ли отдел импортирован из поставщика удостоверений через LDAP.
`data.worker`	`boolean`	Указывает, предназначен ли отдел для рабочих мест.
`data.create_time`	`number`	Время создания отдела в формате Unix timestamp.
`data.modify_time`	`number`	Время последнего обновления отдела в формате Unix timestamp.
`data.members`	`array`	Список участников отдела.
`data.members[].id`	`number`	Внутренний идентификатор участника.
`data.members[].email`	`string`	Адрес электронной почты участника.
`status`	`number`	Статус выполнения. Возможные значения: `0` — Данные отдела получены. `1` — Некорректный запрос. `2` — Внутренняя ошибка сервера. `6` — Отдел не найден. `8` — Доступ к отделу запрещен.

Создать отдел¶

Создать отдел в своей команде можно с помощью метода team/department/create.

Запрос:

HTTPcURL

POST /v1/team/department/create
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "name": <string>,
  "worker": <boolean>
}

curl -X POST "https://api.pro32connect.ru/v1/team/department/create" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "name": <string>,
    "worker": <boolean>
  }'

Параметр	Тип	Описание
`name`	`string`	Название отдела.
`worker`	`boolean`	Указывает, предназначен ли отдел для рабочих мест.

Ответ:

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

Данные ответа

{
    "id": 1001,
    "status": 0
}

Название	Тип	Описание
`id`	`number`	Внутренний идентификатор созданного отдела.
`status`	`number`	Статус выполнения. Возможные значения: `0` — Отдел успешно создан. `1` — Некорректные данные запроса. `6` — Недостаточно прав.

Измененить отдел¶

Изменить данные отдела можно с помощью метода team/department/update.

Запрос:

HTTPcURL

POST /v1/team/department/update
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>,
  "name": <string>
}

curl -X POST "https://api.pro32connect.ru/v1/team/department/update" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>,
    "name": <string>
  }'

Параметр	Тип	Описание
`id`	`number`	Внутренний идентификатор отдела.
`name`	`string`	Название отдела.

Ответ:

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

Данные ответа

{
    "status": 0
}

Название	Тип	Описание
`status`	`number`	Статус выполнения. Возможные значения: `0` — Данные успешно обновлены. `1` — Некорректные данные запроса. `6` — Недостаточно прав.

Удалить отдел¶

Удалить отдел можно с помощью метода team/department/remove.

Запрос:

HTTPcURL

POST /v1/team/department/remove
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/team/department/remove" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>
  }'

Параметр	Тип	Описание
`id`	`number`	Внутренний идентификатор отдела.

Ответ:

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

Данные ответа

{
    "status": 0
}

Название	Тип	Описание
`status`	`number`	Статус выполнения. Возможные значения: `0` — Отдел успешно удален. `1` — Некорректные данные запроса. `8` — Недостаточно прав.

Участники отделов¶

Добавление участника в отдел¶

Чтобы добавить учетную запись техника или отправленного приглашения в отдел, используйте метод team/department/member/add.

Запрос:

HTTPcURL

POST /v1/team/department/member/add
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>,
  "email": <string>
}

curl -X POST "https://api.pro32connect.ru/v1/team/department/member/add" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>,
    "email": <string>
  }'

Параметр	Тип	Описание
`id`	`number`	Внутренний идентификатор отдела.
`email`	`string`	Адрес электронной почты техника или отправленного приглашения.

Ответ:

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

Данные ответа

{
    "status": 0
}

Название	Тип	Описание
`status`	`number`	Статус выполнения. Возможные значения: `0` — Участник успешно добавлен. `1` — Некорректные данные запроса. `2` — Внутренняя ошибка сервера. `6` — Отдел или участник не найдены. `6` — Недостаточно прав.

Удаление участника из отдела¶

Чтобы удалить учетную запись техника или отправленного приглашения из отдела, используйте метод team/department/member/remove.

Запрос:

HTTPcURL

POST /v1/team/department/member/remove
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>,
  "email": <string>
}

curl -X POST "https://api.pro32connect.ru/v1/team/department/member/remove" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>,
    "email": <string>
  }'

Параметр	Тип	Описание
`id`	`number`	Внутренний идентификатор отдела.
`email`	`string`	Адрес электронной почты технического специалиста или отправленного приглашения.

Ответ:

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

Данные ответа

{
    "status": 0
}

Название	Тип	Описание
`status`	`number`	Статус выполнения. Возможные значения: `0` — Участник успешно удален. `1` — Некорректные данные запроса. `2` — Внутренняя ошибка сервера. `6` — Отдел или участник не найдены. `6` — Недостаточно прав.