GET/api/v2/users
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| search | string | поиск. |
| limit | integer | ограничивает количество выходных данных (Например |
| offset | integer | Указывает число строк, которое необходимо пропустить в общем массиве данных |
| sid | string | тип учетной записи (support – специалист технической поддержки, client – клиент) |
| objectId | integer | идентификатор объекта |
| tags | array | массив тэгов |
| room | integer | номер квартиры |
| entrance | integer | номер подъезда |
| serviceId | integer | идентификатор услуги (актуально для типа пользователей client) |
| typeObject | string | тип объекта (arbitrary,MKD) |
Ответ:| Ключ | Тип | Описание |
|---|
| result | object | объект,содержащий ответ от сервера |
| result | array | массив пользователей |
| last_online_time | integer | последнее время онлайн |
| last_online_platform | string | платформа, с которой последний раз авторизовался пользователь |
| balance | float | баланс |
| custom_name | string | кастомное имя пользователя |
| sid | string | тип учетной записи (support – специалист технической поддержки, client – клиент) |
| phone | string | телефон. |
| enabled | boolean | включен/отключен |
| login | string | логин. |
| email | string | электронная почта. |
| access_dvr | boolean | ограничение доступа к архиву |
| room_num | integer | номер квартиры (клиент) |
| type_activation | string | тип активации (phone – телефон, email – электронная почта, any – любой) |
| type_premises | string | тип помещения (residental – жилое, nonresidental – нежилое) |
| name | string | имя пользователя в системе (специалист технической поддержки) |
| volume | integer | объем оказываемых услуг (если передан фильтр по услугам) |
| count | integer | общее количество записей |
| success | boolean | информация о статусе запроса |
POST/api/v2/users/activation
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| countryId | integer | идентификатор страны (тип активации - телефон) |
| phoneOrEmail | string | номер телефона |
Ответ:| Ключ | Тип | Описание |
|---|
| success | boolean | информация о статусе запроса |
POST/api/v2/users/activation/check-code
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| code | integer | код активации |
| phoneOrEmail | string | номер телефона или электронная почта |
Ответ:| Ключ | Тип | Описание |
|---|
| success | boolean | информация о статусе запроса |
POST/api/v2/users/add
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| sid | string | тип учетной записи (client,support) |
| objectId (client) | integer | идентификатор объекта |
| activationType (client) | string | тип активации (phone/email/any) |
| enabledConstraint (client) | boolean | включено/отключено ограничение активации |
| limitAuthorized (client) | integer | количество доступных авторизаций (обязательно только если enabledConstraint имеет значение true) |
| numberApartment (client) | integer | номер квартиры пользователя |
| resident (client) | boolean | жилое или нежилое помещение |
| password (client) | string | пароль пользователя |
| phone (client) | string | номер телефона (необязательный) |
| email (client) | string | электронная почта (необязательный) |
| enabled (client) | boolean | включен/выключен |
| accessDvr (client) | boolean | указывает, есть ли доступ к архиву |
| customName (client) | string | псевдоним |
| name (support) | string | имя пользователя |
| surname (support) | string | фамилия пользователя |
| middleName (support) | string | отчество пользователя |
| password (support) | string | пароль пользователя |
| phone (support) | string | номер телефона (необязательный) |
| email (support) | string | электронная почта (необязательный) |
| typeSupport (support) | string | тип технической поддержки |
| enabled (support) | boolean | включен/выключен |
| accessDvr (support) | boolean | указывает, есть ли доступ к архиву |
Ответ:| Ключ | Тип | Описание |
|---|
| success | boolean | информация о статусе запроса |
| result | string | логин пользоваля |
POST/api/v2/users/{identifier}/manage
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| password | string | пароль |
| phone | string | номер телефона |
| email | string | электронная почта |
| modeWorkId | integer | режим работы биллинга (только для клиента) |
| refillBalance | boolean | пополнение баланса (только для клиента) |
| customName | string | псевдоним (только для клиента) |
| activationType | string | тип активации (phone/email/any) (только для клиента) |
| enabled | boolean | включен/выключен |
| accessDvr | boolean | есть ли доступ к архиву |
| enabledConstraint | boolean | состояние ограничения на количество авторизованных пользователей (только для клиента) |
| roomNum | integer | номер квартиры (только для клиента) |
| limitAuthorized | integer | лимит авторизаций пользователя (только для клиента) |
| blackListSupport | array | список доступных специалисту технической поддержки объектов |
| middleName | string | отчество пользователя |
| name | string | имя пользователя |
| surname | string | фамилия пользователя |
Ответ:| Ключ | Тип | Описание |
|---|
| success | boolean | информация о статусе запроса |
POST/api/v2/users/mass-enabling
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| jsonFile | file | json-файл |
| jsonData | string | json-строка, используется для получения данных, если не прикреплён файл в поле **jsonFile** |
Пример содержимого json-файла/строки:
[{"login":"ORE_60_123", "enabled":false, "enabledConstraint":false, "limitAuthorized":1000000}, {"login":"ORE_60_122", "enabled":true, "enabledConstraint":true, "limitAuthorized":12345}]
Где:
login - логин пользователя
enabled - статус блокировки (false - не заблокирован, true - заблокирован)
enabledConstraint - включено ли ограничение на кол-во сессий (false - отключено, true - включено) - необязательный параметр
limitAuthorized - максимальное кол-во сессий (числовое значение максимального кол-ва сессий) - необязательный параметр