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

ИнтеграцияИнтеграция по APIРабота с компетенциями

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

Получение списка компетенций

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

Функция позволяет получить список компетенций.

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

Функция имеет следующие параметры:

Параметр Описание
taskTypeIDs ИД типа задачи. 
name Название компетенции
externalID Внешний идентификатор компетенции

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

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

Параметр Описание
competenceID ИД компетенции
taskTypeIDs ИД типов задач, за которыми закреплена компетенция
competenceGroupID ИД группы компетенции
name Название компетенции
defaultServiceTime Типовое время выполнения задачи (в минутах)
isQuantitative Количественный ресурс компетенции. Существуют следующие значения: true — задача будет назначена сотруднику, если у него хватает ресурса на ее выполнение. Например, если у сотрудника 4 запасных детали, то он не сможет выполнить задачу, в которой требуется 6 деталей. false — проверка наличия компетенции у сотрудника для выполнения задачи.
isAdditive Нужно ли суммировать ресурсы задач для выбора нужного сотрудника. Существуют следующие значения: >true — количество ресурсов у сотрудника суммируется, чтобы его хватило на все планируемые для сотрудника задачи. Например, у сотрудника должно быть суммарно не больше запасных деталей, чем может вместиться в машину. false — задача не будет назначена, если у сотрудника недостаточно ресурса. Например, если у грузовика длина кузова 3 метра, а длина лестницы 4 метра, то сотрудник не сможет выполнить задачу.
isExhaustible Исчерпаемый ресурс. Существуют следующие значения: true — ресурс тратится при выполнении задачи. Например, у сотрудника было 4 запасных детали, после выполнения осталось 2. Следующая задача с 3 деталями уже не будет назначена. false — количество ресурса не меняется после выполнения задачи. Например, до выполнения задачи у сотрудника были 2 холодильные установки в кузове, после осталось 2.
unit Единица измерения ресурса (необязательный параметр).
reserveRatioPercent Коэффициент запаса компетенции в процентах (необязательный параметр). Например, если у сотрудника ресурс 100 по компетенции с коэффициентом 10%, то он сможет только то количество задач, которое укладывается в его ресурс с учетом запаса.
bindToTaskName Название для отображения при привязке к задаче, например, вес товара.
bindToSubscriberName Название для отображения при привязке к сотруднику, например, грузоподъемность автомобиля.
externalID Внешний ИД компетенции.

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

GET /v6/api/competenceManagement/competences HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/competenceManagement/competences HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

[
    \{
        "competenceID": integer,
        "taskTypeIDs": [
            integer
        ],
        "competenceGroupID": integer,
        "name": "string",
        "defaultServiceTime": integer,
        "isQuantitative": boolean,
        "isAdditive": boolean,
        "isExhaustible": true,
        "unit": "string",
        "reserveRatioPercent": number,
        "bindToTaskName": "string",
        "bindToSubscriberName": "string",
        "externalID": "string"
    },
    \{
        "competenceID": integer,
        "taskTypeIDs": [
            integer
        ],
        "competenceGroupID": integer,
        "name": "string",
        "defaultServiceTime": integer,
        "isQuantitative": boolean,
        "isAdditive": boolean,
        "isExhaustible": true,
        "unit": "string",
        "reserveRatioPercent": number,
        "bindToTaskName": "string",
        "bindToSubscriberName": "string",
        "externalID": "string"
    }
]

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

[
    \{
        "competenceID": 1,
        "taskTypeIDs": [
            1,
            2
        ],
        "competenceGroupID": 1,
        "name": "Сбор заказов",
        "defaultServiceTime": 30,
        "isQuantitative": true,
        "isAdditive": true,
        "isExhaustible": true,
        "unit": "кг",
        "reserveRatioPercent": 10,
        "bindToTaskName": "Вес товара",
        "bindToSubscriberName": "Вес товара",
        "externalID": "123"
    },
    \{
        "competenceID": 2,
        "taskTypeIDs": [
            3
        ],
        "competenceGroupID": 1,
        "name": "Отправка посылок",
        "defaultServiceTime": 180,
        "isQuantitative": true,
        "isAdditive": true,
        "isExhaustible": true,
        "unit": "кг",
        "reserveRatioPercent": 10,
        "bindToTaskName": "Вес товара",
        "bindToSubscriberName": "Вес товара"
        "externalID": "234"
    }
]

Получение компетенции по ее идентификатору

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

Функция позволяет получить компетенцию по ее идентификатору.

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

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

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

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

Параметр Описание
competenceID ИД компетенции
taskTypeIDs ИД типов задач, за которыми закреплена компетенция
competenceGroupID ИД группы компетенции
name Название компетенции
defaultServiceTime Типовое время выполнения задачи (в минутах)
isQuantitative Количественный ресурс компетенции. Существуют следующие значения: true — задача будет назначена сотруднику, если у него хватает ресурса на ее выполнение. Например, если у сотрудника 4 запасных детали, то он не сможет выполнить задачу, в которой требуется 6 деталей. false — проверка наличия компетенции у сотрудника для выполнения задачи.
isAdditive Нужно ли суммировать ресурсы задач для выбора нужного сотрудника. Существуют следующие значения: >true — количество ресурсов у сотрудника суммируется, чтобы его хватило на все планируемые для сотрудника задачи. Например, у сотрудника должно быть суммарно не больше запасных деталей, чем может вместиться в машину. false — задача не будет назначена, если у сотрудника недостаточно ресурса. Например, если у грузовика длина кузова 3 метра, а длина лестницы 4 метра, то сотрудник не сможет выполнить задачу.
isExhaustible Исчерпаемый ресурс. Существуют следующие значения: true — ресурс тратится при выполнении задачи. Например, у сотрудника было 4 запасных детали, после выполнения осталось 2. Следующая задача с 3 деталями уже не будет назначена. false — количество ресурса не меняется после выполнения задачи. Например, до выполнения задачи у сотрудника были 2 холодильные установки в кузове, после осталось 2.
unit Единица измерения ресурса (необязательный параметр).
reserveRatioPercent Коэффициент запаса компетенции в процентах (необязательный параметр). Например, если у сотрудника ресурс 100 по компетенции с коэффициентом 10%, то он сможет только то количество задач, которое укладывается в его ресурс с учетом запаса.
bindToTaskName Название для отображения при привязке к задаче, например, вес товара.
bindToSubscriberName Название для отображения при привязке к сотруднику, например, грузоподъемность автомобиля.
externalID Внешний ИД компетенции.

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

GET /v6/api/competenceManagement/competences/\{competenceID} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/competenceManagement/competences/1 HTTP/1.1
Host: host
Authorization: Bearer token

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

\{
    "competenceID": integer,
    "taskTypeIDs": [
        integer
    ],
    "competenceGroupID": integer,
    "name": "string",
    "defaultServiceTime": integer,
    "isQuantitative": boolean,
    "isAdditive": boolean,
    "isExhaustible": boolean,
    "unit": "string",
    "reserveRatioPercent": number,
    "bindToTaskName": "string",
    "bindToSubscriberName": "string",
    "externalID": "string"
}

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

\{
    "competenceID": 1,
    "taskTypeIDs": [
        1,
        2
    ],
    "competenceGroupID": 1,
    "name": "Сбор заказов",
    "defaultServiceTime": 30,
    "isQuantitative": true,
    "isAdditive": true,
    "isExhaustible": true,
    "unit": "кг",
    "reserveRatioPercent": 10,
    "bindToTaskName": "Вес товара",
    "bindToSubscriberName": "Вес товара",
    "externalID": "123"
}

Создание компетенции

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

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

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

Функция имеет следующие параметры:

Параметр Описание
competenceGroupID ИД группы компетенции (обязательный параметр)
name Название компетенции (обязательный параметр)
defaultServiceTime Типовое время выполнения задачи (в минутах)
isQuantitative Количественный ресурс компетенции. Существуют следующие значения:
  • true — задача будет назначена сотруднику, если у него хватает ресурса на ее выполнение. Например, если у сотрудника 4 запасных детали, то он не сможет выполнить задачу, в которой требуется 6 деталей.
  • false — проверка наличия компетенции у сотрудника для выполнения задачи.
isAdditive Нужно ли суммировать ресурсы задач для выбора нужного сотрудника. Существуют следующие значения:
  • true — количество ресурсов у сотрудника суммируется, чтобы его хватило на все планируемые для сотрудника задачи. Например, у сотрудника должно быть суммарно не больше запасных деталей, чем может вместиться в машину.
  • false — задача не будет назначена, если у сотрудника недостаточно ресурса. Например, если у грузовика длина кузова 3 метра, а длина лестницы 4 метра, то сотрудник не сможет выполнить задачу.
isExhaustible Исчерпаемый ресурс. Существуют следующие значения:
  • true — ресурс тратится при выполнении задачи. Например, у сотрудника было 4 запасных детали, после выполнения осталось 2. Следующая задача с 3 деталями уже не будет назначена.
  • false — количество ресурса не меняется после выполнения задачи. Например, до выполнения задачи у сотрудника были 2 холодильные установки в кузове, после осталось 2.
unit Единица измерения ресурса (необязательный параметр).
reserveRatioPercent Коэффициент запаса компетенции в процентах (необязательный параметр). Например, если у сотрудника ресурс 100 по компетенции с коэффициентом 10%, то он сможет только то количество задач, которое укладывается в его ресурс с учетом запаса.
bindToTaskName Название для отображения при привязке к задаче, например, вес товара.
bindToSubscriberName Название для отображения при привязке к сотруднику, например, грузоподъемность автомобиля.
externlID Внешний идентификатор компетенции.

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

При успешном выполнении возвращается статус 201.

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

Параметр Описание
competenceID ИД компетенции
taskTypeIDs ИД типов задач, за которыми закреплена компетенция
competenceGroupID ИД группы компетенции
name Название компетенции
defaultServiceTime Типовое время выполнения задачи (в минутах)
isQuantitative Количественный ресурс компетенции. Существуют следующие значения: true — задача будет назначена сотруднику, если у него хватает ресурса на ее выполнение. Например, если у сотрудника 4 запасных детали, то он не сможет выполнить задачу, в которой требуется 6 деталей. false — проверка наличия компетенции у сотрудника для выполнения задачи.
isAdditive Нужно ли суммировать ресурсы задач для выбора нужного сотрудника. Существуют следующие значения: >true — количество ресурсов у сотрудника суммируется, чтобы его хватило на все планируемые для сотрудника задачи. Например, у сотрудника должно быть суммарно не больше запасных деталей, чем может вместиться в машину. false — задача не будет назначена, если у сотрудника недостаточно ресурса. Например, если у грузовика длина кузова 3 метра, а длина лестницы 4 метра, то сотрудник не сможет выполнить задачу.
isExhaustible Исчерпаемый ресурс. Существуют следующие значения: true — ресурс тратится при выполнении задачи. Например, у сотрудника было 4 запасных детали, после выполнения осталось 2. Следующая задача с 3 деталями уже не будет назначена. false — количество ресурса не меняется после выполнения задачи. Например, до выполнения задачи у сотрудника были 2 холодильные установки в кузове, после осталось 2.
unit Единица измерения ресурса (необязательный параметр).
reserveRatioPercent Коэффициент запаса компетенции в процентах (необязательный параметр). Например, если у сотрудника ресурс 100 по компетенции с коэффициентом 10%, то он сможет только то количество задач, которое укладывается в его ресурс с учетом запаса.
bindToTaskName Название для отображения при привязке к задаче, например, вес товара.
bindToSubscriberName Название для отображения при привязке к сотруднику, например, грузоподъемность автомобиля.
externalID Внешний ИД компетенции.

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

POST /v6/api/competenceManagement/competences HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "competenceGroupID": integer,
    "name": "string",
    "defaultServiceTime": integer,
    "isQuantitative": boolean,
    "isAdditive": boolean,
    "isExhaustible": boolean,
    "unit": "string",
    "reserveRatioPercent": number,
    "bindToTaskName": "string",
    "bindToSubscriberName": "string",
    "externalID": "string"
}

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

POST /v6/api/competenceManagement/competences HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "competenceGroupID": 1,
    "name": "Сбор заказов",
    "defaultServiceTime": 30,
    "isQuantitative": true,
    "isAdditive": true,
    "isExhaustible": true,
    "unit": "кг",
    "reserveRatioPercent": 10,
    "bindToTaskName": "Вес товара",
    "bindToSubscriberName": "Вес товара",
    "externalID": "123"
}

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

\{
    "competenceID": integer,
    "taskTypeIDs": [
        integer
    ],
    "competenceGroupID": integer,
    "name": "string",
    "defaultServiceTime": integer,
    "isQuantitative": boolean,
    "isAdditive": boolean,
    "isExhaustible": boolean,
    "unit": "string",
    "reserveRatioPercent": number,
    "bindToTaskName": "string",
    "bindToSubscriberName": "string",
    "externalID": "string"
}

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

\{
    "competenceID": 1,
    "taskTypeIDs": [
        2
    ],
    "competenceGroupID": 1,
    "name": "Сбор заказов",
    "defaultServiceTime": 30,
    "isQuantitative": true,
    "isAdditive": true,
    "isExhaustible": true,
    "unit": "кг",
    "reserveRatioPercent": 10,
    "bindToTaskName": "Вес товара",
    "bindToSubscriberName": "Вес товара",
    "externalID": "123"
}

Обновление компетенции

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

Функция позволяет обновить компетенцию (должны быть переданы все атрибуты компетенции для обновления, т.е. компетенция обновляется полностью).

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

Функция имеет следующие параметры:

Параметр Описание
competenceGroupID ИД группы компетенции (обязательный параметр)
name Название компетенции (обязательный параметр)
defaultServiceTime Типовое время выполнения задачи (в минутах)
isQuantitative Количественный ресурс компетенции. Существуют следующие значения:
  • true — задача будет назначена сотруднику, если у него хватает ресурса на ее выполнение. Например, если у сотрудника 4 запасных детали, то он не сможет выполнить задачу, в которой требуется 6 деталей.
  • false — проверка наличия компетенции у сотрудника для выполнения задачи.
isAdditive Нужно ли суммировать ресурсы задач для выбора нужного сотрудника. Существуют следующие значения:
  • true — количество ресурсов у сотрудника суммируется, чтобы его хватило на все планируемые для сотрудника задачи. Например, у сотрудника должно быть суммарно не больше запасных деталей, чем может вместиться в машину.
  • false — задача не будет назначена, если у сотрудника недостаточно ресурса. Например, если у грузовика длина кузова 3 метра, а длина лестницы 4 метра, то сотрудник не сможет выполнить задачу.
isExhaustible Исчерпаемый ресурс. Существуют следующие значения:
  • true — ресурс тратится при выполнении задачи. Например, у сотрудника было 4 запасных детали, после выполнения осталось 2. Следующая задача с 3 деталями уже не будет назначена.
  • false — количество ресурса не меняется после выполнения задачи. Например, до выполнения задачи у сотрудника были 2 холодильные установки в кузове, после осталось 2.
unit Единица измерения ресурса (необязательный параметр).
reserveRatioPercent Коэффициент запаса компетенции в процентах (необязательный параметр). Например, если у сотрудника ресурс 100 по компетенции с коэффициентом 10%, то он сможет только то количество задач, которое укладывается в его ресурс с учетом запаса.
bindToTaskName Название для отображения при привязке к задаче, например, вес товара.
bindToSubscriberName Название для отображения при привязке к сотруднику, например, грузоподъемность автомобиля.
externlID Внешний идентификатор компетенции.

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

При успешном выполнении возвращается статус 204.

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

PUT /v6/api/competenceManagement/competences/\{competenceID} HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "competenceGroupID": integer,
    "name": "string",
    "defaultServiceTime": integer,
    "isQuantitative": boolean,
    "isAdditive": boolean,
    "isExhaustible": boolean,
    "unit": "string",
    "reserveRatioPercent": number,
    "bindToTaskName": "string",
    "bindToSubscriberName": "string",
    "externalID": "string"
}

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

PUT /v6/api/competenceManagement/competences/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "competenceGroupID": 1,
    "name": "Сбор заказов",
    "defaultServiceTime": 50,
    "isQuantitative": true,
    "isAdditive": true,
    "isExhaustible": true,
    "unit": "кг",
    "reserveRatioPercent": 10,
    "bindToTaskName": "Вес товара",
    "bindToSubscriberName": "Вес товара",
    "externalID": "123"
}

Удаление компетенции

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

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

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

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

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

При успешном выполнении возвращается статус 204.

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

DELETE /v6/api/competenceManagement/competences/\{competenceID} HTTP/1.1
Host: host
Authorization: Bearer token

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

DELETE /v6/api/competenceManagement/competences/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Работа с GPS-местоположениями и треками

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

Работа с объектами

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

Содержание

Получение списка компетенцийПолучение компетенции по ее идентификаторуСоздание компетенцииОбновление компетенцииУдаление компетенции