Управление группой
1 Получить список групп
Базовая информация
- Описание интерфейса: запрос информации о группе, информация о группе включает в себя ID группы и имя группы, где ID группы используется для группировки профиля. Приложение MoreLogin должно быть обновлено до версии 2.9.0 и выше.
Параметры запроса
Параметр тела, необязательные параметры не могут быть переданы, формат параметра - JSON.
Название параметра | Типа | Требование | Описание |
pageNo | integer(int64) | YES | Текущая страница, по умолчанию: 1 |
pageSize | integer(int64) | YES | Количество заголовков на странице, по умолчанию: 20 |
groupName | string | NO | Поиск по названию группы |
Пример запроса
{
"pageNo": 1,
"pageSize": 10,
"groupName": ""
}Ответ на запрос
{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": {
"current": 0,
"dataList": [
{
"id": 0, // Group ID
"groupName": "" // Group name
}
],
"pages": 0,
"total": 0
},
"requestId": "", // Operation Request ID
}2 Добавление группы
Базовая информация
- Описание интерфейса: добавление группы, после успешного добавления может быть использовано для группировки профиля. Имя группы не может быть продублировано. После успешного создания группы будет возвращен идентификатор группы. Приложение MoreLogin должно быть обновлено до версии 2.9.0 и выше.
Параметрый запроса
Параметр тела, необязательные параметры можно не указывать, формат параметра - JSON.
Название параметра | Тип | Требование | Описание |
groupName | string | YES | Название группы |
Пример запроса
{
"groupName": ""
}Ответ на запрос
{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": 0, // The data returned by the operation
"requestId": "", // Operation Request ID
}3 Modify grouping information
Базовая информация
- Описание интерфейса: при модификации информации о группе можно модифицировать имя группы, которое не должно повторяться. Нужно обновить приложение MoreLogin до версии 2.14.0 и выше.
Параметрый запроса
Параметр тела, необязательные параметры можно не указывать, формат параметра - JSON.
Название параметра | Тип | Обязательно подлежащий передаче | Описание |
groupName | string | Да | Имя группы |
id | integer(int64) | Да | ID группы |
Пример запроса
{
"groupName": "",
"id": 0
}Возврат данных
{
"code": 0, // код возвращенного результата 0: нормально. Все остальные коды аномальны.
"msg": "", // информация об ошибках
"data": true,
"requestId": "", // оперативный запрос ID
}4 Исключение группы
Базовая информация
- Описание интерфейса：исключение назначенной группы. Нужно обновить приложение MoreLogin до версии 2.14.0 и выше.
Параметрый запроса
Параметр тела, необязательные параметры можно не указывать, формат параметра - JSON.
Название параметра | Тип | Обязательно подлежащий передаче | Описание |
ids | array | Да | ID группы |
isDeleteAllEnv | boolean | Нет | Одновременно ли исключается профиль в группе, по умолчанию: false false: отказ от исключения, true: исключение |
Пример запроса
{
"ids": [],
"isDeleteAllEnv": false
}Возврат данных
{
"code": 0, // код возвращенного результата 0: нормально. Все остальные коды аномальны.
"msg": "", // информация об ошибках
"data": true,
"requestId": "", // оперативный запрос ID
}