Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Полноценное описание пока не готово. В формате справочинка доступно: для уровня "клиент" тут, для уровня "группа добавочных" тут

Ресурс предназначен для

Table of Contents

Описание структур данных

Пример

Ресурсы

Раздел "клиент"

Раздел "группа добавочных"

...


Warning

Мы обновили документацию, актуальная версия страницы доступна по ссылке: Пользователь группы внутренних номеров (/user/extension_group/)

Table of Contents
maxLevel2

Описание

Ресурс предназначен для создания, удаления, а также для управления и уточнения параметров пользователя уровня группы добавочных.

Пользователь уровня группы добавочных имеет доступ к настройкам и ресурсам конкретной группы добавочных, а в зависимости от типа доступа  (access type) либо имеет полный доступ (full), либо доступ только для чтения ('read_only') без права на какие-либо изменения в настройках.


Ресурсы /user/extension_group/

Ресурсы создания, удаления, а также для управления и уточнения параметров пользователя уровня группы добавочных:

Table of Contents
maxLevel4
minLevel3

POST /client/{client_id}/user/extension_group/

Добавить нового пользователя уровня "Группа добавочных"

Параметры URL

Name

Type

Description

client_id

string

Нужно указать обязательно.

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

Name

Type

Описание

comment

string

Комментарий (заметка)

status

string

Статус пользователя. Может быть: 'active' либо 'blocked'.

name

string

Нужно указать обязательно.

extension_group_id

integer

Нужно указать обязательно. ID группы, для которой создается пользователь

access

string

Тип доступа к ресусрам. Может быть 'full' либо 'read_only' (нет прав на изменения).

extra_params

string

Поле дополнительных параметров - можно приспособить для любых целей

timezone

string

Пользовательская тайм-зона

login

string

Нужно указать обязательно.

password

string

Нужно указать обязательно.

email

string

Нужно указать обязательно.
email_notifybooleanЕсли True тогда текущему пользователю(кто создает), на почту будут высланы данные для доступа в систему для нового созданного пользователя.

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

Name

Type

Description

comment

string

status

string

name

string

extension_group_id

integer

email

string

access

string

extra_params

string

timezone

string

login

string

id

integer

ID данного ресурса

GET /client/{client_id}/user/extension_group/

Получить список пользователей уровня "Группа добавочных"

Параметры URL

Name

Type

Description

client_id

string

Нужно указать обязательно.

Параметры запроса (фильтр)

Name

Type

Description

comment

array [string]

status

array [string]

name

array [string]

id

array [integer]

access

array [string]

extension_group_id

array [integer]

timezone

array [string]

login

array [string]

email

array [string]

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

Name

Type

Description

comment

string

status

string

name

string

extension_group_id

integer

email

string

access

string

extra_params

string

timezone

string

login

string

id

integer

ID данного ресурса

...

PUT /client/{client_id}/user/extension_group/{user_id}

Обновление пользователя уровня "Группа добавочных"

Параметры URL

Name

Type

Description

user_id

integer

Нужно указать обязательно.

client_id

string

Нужно указать обязательно.

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

Name

Type

Описание

comment

string

Комментарий (заметка)

status

string

Статус пользователя. Может быть: 'active' либо 'blocked'.

name

string

Видимое имя пользователя

extension_group_id

integer

ID пользователя уровня "Группа добавочных"

access

string

Тип доступа к ресусрам. Может быть 'full' либо 'read_only' (нет прав на изменения).

extra_params

string

Поле дополнительных параметров - можно приспособить для любых целей

timezone

string

Пользовательская тайм-зона

password

string


email

string


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

Name

Type

Description

comment

string

status

string

name

string

extension_group_id

integer

email

string

access

string

extra_params

string

timezone

string

login

string

id

integer

ID данного ресурса

GET /client/{client_id}/user/extension_group/{user_id}

Запросить параметры пользователя уровня "Группа добавочных"

Параметры URL

Name

Type

Description

user_id

integer

Нужно указать обязательно.

client_id

string

Нужно указать обязательно.

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

Name

Type

Description

comment

string

status

string

name

string

extension_group_id

integer

email

string

access

string

extra_params

string

timezone

string

login

string

id

integer

ID данного ресурса


DELETE /client/{client_id}/user/extension_group/{user_id}

Удалить пользователя уровня "Группа добавочных"

Параметры URL

Name

Type

Description

user_id

integer

Нужно указать обязательно.

client_id

string

Нужно указать обязательно.

Теги по теме

Related Labels