Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Протестировать методы API можно на странице интерактивного обозревателя API и без написания кода
Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см. Создание и авторизация приложений)

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

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

Имя

Тип

Обяза-тельный

Описание

client_id

integer

да

Идентификатор клиента, для которого создается пользователь

access

string

нет

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

comment

string

нет

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

email

string

да

e-mail пользователя

email_notify 

boolean

нет

Если параметр принимает значение ‘True’, тогда текущему пользователю (который создает) на почту будут высланы данные для доступа в систему для нового созданного пользователя

extra_params

string

нет

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

login

string

да

Логин пользователя

name

string

да

Имя пользователя

password

string

да

Пароль пользователя

status

string

нет

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

timezone

string

нет

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

Ресурсы раздела “Клиент”

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

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

Добавить нового пользователя уровня "Клиент"

Параметры URL

Имя

Тип

client_id

string

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

Имя

Тип

access

string

comment

string

email

string

email_notify 

boolean

extra_params

string

login

string

name

string

password

string

status

string

timezone

string

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

Имя

Тип

comment

string

status

string

name

string

email

string

access

string

client_id

long

extra_params

string

timezone

string

login

string

id

long

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

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

Получить список пользователей уровня “Клиент”

Параметры URL

Имя

Тип

client_id

string

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

Имя

Тип

login

array [string]

id

array [integer]

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

Имя

Тип

comment

string

status

string

name

string

email

string

access

string

client_id

long

extra_params

string

timezone

string

login

string

id

long

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

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

Обновить пользователя уровня “Клиент”

Параметры URL

Имя

Тип

user_id

integer

client_id

string

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

Имя

Тип

comment

string

status

string

name

string

access

string

extra_params

string

timezone

string

password

string

email

string

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

Имя

Тип

comment

string

status

string

name

string

email

string

access

string

client_id

long

extra_params

string

timezone

string

login

string

id

long

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

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

Запросить параметры пользователя уровня “Клиент”

Параметры URL

Имя

Тип

user_id

integer

client_id

string

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

Имя

Тип

comment

string

status

string

name

string

email

string

access

string

client_id

long

extra_params

string

timezone

string

login

string

id

long

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

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

Удалить пользователя уровня “Клиент”

Параметры URL

Имя

Тип

user_id

integer

client_id

string

  • No labels