Мобильные
сотрудники
Справочный
центр

ИнтеграцияИнтеграция по APIРабота с пользователями

Работа с пользователями

Получение списка пользователей

Общее описание

Функция GET /v6/api/userManagement/users позволяет получить список пользователей.

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

Функция не имеет дополнительных параметров.

Результат выполнения

Функция возвращает массив структур со следующими параметрами пользователей:

Параметр Описание
userID ИД пользователя
name Имя пользователя
msid Номер телефона или маска номера телефона пользователя
isAdmin Является ли пользователь администратором. Существуют следующие значения:
  • true — пользователь является администратором;
  • false — пользователь не является администратором.
login Логин пользователя
email Адрес электронной почты пользователя
userRole Название роли пользователя
userRoleID ИД роли пользователя
lastLoginDate Дата и время последнего входа (подробнее о формате времени)
regionID ИД региона
phone Контактный номер пользователя

Формат запроса

GET /v6/api/userManagement/users HTTP/1.1
Host: host		
Authorization: Bearer token

Пример запроса

GET /v6/api/userManagement/users HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

[
    \{
        "userID": integer,
        "name": "string",
        "msid": "string",
        "isAdmin": boolean,
        "login": "string",
        "email": "string",
        "userRole": "string",
        "userRoleID": integer,
        "lastLoginDate": "string",
        "regionID": integer,
        "phone": "string"
    },
    \{
        "userID": integer,
        "name": "string",
        "msid": "string",
        "isAdmin": boolean,
        "login": "string",
        "email": "string",
        "userRole": "string",
        "userRoleID": integer,
        "lastLoginDate": "string",
        "regionID": integer,
        "phone": "string"
    }
]

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

[
    \{
        "userID": 83073,
        "name": "Петров Иван",
        "msid": "79161234567",
        "isAdmin": true,
        "login": "petrov",
        "email": "petrov@company.ru",
        "userRole": "Администратор",
        "userRoleID": 3,
        "lastLoginDate": "2024-06-30T17:05:10.067+03:00",
        "regionID": 0,
        "phone": "79161234567"
    },
    \{
        "userID": 83075,
        "name": "Николаев Антон",
        "msid": "79123456789",
        "isAdmin": false,
        "login": "nikolaev",
        "email": "nikolaev@company.ru",
        "userRole": "Пользователь",
        "userRoleID": 2,
        "lastLoginDate": 2024-06-30T17:05:10.067+03:00,
        "regionID": 0,
        "phone": "79123456789"
    }
]

Получение пользователя

Общее описание

Функция GET /v6/api/userManagement/users/{userID} позволяет получить пользователя по его идентификатору.

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

В запросе используется обязательный параметр userID — идентификатор пользователя.

Результат выполнения

Функция возвращает структуру со следующими параметрами пользователя:

Параметр Описание
userID ИД пользователя
name Имя пользователя
msid Номер телефона или маска номера телефона пользователя
isAdmin Является ли пользователь администратором. Существуют следующие значения:
  • true — пользователь является администратором;
  • false — пользователь не является администратором.
login Логин пользователя
email Адрес электронной почты пользователя
userRole Название роли пользователя
userRoleID ИД роли пользователя
lastLoginDate Дата и время последнего входа (подробнее о формате времени)
regionID ИД региона
phone Контактный номер пользователя

Формат запроса

GET /v6/api/userManagement/users/\{userID} HTTP/1.1
Host: host		
Authorization: Bearer token

Пример запроса

GET /v6/api/userManagement/users/83073 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

\{
    "userID": integer,
    "name": "string",
    "msid": "string",
    "isAdmin": boolean,
    "login": "string",
    "email": "string",
    "userRole": "string",
    "userRoleID": integer,
    "lastLoginDate": "string",
    "regionID": integer,
    "phone": "string"
}

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

\{
    "userID": 83073,
    "name": "Петров Иван",
    "msid": "79161234567",
    "isAdmin": true,
    "login": "petrov",
    "email": "petrov@company.ru",
    "userRole": "Администратор",
    "userRoleID": 3,
    "lastLoginDate": "2024-06-30T17:05:10.067+03:00",
    "regionID": 0,
    "phone": "79161234567"
}

Получение списка ролей

Общее описание

Функция GET /v6/api/userManagement/users/roles позволяет получить список ролей пользователей.

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

Функция не имеет дополнительных параметров.

Результат выполнения

Функция возвращает массив структур со следующими параметрами ролей пользователей:

Параметр Описание
userRoleID ИД роли пользователя
name Название роли пользователя
description Описание роли пользователя
isAdmin Является ли роль администраторской. Существуют следующие значения:
  • true — пользователь является администратором;
  • false — пользователь не является администратором.
canUseWeb Разрешен ли доступ в веб-интерфейс. Существуют следующие значения:
  • true — пользователь с этой ролью может использовать веб-интерфейс;
  • false — у пользователя с этой ролью нет доступа к веб-интерфейсу.
canUseB2B Разрешен ли доступ к API. Существуют следующие значения:
  • true — пользователь с этой ролью может работать с API;
  • false — у пользователя с этой ролью нет доступа к API.
canCreate Разрешено ли создание сущностей. Существуют следующие значения:
  • true — пользователь с этой ролью может создавать сущности;
  • false — у пользователя с этой ролью нет доступа к созданию сущностей.
canEdit Разрешено ли редактирование сущностей. Существуют следующие значения:
  • true — пользователь с этой ролью может редактировать сущности;
  • false — у пользователя с этой ролью нет доступа к редактированию сущностей.
canDelete Разрешено ли удаление сущностей. Существуют следующие значения:
  • true — пользователь с этой ролью может удалять сущности;
  • false — у пользователя с этой ролью нет доступа к удалению сущностей.
canSetupSensors Разрешено ли выполнять настройку топливных датчиков. Существуют следующие значения:
  • true — пользователь с этой ролью может выполнять настройку топливных датчиков;
  • false — у пользователя с этой ролью нет доступа к настройке топливных датчиков.
canAccessTaskDashboard Разрешен ли доступ к дашборду задач. Существуют следующие значения:
  • true — пользователь с этой ролью может работать с дашбордом задач;
  • false — у пользователя с этой ролью нет доступа к дашборду задач.
canAccessAutoplanning Разрешен ли доступ к автопланировщику. Существуют следующие значения:
  • true — пользователь с этой ролью может работать с автопланировщиком;
  • false — у пользователя с этой ролью нет доступа к дашборду задач.
canViewUnassignedTasks Можно ли просматривать неназначенные задачи. Существуют следующие значения:
  • true — пользователь с этой ролью может просматривать неназначенные задачи;
  • false — пользователь с этой ролью не может просматривать неназначенные задачи.
canEditCatalogEntry Можно ли редактировать записи справочника. Существуют следующие значения:
  • true — пользователь с этой ролью может редактировать записи справочника;
  • false — пользователь с этой ролью не может редактировать записи справочника.
canCreateTasks Можно ли создавать задачи. Существуют следующие значения:
  • true — пользователь с этой ролью может создавать задачи;
  • false — пользователь с этой ролью не может создавать задачи.
canEditTasks Можно ли редактировать задачи. Существуют следующие значения:
  • true — пользователь с этой ролью может редактировать задачи;
  • false — пользователь с этой ролью не может редактировать задачи.
canAssignTasks Можно ли назначать задачи. Существуют следующие значения:
  • true — пользователь с этой ролью может назначать задачи;
  • false — пользователь с этой ролью не может назначать задачи.
canCreatePlannings Можно ли создавать маршруты. Существуют следующие значения:
  • true — пользователь с этой ролью может создавать маршруты;
  • false — пользователь с этой ролью не может создавать маршруты.
canCreateTeams Можно ли создавать бригады. Существуют следующие значения:
  • true — пользователь с этой ролью может создавать бригады;
  • false — пользователь с этой ролью не может создавать бригады.
canEditTeams Можно ли редактировать бригады. Существуют следующие значения:
  • true — пользователь с этой ролью может редактировать бригады;
  • false — пользователь с этой ролью не может редактировать бригады.
iconCode Название иконки роли.

Формат запроса

GET /v6/api/userManagement/users/roles HTTP/1.1
Host: host		
Authorization: Bearer token

Пример запроса

GET /v6/api/userManagement/users/roles HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

[
    \{
        "userRoleID": integer,
        "name": "string",
        "description": "string",
        "isAdmin": boolean,
        "canUseWeb": boolean,
        "canUseB2B": boolean,
        "canCreate": boolean,
        "canEdit": boolean,
        "canDelete": boolean,
        "canSetupSensors": boolean,
        "canAccessTaskDashboard": boolean,
        "canAccessAutoplanning": boolean,
        "canViewUnassignedTasks": boolean,
        "canEditCatalogEntry": boolean,
        "canCreateTasks": boolean,
        "canEditTasks": boolean,
        "canAssignTasks": boolean,
        "canCreateTeams": boolean,
        "canEditTeams": boolean,
        "canCreatePlannings": boolean,
        "iconCode": "string"
    },
    \{
        "userRoleID": integer,
        "name": "string",
        "description": "string",
        "isAdmin": boolean,
        "canUseWeb": boolean,
        "canUseB2B": boolean,
        "canCreate": boolean,
        "canEdit": boolean,
        "canDelete": boolean,
        "canSetupSensors": boolean,
        "canAccessTaskDashboard": boolean,
        "canAccessAutoplanning": boolean,
        "canViewUnassignedTasks": boolean,
        "canEditCatalogEntry": boolean,
        "canCreateTasks": boolean,
        "canEditTasks": boolean,
        "canAssignTasks": boolean,
        "canCreateTeams": boolean,
        "canEditTeams": boolean,
        "canCreatePlannings": boolean,
        "iconCode": "string"
    }
]

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

[
    \{
        "userRoleID": 1,
        "name": "Сотрудник",
        "description": null,
        "isAdmin": false,
        "canUseWeb": false,
        "canUseB2B": false,
        "canCreate": false,
        "canEdit": false,
        "canDelete": false,
        "canSetupSensors": false,
        "canAccessTaskDashboard": false,
        "canAccessAutoplanning": false,
        "canViewUnassignedTasks": false,
        "canEditCatalogEntry": false,
        "canCreateTasks": false,
        "canEditTasks": false,
        "canAssignTasks": false,
        "canCreateTeams": false,
        "canEditTeams": false,
        "canCreatePlannings": false,
        "iconCode": null
    },
    \{
        "userRoleID": 2,
        "name": "Пользователь",
        "description": null,
        "isAdmin": false,
        "canUseWeb": true,
        "canUseB2B": true,
        "canCreate": true,
        "canEdit": true,
        "canDelete": true,
        "canSetupSensors": true,
        "canAccessTaskDashboard": true,
        "canAccessAutoplanning": true,
        "canViewUnassignedTasks": false,
        "canEditCatalogEntry": true,
        "canCreateTasks": true,
        "canEditTasks": true,
        "canAssignTasks": true,
        "canCreateTeams": false,
        "canEditTeams": false,
        "canCreatePlannings": false,
        "iconCode": null
    },
    \{
        "userRoleID": 3,
        "name": "Администратор",
        "description": null,
        "isAdmin": true,
        "canUseWeb": true,
        "canUseB2B": true,
        "canCreate": true,
        "canEdit": true,
        "canDelete": true,
        "canSetupSensors": true,
        "canAccessTaskDashboard": true,
        "canAccessAutoplanning": true,
        "canViewUnassignedTasks": true,
        "canEditCatalogEntry": true,
        "canCreateTasks": true,
        "canEditTasks": true,
        "canAssignTasks": true,
        "canCreateTeams": true,
        "canEditTeams": true,
        "canCreatePlannings": true,
        "iconCode": null
    }
]

Работа с компанией

Предыдущая страница

Работа с сообщениями

Следующая страница

Содержание

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