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

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

Работа с сотрудниками

Получение списка сотрудников

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

Функция позволяет получить список всех сотрудников.

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

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

Параметр Описание
withCustomTemplateItems Нужно ли отображать дополнительные поля Сотрудника. Существуют следующие значения:

true — нужно возвращать дополнительные поля;
false — без дополнительных полей.
zoneIDs ИД зон. 
zoneGroupIDs ИД групп зон. 
isActive Нужно ли возвращать только активных Сотрудников. Существуют следующие значения:
true — нужно возвращать только активных Сотрудников;
false — нужно возвращать всех Сотрудников.

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

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

Параметр Описание
subscriberID ИД Сотрудника
subscriberTariffTypeID ИД тарифа Сотрудника. Существуют следующие значения:
9 – М2М.
10 – тариф «Эконом».
11 – тариф «Стандарт».
12 – тариф «Бизнес».
13 – тариф «Премиум».
canTrack Право устанавливать автоматическое расписание запросов Сотруднику. Существуют следующие значения:
true – можно устанавливать автоматическое расписание запросов Сотруднику.
false – нельзя устанавливать автоматическое расписание запросов Сотруднику.
canRequest Право делать запросы местоположения Сотрудника. Существуют следующие значения:
true – можно делать запросы местоположения Сотрудника.
false – нельзя делать запросы местоположения Сотрудника.
canSend Право отправлять SMS-сообщения Сотруднику. Существуют следующие значения:
true – можно отправлять SMS-сообщения Сотруднику.
false – нельзя отправлять SMS-сообщения Сотруднику.
isOnline Находится ли Сотрудник онлайн в приложении «МТС Координатор». Существуют следующие значения:
true – Сотрудник находится онлайн.
false – Сотрудник находится офлайн.
isLocateEnabled Включено ли определение местоположения. Существуют следующие значения:
true – определение местоположения включено.
false – определение местоположения выключено.
phone Телефон Сотрудника.
icon Иконка Сотрудника.
subscriberGroupID ИД группы Сотрудника.
name ФИО Сотрудника.
externalSubscriberID Внешний ИД Сотрудника.
allowedOvertime Время допустимой переработки.
workScheduleID ИД графика работы.
startLocationLatitude Географическая широта начальной точки работы (в градусах).
startLocationLongitude Географическая долгота начальной точки работы (в градусах).
customFieldFormTemplateID ИД шаблона дополнительных полей Сотрудника
Параметры дополнительных полей Сотрудника (массив структур customFieldFormItems)
externalID ИД дополнительного поля
name Название дополнительного поля
value Значение дополнительного поля
type Тип дополнительного поля. Существуют следующие типы:
string – строка;
text – текст;
date – дата;
time – время;
integer – целое число;
double – вещественное число;
boolean – галочка;
select – список;
picture – изображение;
file – файл.

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

GET /v6/api/subscriberManagement/subscribers?withCustomTemplateItems=\{boolean} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/subscriberManagement/subscribers?withCustomTemplateItems=1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

[
    \{
        "subscriberID": integer,
        "subscriberTariffTypeID": integer,
        "canTrack": boolean,
        "canRequest": boolean,
        "canSend": boolean,
        "isOnline": boolean,
        "isLocateEnabled": boolean,
        "icon": integer,
        "subscriberGroupID": integer,
        "name": "string",
        "externalSubscriberID": "string",
        "allowedOvertime": integer,
        "workScheduleID": integer,
        "startLocationLatitude": number,
        "customFieldsFormTemplateID": integer,
        "customFieldFormItems": [
            \{
                "externalID": "string",
                "name": "string",
                "value": "string",
                "type": "string"
            }
        ]
    }
]

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

[
    \{
        "subscriberID": 1,
        "subscriberTariffTypeID": 13,
        "canTrack": true,
        "canRequest": true,
        "canSend": true,
        "isOnline": true,
        "isLocateEnabled": true,
        "icon": 1,
        "subscriberGroupID": 1,
        "name": "Сидоров Дмитрий",
        "externalSubscriberID": "1",
        "allowedOvertime": 10,
        "workScheduleID": 1,
        "startLocationLatitude": 55.880038660223,
        "startLocationLongitude": 37.4339011096192,
        "customFieldsFormTemplateID": 1,
        "customFieldFormItems": [
            \{
                "externalID": "1",
                "name": "Время работы",
                "value": "10:00 – 14:00",
                "type": "string"
            }
        ]
    }
]

Получение сотрудника

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

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

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

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

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

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

Параметр Описание
subscriberID ИД Сотрудника
subscriberTariffTypeID ИД тарифа Сотрудника. Существуют следующие значения:
9 – М2М.
10 – тариф «Эконом».
11 – тариф «Стандарт».
12 – тариф «Бизнес».
13 – тариф «Премиум».
canTrack Право устанавливать автоматическое расписание запросов Сотруднику. Существуют следующие значения:
true – можно устанавливать автоматическое расписание запросов Сотруднику.
false – нельзя устанавливать автоматическое расписание запросов Сотруднику.
canRequest Право делать запросы местоположения Сотрудника. Существуют следующие значения:
true – можно делать запросы местоположения Сотрудника.
false – нельзя делать запросы местоположения Сотрудника.
canSend Право отправлять SMS-сообщения Сотруднику. Существуют следующие значения:
true – можно отправлять SMS-сообщения Сотруднику.
false – нельзя отправлять SMS-сообщения Сотруднику.
isOnline Находится ли Сотрудник онлайн в приложении «МТС Координатор». Существуют следующие значения:
true – Сотрудник находится онлайн.
false – Сотрудник находится офлайн.
isLocateEnabled Включено ли определение местоположения. Существуют следующие значения:
true – определение местоположения включено.
false – определение местоположения выключено.
phone Телефон Сотрудника.
icon Иконка Сотрудника.
subscriberGroupID ИД группы Сотрудника.
name ФИО Сотрудника.
externalSubscriberID Внешний ИД Сотрудника.
allowedOvertime Время допустимой переработки.
workScheduleID ИД графика работы.
startLocationLatitude Географическая широта начальной точки работы (в градусах).
startLocationLongitude Географическая долгота начальной точки работы (в градусах).
customFieldFormTemplateID ИД шаблона дополнительных полей Сотрудника
Параметры дополнительных полей Сотрудника (массив структур customFieldFormItems)
externalID ИД дополнительного поля
name Название дополнительного поля
value Значение дополнительного поля
type Тип дополнительного поля. Существуют следующие типы:
string – строка;
text – текст;
date – дата;
time – время;
integer – целое число;
double – вещественное число;
boolean – галочка;
select – список;
picture – изображение;
file – файл.

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

GET /v6/api/subscriberManagement/subscribers/\{subsciberID}/  HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/subscriberManagement/subscribers/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

\{
    "subscriberID": integer,
    "subscriberTariffTypeID": integer,
    "canTrack": boolean,
    "canRequest": boolean,
    "canSend": boolean,
    "isOnline": boolean,
    "isLocateEnabled": boolean,
    "icon": integer,
    "subscriberGroupID": integer,
    "name": "string",
    "externalSubscriberID": "string",
    "allowedOvertime": integer,
    "workScheduleID": integer,
    "startLocationLatitude": number,
    "startLocationLongitude": number,
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ]
}

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

\{
    "subscriberID": 1,
    "subscriberTariffTypeID": 13,
    "canTrack": true,
    "canRequest": true,
    "canSend": true,
    "isOnline": true,
    "isLocateEnabled": true,
    "icon": 1,
    "subscriberGroupID": 1,
    "name": "Сидоров Дмитрий",
    "externalSubscriberID": "1",
    "allowedOvertime": 10,
    "workScheduleID": 1,
    "startLocationLatitude": 55.880038660223,
    "startLocationLongitude": 37.4339011096192,
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "name": "Время работы",
            "value": "10:00 – 14:00",
            "type": "string"
        }
    ]
}

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

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

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

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

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

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

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

Параметр Описание
subscriberID ИД Сотрудника
subscriberTariffTypeID ИД тарифа Сотрудника. Существуют следующие значения:
9 – М2М.
10 – тариф «Эконом».
11 – тариф «Стандарт».
12 – тариф «Бизнес».
13 – тариф «Премиум».
canTrack Право устанавливать автоматическое расписание запросов Сотруднику. Существуют следующие значения:
true – можно устанавливать автоматическое расписание запросов Сотруднику.
false – нельзя устанавливать автоматическое расписание запросов Сотруднику.
canRequest Право делать запросы местоположения Сотрудника. Существуют следующие значения:
true – можно делать запросы местоположения Сотрудника.
false – нельзя делать запросы местоположения Сотрудника.
canSend Право отправлять SMS-сообщения Сотруднику. Существуют следующие значения:
true – можно отправлять SMS-сообщения Сотруднику.
false – нельзя отправлять SMS-сообщения Сотруднику.
isOnline Находится ли Сотрудник онлайн в приложении «МТС Координатор». Существуют следующие значения:
true – Сотрудник находится онлайн.
false – Сотрудник находится офлайн.
isLocateEnabled Включено ли определение местоположения. Существуют следующие значения:
true – определение местоположения включено.
false – определение местоположения выключено.
phone Телефон Сотрудника.
icon Иконка Сотрудника.
subscriberGroupID ИД группы Сотрудника.
name ФИО Сотрудника.
externalSubscriberID Внешний ИД Сотрудника.
allowedOvertime Время допустимой переработки.
workScheduleID ИД графика работы.
startLocationLatitude Географическая широта начальной точки работы (в градусах).
startLocationLongitude Географическая долгота начальной точки работы (в градусах).
customFieldFormTemplateID ИД шаблона дополнительных полей Сотрудника
Параметры дополнительных полей Сотрудника (массив структур customFieldFormItems)
externalID ИД дополнительного поля
name Название дополнительного поля
value Значение дополнительного поля
type Тип дополнительного поля. Существуют следующие типы:
string – строка;
text – текст;
date – дата;
time – время;
integer – целое число;
double – вещественное число;
boolean – галочка;
select – список;
picture – изображение;
file – файл.

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

GET /v6/api/subscriberManagement/subscribers/externalID/\{externalID} /\{subsciberID}  HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/subscriberManagement/subscribers/externalID/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

\{
    "subscriberID": integer,
    "subscriberTariffTypeID": integer,
    "canTrack": boolean,
    "canRequest": boolean,
    "canSend": boolean,
    "isOnline": boolean,
    "isLocateEnabled": boolean,
    "icon": integer,
    "subscriberGroupID": integer,
    "name": "string",
    "externalSubscriberID": "string",
    "allowedOvertime": integer,
    "workScheduleID": integer,
    "startLocationLatitude": number,
    "startLocationLongitude": number,
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ]
}

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

\{
    "subscriberID": 1,
    "subscriberTariffTypeID": 13,
    "canTrack": true,
    "canRequest": true,
    "canSend": true,
    "isOnline": true,
    "isLocateEnabled": true,
    "icon": 1,
    "subscriberGroupID": 1,
    "name": "Сидоров Дмитрий",
    "externalSubscriberID": "1",
    "allowedOvertime": 10,
    "workScheduleID": 1,
    "startLocationLatitude": 55.880038660223,
    "startLocationLongitude": 37.4339011096192,
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "name": "Время работы",
            "value": "10:00 – 14:00",
            "type": "string"
        }
    ]
}

Обновление сотрудника

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

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

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

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

Параметр Описание
subscriberID ИД Сотрудника (обязательный параметр).
icon Иконка Сотрудника.
subscriberGroupID ИД группы Сотрудника.
name ФИО Сотрудника.
externalSubscriberID Внешний ИД Сотрудника.
allowedOvertime Время допустимой переработки.
workScheduleID ИД графика работы.
startLocationLatitude Географическая широта начальной точки работы (в градусах).
startLocationLongitude Географическая долгота начальной точки работы (в градусах).
customFieldFormTemplateID ИД шаблона дополнительных полей Сотрудника.
Параметры дополнительных полей Сотрудника (массив структур customFieldFormItems)
externalID ИД дополнительного поля.
value Значение дополнительного поля.

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

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

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

PUT /v6/api/subscriberManagement/subscribers/\{subscriberID} HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "icon": integer,
    "subscriberGroupID": integer,
    "name": "string",
    "externalSubscriberID": "string",
    "allowedOvertime": integer,
    "workScheduleID": integer,
    "startLocationLatitude": number,
    "startLocationLongitude": number,
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "value": "string"
        }
    ]
}

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

PUT /v6/api/subscriberManagement/subscribers/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "icon": 2,
    "subscriberGroupID": 2,
    "name": "Сидоров Анатолий",
    "externalSubscriberID": "1",
    "allowedOvertime": 20,
    "workScheduleID": 2,
    "startLocationLatitude": 55.880038660225,
    "startLocationLongitude": 37.4339011096191,
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "value": "79161234567"
        }
    ]
}

Изменение сотрудника

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

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

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

Функция имеет следующие параметры (если параметр не передан при вызове функции, то его значение не меняется):

Параметр Описание
subscriberID ИД Сотрудника (обязательный параметр).
icon Иконка Сотрудника.
subscriberGroupID ИД группы Сотрудника.
name ФИО Сотрудника.
externalSubscriberID Внешний ИД Сотрудника.
allowedOvertime Время допустимой переработки.
workScheduleID ИД графика работы.
startLocationLatitude Географическая широта начальной точки работы (в градусах).
startLocationLongitude Географическая долгота начальной точки работы (в градусах).
customFieldFormTemplateID ИД шаблона дополнительных полей Сотрудника.
Параметры дополнительных полей Сотрудника (массив структур customFieldFormItems)
externalID ИД дополнительного поля.
value Значение дополнительного поля.

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

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

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

PATCH /v6/api/subscriberManagement/subscribers/\{subscriberID} HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "icon": integer,
    "subscriberGroupID": integer,
    "name": "string",
    "externalSubscriberID": "string",
    "allowedOvertime": integer,
    "workScheduleID": integer,
    "startLocationLatitude": number,
    "startLocationLongitude": number,
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "value": "string"
        }
    ]
}

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

PATCH /v6/api/subscriberManagement/subscribers/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "icon": 2,
    "subscriberGroupID": 2,
    "name": "Сидоров Анатолий",
    "externalSubscriberID": "1",
    "allowedOvertime": 20,
    "workScheduleID": 2,
    "startLocationLatitude": 55.880038660225,
    "startLocationLongitude": 37.4339011096191,
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "value": "79161234567"
        }
    ]
}

Удаление сотрудника

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

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

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

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

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

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

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

DELETE /v6/api/subscriberManagement/subscribers/\{subsciberID} HTTP/1.1
Host: host
Authorization: Bearer token

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

DELETE /v6/api/subscriberManagement/subscribers/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Получение списка групп сотрудников

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

Функция позволяет получить список групп сотрудников.

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

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

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

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

                                                                                                                               

Параметр Описание
subscriberGroupID ИД группы сотрудников
parentID ИД родительской группы
name Название группы сотрудников
color Цвет группы; числовые обозначения цветов см. п. 28.1
regionID ИД региона

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

GET /v6/api/subscriberManagement/subscriberGroups HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/subscriberManagement/subscriberGroups HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

[
    \{
        "subscriberGroupID": integer,
        "parentID": integer,
        "name": "string",
        "color": integer,
        "regionID": integer
    },
    \{
        "subscriberGroupID": integer,
        "parentID": integer,
        "name": "string",
        "color": integer,
        "regionID": integer
    }
]

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

[
    \{
        "subscriberGroupID": 2,
        "parentID": 1,
        "name": "Курьеры",
        "color": 0,
        "regionID": 1
    },
    \{
        "subscriberGroupID": 3,
        "parentID": 1,
        "name": "Монтажники",
        "color": 5,
        "regionID": 1
    }
]

Получение группы сотрудников

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

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

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

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

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

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

                                                                                                                               

Параметр Описание
subscriberGroupID ИД группы Сотрудников
parentID ИД родительской группы
name Название группы Сотрудников
color Цвет группы; числовые обозначения цветов см. п. 28.1
regionID ИД региона

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

GET /v6/api/subscriberManagement/subscriberGroups/\{subscriberGroupID} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/subscriberManagement/subscriberGroups/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

\{
    "subscriberGroupID": integer,
    "parentID": integer,
    "name": "string",
    "color": integer,
    "regionID": integer
}

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

\{
    "subscriberGroupID": 2,
    "parentID": 1,
    "name": "Курьеры",
    "color": 10,
    "regionID": 1
}

Добавление группы сотрудников

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

Функция позволяет добавить группу Сотрудников.

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

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

Параметр Описание
parentID ИД родительской группы
name Название группы Сотрудников (обязательный параметр)
color Цвет группы; числовые обозначения цветов см. п. 28.1.
regionID ИД региона

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

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

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

Параметр Описание
subscriberGroupID ИД группы Сотрудников
parentID ИД родительской группы
name Название группы Сотрудников
color Цвет группы; числовые обозначения цветов см. п. 28.1
regionID ИД региона

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

POST /v6/api/subscriberManagement/subscriberGroups HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "parentID": integer,
    "name": "string",
    "color": integer,
    "regionID": integer	
}

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

POST /v6/api/subscriberManagement/subscriberGroups HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "parentID": 1,
    "name": "Водители",
    "color": 5,
    "regionID": 1
}

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

\{
    "subscriberGroupID": integer,
    "parentID": integer,
    "name": "string",
    "color": integer,
    "regionID": integer
}

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

\{
    "subscriberGroupID": 2,
    "parentID": 1,
    "name": "Водители",
    "color": 5,
    "regionID": 1
}

Обновление группы сотрудников

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

Функция позволяет обновить группу сотрудников.

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

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

Параметр Описание
subscriberGroupID ИД группы сотрудников
parentID ИД родительской группы
name Название группы сотрудников (обязательный параметр)
color Цвет группы
regionID ИД региона

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

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

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

PUT /v6/api/subscriberManagement/subscriberGroups HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "parentID": integer,
    "name": "string",
    "color": integer,
    "regionID": integer	
}

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

PUT /v6/api/subscriberManagement/subscriberGroups HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "parentID": 1,
    "name": "Водители",
    "color": 5,
    "regionID": 1
}

 

Удаление группы сотрудников

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

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

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

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

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

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

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

DELETE /v6/api/subscriberManagement/subscriberGroups/\{subscriberGroupID} HTTP/1.1
Host: host
Authorization: Bearer token

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

DELETE /v6/api/subscriberManagement/subscriberGroups/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

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

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

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

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

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

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

Параметр Описание
competenceID ИД компетенции
weight Значение веса компетенции
amount Значение количественной меры компетенции

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

GET /v6/api/subscriberManagement/subscribers/\{subscriberID}/competences HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/subscriberManagement/subscribers/1/competences HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

[
    \{
        "competenceID": integer,
        "weight": number,
        "amount": number
    },
    \{
        "competenceID": integer,
        "weight": number,
        "amount": number
    }
]

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

[
    \{
        "competenceID": 1,
        "weight": 50,
        "amount": 50
    },
    \{
        "competenceID": 2,
        "weight": 50,
        "amount": 50
    }
]

Закрепление компетенций за сотрудником

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

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

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

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

Параметр Описание
subscriberID ИД Сотрудника (обязательный параметр)
competenceID ИД компетенции (обязательный параметр)
weight Значение веса компетенции
amount Значение количественной меры компетенции

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

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

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

Параметр Описание
competenceID ИД компетенции
weight Значение веса компетенции
amount Значение количественной меры компетенции

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

POST /v6/api/subscriberManagement/subscribers/\{subscriberID}/competences HTTP/1.1
Host: host
Authorization: Bearer token

[
    \{
        "competenceID": integer,
        "weight": number,
        "amount": number
    },
    \{
        "competenceID": integer,
        "weight": number,
        "amount": number
    }
]

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

POST /v6/api/subscriberManagement/subscribers/1/competences HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

[
    \{
        "competenceID": 1,
        "weight": 50,
        "amount": 50
    },
    \{
        "competenceID": 2,
        "weight": 50,
        "amount": 50
    }
]

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

[
    \{
        "competenceID": integer,
        "weight": number,
        "amount": number
    },
    \{
        "competenceID": integer,
        "weight": number,
        "amount": number
    }
]

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

[
    \{
        "competenceID": 1,
        "weight": 50,
        "amount": 50
    },	
    \{
        "competenceID": 2,
        "weight": 50,
        "amount": 50	
    }
]

Открепление привязанной компетенции от сотрудника

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

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

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

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

Параметр Описание
subscriberID ИД сотрудника (обязательный параметр)
competenceID ИД компетенции (обязательный параметр)

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

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

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

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

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

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

Получение весогабаритных характеристик компетенций сотрудника

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

Функция позволяет получить весогабаритные характеристики, привязанные к сотруднику.

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

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

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

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

Параметр Описание
weight Вес (кг)
unit Юниты
width Ширина (м)
height Высота (м)
length Длина (м)
volume Объем (м3)

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

GET /v6/api/subscriberManagement/subscribers/\{subscriberID}/dimension HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/subscriberManagement/subscribers/1/dimensions HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

\{
  "weight": number,
  "unit": number,
  "width": number,
  "height": number,
  "length": number,
  "volume": number
}

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

\{
  "weight": 5,
  "unit": 5,
  "width": 5,
  "height": 5,
  "length": 5,
  "volume": 5
}

Обновление весогабаритных характеристик сотрудника

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

Функция позволяет обновить весогабаритные характеристики, привязанные к сотруднику.

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

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

Параметр Описание
subscriberID Идентификатор сотрудника
weight Вес (кг)
unit Юниты
width Ширина (м)
height Высота (м)
length Длина (м)
volume Объем (м3)

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

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

Функция возвращает структуру с обновленными параметрами весогабаритных характеристик:

Параметр Описание
weight Вес (кг)
unit Юниты
width Ширина (м)
height Высота (м)
length Длина (м)
volume Объем (м3)

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

PUT /v6/api/subscriberManagement/subscribers/\{subscriberID}/dimension HTTP/1.1
Host: host
Authorization: Bearer token

\{
  "weight": number,
  "unit": number,
  "width": number,
  "height": number,
  "length": number,
  "volume": number
}

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

PUT /v6/api/subscriberManagement/subscribers/1/dimensions HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
  "weight": 105,
  "unit": 50,
  "width": 5,
  "height": 5,
  "length": 5,
  "volume": 5
}

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

\{
  "weight": number,
  "unit": number,
  "width": number,
  "height": number,
  "length": number,
  "volume": number
}

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

\{
  "weight": 5,
  "unit": 5,
  "width": 5,
  "height": 5,
  "length": 5,
  "volume": 5
}

Получения списка гео-зон Сотрудника

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

Функция позволяет получить список гео-зон, привязанных к сотруднику.

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

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

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

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

Параметр Описание
zoneID ИД гео-зоны
bindingType Тип привязанной гео-зоны. Существуют следующие значения: 0 – основная гео-зона; 1 – дополнительная гео-зона.

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

GET /v6/api/subscriberManagement/subscribers/\{subscriberID}/zones HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/subscriberManagement/subscribers/1/zones HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

[
    \{
        "zoneID": integer,
        "bindingType": integer
    },
    \{
        "zoneID": integer,
        "bindingType": integer
    }
]

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

[
    \{
        "zoneID": 1,
        "bindingType": 0
    },
    \{
        "zoneID": 2,
        "bindingType": 1
    }
]

Закрепление гео-зон за сотрудником

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

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

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

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

Параметр Описание
subscriberID ИД сотрудника (обязательный параметр)
zoneID ИД гео-зоны (обязательный параметр)
bindingType Тип привязанной гео-зоны. Существуют следующие значения:0 – основная гео-зона; 1 – дополнительная гео-зона.

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

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

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

Параметр Описание
zoneID ИД гео-зоны
bindingType Тип привязанной гео-зоны. Существуют следующие значения: 0 – основная гео-зона; 1 – дополнительная гео-зона.

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

POST /v6/api/subscriberManagement/subscribers/\{subscriberID}/zones HTTP/1.1
Host: host
Authorization: Bearer token

[
    \{
        "zoneID": integer,
        "bindingType": integer
    },
    \{
        "zoneID": integer,
        "bindingType": integer
    }
]

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

POST /v6/api/subscriberManagement/subscribers/1/zones HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

[
    \{
        "zoneID": 1,
        "bindingType": 0
    },
    \{
        "zoneID": 2,
        "bindingType": 1
    }
]

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

[
    \{
        "zoneID": integer,
        "bindingType": integer
    },
    \{
        "zoneID": integer,
        "bindingType": integer
    }
]

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

[
    \{
        "zoneID": 1,
        "bindingType": 0
    },
    \{
        "zoneID": 2,
        "bindingType": 1
    }
]

Открепление привязанной гео-зоны от сотрудника

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

Функция позволяет открепить гео-зону от сотрудника.

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

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

Параметр Описание
subscriberID ИД сотрудника (обязательный параметр)
zoneID ИД гео-зоны (обязательный параметр)

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

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

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

DELETE /v6/api/subscriberManagement/subscribers/\{subscriberID}/zones/\{zoneID} HTTP/1.1
Host: host
Authorization: Bearer token

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

DELETE /v6/api/subscriberManagement/subscribers/1/zones/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Запрос местоположения сотрудников

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

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

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

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

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

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

Параметр Описание
subscriberID ИД сотрудника
requestID ИД запроса

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

POST /v6/api/subscriberManagement/subscriberRequests?subscriberIDs=\{integer} HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

POST /v6/api/subscriberManagement/subscriberRequests?subscriberIDs=1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

[
    \{
        "subscriberID": integer,
        "requestID": integer
    }
]

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

[
    \{
        "subscriberID": 1,
        "requestID": 1
    }
]

Получение местоположения сотрудника

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

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

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

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

ИД запроса (requestID) соответствует ИД местоположения (locationID), который возвращается в ответе в функции получения мобильных (MPS) местоположений сотрудников (подробнее см. Запрос местоположения сотрудников).

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

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

Параметр Описание
responseCode Код результата запроса местоположения; описание кодов см. 29.5
locationDate Дата, время местоположения (подробнее о формате времени)
objectID ИД ближайшего пользовательского объекта, находящегося в радиусе погрешности определения местоположения
subscriberID ИД сотрудника
state Статус выполнения запроса. Существуют следующие значения: 0 — новый запрос, в очереди на обработку; 1 — запрос на обработке, выполняется позиционирование; 2 — местоположение определено успешно; 3 — ошибка определения местоположения; 4 — последнее известное местоположение; 5 — Сотрудник недоступен.
source Источник запроса. Существуют следующие значения: -1 — неизвестен; >0 — веб-интерфейс; 1 — запрос по SMS; 2 — Сотрудник сам инициировал определение местоположения; 3 — по интервалу; 4 — по расписанию; 6 — зафиксировано событие; 8 — веб-сервис управления Услугой; 9 — действия по запросу Оператора; 0 — действие, инициированное Платформой; 15 — запрос инициирован из приложения; 16 — запрос инициирован USSD-командой; 17 — запрос инициирован с iPhone; 18 — запрос инициирован с iPad; 19 — запрос инициирован с Android; 20 — по сменному графику; 23 — B2B; 24 — интерворкинг; 26 — сервис онлайн-позиционирования.
requestID ИД запроса.
ИД запроса (requestID) соответствует ИД местоположения (locationID), который возвращается в ответе в функции получения мобильных (MPS) местоположений Сотрудников (подробнее см. Запрос местоположения сотрудников).
requestDate Дата, время запроса местоположения (подробнее о формате времени)
address Адрес местоположения
longitude Географическая долгота местоположения (в градусах)
latitude Географическая широта местоположения (в градусах)
radius Радиус погрешности определения местоположения (в метрах)
isLocationExists Были ли в результате запроса получены координаты. Существуют следующие значения:true – координаты получены; false – координаты не получены.
requestText Текст, отправленный абонентом (когда он сообщает о своём местоположении, отправив sms-сообщение на веб-сайт)
objectIDs ИД объектов, находящихся в радиусе погрешности определения местоположения
Параметры зоны пребывания (shape)
radius Внешний радиус (в метрах)
centerLongitude Географическая долгота центра зоны (в градусах)
centerLatitude Географическая широта центра зоны (в градусах)
Информация о гео-зоне (zoneInfo)
zoneID ИД гео-зоны
zoneName Название гео-зоны
zoneColor Цвет гео-зоны; числовые обозначения цветов см. п.
entryState Статус пребывания в зоне: 0 – внутри зоны; 1 – снаружи.
violationStatus Условие контроля зоны: 0 – нет нарушения; 1 – нарушение.
controlEntry Сигнальный режим: 0 – не установлен; 1 – вход в зону; 2 – выход из зоны; 3 – вход в зону или выход из неё.
rawXml Сервисная информация о гео-зоне

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

GET /v6/api/subscriberManagement/subscriberRequests?requestIDs=\{long}  HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

GET /v6/api/subscriberManagement/subscriberRequests?requestIDs=1&?requestIDs=2 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

\{
    "responseCode": integer,
    "locationDate": "dateTime",
    "objectID": integer,
    "subscriberID": integer,
    "state": integer,
    "source": integer,
    "requestID": integer,
    "requestDate": "dateTime",
    "address": "string",
    "longitude": number,
    "latitude": number,
    "shape": \{
        "radius": integer,
        "centerLongitude": number,
        "centerLatitude": number
    },
    "radius": integer,
    "isLocationExists": boolean,
    "requestText": "string",
    "zoneInfo": \{
        "items": [
            \{
                "zoneID": integer,
                "zoneName": "string",
                "zoneColor": integer,
                "entryState": integer,
                "violationStatus": integer,
                "controlEntry": integer
            }
        ],
        "rawXml": [
            \{}
        ]
    },
    "objectIDs": [
        integer
    ]
}

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

\{
    "responseCode": 0,
    "locationDate": "2021-11-26T17:34:53+03:00",
    "objectID": 1,
    "subscriberID": 1,
    "state": 2,
    "source": 23,
    "requestID": 1,
    "requestDate": "2021-11-26T17:34:53+03:00",
    "address": "г. Москва, пересечение просп. Центральный и пр. Савелкинский",
    "longitude": 37.212070000000004,
    "latitude": 55.993580,
    "shape": \{
        "radius": 300,
        "centerLongitude": 37.212070000000004,
        "centerLatitude": 55.99358
    },
    "radius": 300,
    "isLocationExists": true,
    "requestText": "text",
    "zoneInfo": \{
        "items": [
            \{
                "zoneID": 1,
                "zoneName": "Москва",
                "zoneColor": 0,
                "entryState": 0,
                "violationStatus": 0,
                "controlEntry": 0
            }
        ],
        "rawXml": [
            \{}
        ]
    },
    "objectIDs": [
        1
    ]
}

Получение последнего известного местоположения сотрудников

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

Функция позволяет получить последние известные местоположения сотрудников.

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

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

Параметр Описание
subscriberIDs ИД сотрудников. Подробнее о передаче нескольких идентификаторов
subscriberGroupIDs ИД групп сотрудников. Подробнее о передаче нескольких идентификаторов

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

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

Параметр Описание
locationDate Дата, время местоположения (подробнее о формате времени)
subscriberID ИД сотрудника
subscriberGroupID ИД группы сотрудника
longitude Географическая долгота местоположения (в градусах)
latitude Географическая широта местоположения (в градусах)
radius Радиус погрешности определения местоположения (в метрах)
Дополнительная информация о сотруднике (структура addInfo)
chargeLevel Уровень заряда телефона сотрудника

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

GET /v6/api/subscriberManagement/subscribers/lastLocations?subscriberIDs=\{integer}&subscriberGroupIDs=\{integer} HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

GET /v6/api/subscriberManagement/subscribers/lastLocations?subscriberIDs=1&subscriberGroupIDs=1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

[
    \{
        "locationDate": "dateTime",
        "subscriberID": integer,
        "subscriberGroupID": integer,
        "longitude": number,
        "latitude": number,
        "radius": integer,
        "addInfo": \{
            "chargeLevel": integer
        }
    },
    \{
        "locationDate": "dateTime",
        "subscriberID": integer,
        "subscriberGroupID": integer,
        "longitude": number,
        "latitude": number,
        "radius": integer,
        "addInfo": \{
            "chargeLevel": integer
        }
    }
]

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

[
    \{
        "locationDate": "2022-06-16T16:03:31+03:00",
        "subscriberID": 1,
        "subscriberGroupID": 16,
        "longitude": 38.8833942,
        "latitude": 56.7454564,
        "radius": 12,
        "addInfo": \{
            "chargeLevel": 91
        }
    },
    \{
        "locationDate": "2022-05-05T12:00:09+03:00",
        "subscriberID": 2,
        "subscriberGroupID": 1,
        "longitude": 20.541400000000003,
        "latitude": 55.00474,
        "radius": 60,
        "addInfo": \{
            "chargeLevel": 58
        }
    }
]

Обновление графика работы сотрудника

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

Функция позволяет обновить график работы Сотрудника.

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

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

Параметр Описание
subscriberID ИД сотрудника (обязательный параметр)
workScheduleGroupID ИД группы графиков работ
name Название графика работы cотрудника
workScheduleTypeID Тип графика работы. Существуют следующие значения: 0 – расписание; 1 – сменный график; 2 – календарь.
startDate Дата начала периода действия графика работы (подробнее о формате времени).
endDate Дата окончания периода действия графика работы (подробнее о формате времени).
autoProlongation Автоматическое продление графика работы. Существуют следующие значения: true – график работы будет продлеваться автоматически; false – график работы не будет продлеваться автоматически.
scheduleSettings Объект с настройками дней недели
Параметры графика работы Сотрудника по каждому дню недели (массив структур scheduleSettings). Для настройки графика работы в структуре соответствующей дня недели (monday — понедельник, tuesday — вторник, wednesday — среда, thursday — четверг, friday — пятница, saturday — суббота, sunday — воскресенье) укажите время начала и окончания работы в этот день.
startTime Время начала работы в выбранный день недели (подробнее о формате времени).
endTime Время окончания работы в выбранный день недели (подробнее о формате времени).
Параметры графика работы Сотрудника с типом «Сменный график» (структура shiftSettings)
shiftType Тип сменного графика. Существуют следующие значения: 0 – два дня через два; 1 – пять дней через два; 2 – три дня через три.
startTime Время начала смены (подробнее о формате времени).
endTime Время окончания смены (подробнее о формате времени).
Параметры исключений в графике работы cотрудника (структура exceptions)
startTime Время начала исключения (подробнее о формате времени).
endTime Время окончания исключения (подробнее о формате времени).
subscriberID ИД cотрудника, в графике работы которого есть исключение
externalID Внешний идентификатор исключения в графике работы
workScheduleItemTypeID ИД типа элемента графика работы
description Описание исключения
Параметры элементов графика работы cотрудника (структура items)
startTime Время начала исключения (подробнее о формате времени).
endTime Время окончания исключения (подробнее о формате времени).
description Описание исключения
workScheduleItemTypeID ИД типа элемента графика работы
externalID Внешний идентификатор элемента графика работы

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

Функция возвращает структуру с параметрами графика работы Сотрудника:

Параметр Описание
workScheduleID ИД графика работы
creationDate Дата начала создания графика работы (подробнее о формате времени)
subscriberID ИД cотрудника 
name Название графика работы cотрудника
workScheduleGroupID ИД группы графика работы
workScheduleType Тип графика работы. Существуют следующие значения: 0 – расписание; 1 – сменный график; 2 – календарь.
startDate Дата начала периода действия графика работы (подробнее о формате времени).
endDate Дата окончания периода действия графика работы (подробнее о формате времени).
autoProlongation Автоматическое продление графика работы. Существуют следующие значения:true – график работы будет продлеваться автоматически; false – график работы не будет продлеваться автоматически.
Параметры графика работы Сотрудника по каждому дню недели (массив структур scheduleSettings)
Параметры графика работы Сотрудника по каждому дню недели (массив структур scheduleSettings). Для настройки графика работы в структуре соответствующего дня недели (monday — понедельник, tuesday — вторник, wednesday — среда, thursday — четверг, friday — пятница, saturday — суббота, sunday — воскресенье) укажите время начала и окончания работы в этот день.
startTime Время начала работы в выбранный день недели (подробнее о формате времени).
endTime Время окончания работы в выбранный день недели (подробнее о формате времени).
Параметры графика работы Сотрудника с типом «Сменный график» (структура shiftSettings)
shiftType Тип сменного графика. Существуют следующие значения:0 – два дня через два; 1 – пять дней через два; 2 – три дня через три.
startTime Время начала смены (подробнее о формате времени).
endTime Время окончания смены (подробнее о формате времени).
Параметры исключений в графике работы Сотрудника (структура exceptions)
exceptionID ИД исключения в графике работы cотрудника
startTime Время начала исключения (подробнее о формате времени).
endTime Время окончания исключения (подробнее о формате времени).
workScheduleItemTypeID ИД типа элемента графика работы
userID ИД пользователя, добавившего исключение в графике работы cотрудника
externalID Внешний идентификатор исключения в графике работы
subscriberID ИД cотрудника, в графике работы которого есть исключение
creationDate Дата начала создания исключения в графике работы (подробнее о формате времени).
description Описание исключения
Параметры рабочего интервала (структура items)
workScheduleItemTypeID ИД типа рабочего интервала
startTime Время начала рабочего интервала (подробнее о формате времени).
creationDate Дата начала создания рабочего интервала (подробнее о формате времени).
description Описание рабочего интервала
endTime Время окончания рабочего интервала (подробнее о формате времени).
workScheduleItemTypeID ИД типа рабочего интервала
userID ИД пользователя, добавившего рабочий интервал
externalID Внешний идентификатор рабочего интервала

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

PUT /v6/api/subscriberManagement/subscribers/\{subscriberID}/workSchedule HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "name": "string",
    "workScheduleGroupID": integer,
    "workScheduleTypeID": integer,
    "startDate": "string",
    "endDate": "string",
    "isAutoProlongation": boolean,
    "scheduleSettings": \{
        "monday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "tuesday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "wednesday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "thursday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "friday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "saturday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "sunday": \{
            "startTime": "string",
            "endTime": "string"
        }
    },
    "shiftSettings": \{
        "shiftTypeID": integer,
        "startTime": "string",
        "endTime": "string"
    },
    "exceptions": [
        \{
            "startDate": "string",
            "endDate": "string",
            "subscriberID": integer,
            "externalID": "string",
            "workScheduleItemTypeID": integer,
            "description": "string"
        }
    ],
    "items": [
        \{
            "startDate": "string",
            "endDate": "string",
            "description": "string",
            "workScheduleItemTypeID": integer,
            "externalID": "string"
        }
    ]
}

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

PUT /v6/api/subscriberManagement/subscribers/1/workSchedule HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "name": "График",
    "workScheduleGroupID": 1,
    "workScheduleTypeID": 0,
    "startDate": "2024-09-16T18:43:50.387",
    "endDate": "2024-10-16T18:00",
    "isAutoProlongation": false,
    "scheduleSettings": \{
        "monday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "tuesday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "wednesday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "thursday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "friday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        }
    },
    "exceptions": [
        \{
            "startDate": "2024-09-17T10:00",
            "endDate": "2024-09-17T10:00",
            "subscriberID": 1,
            "externalID": "123",
            "workScheduleItemTypeID": 2,
            "description": "Командировка"
        }
    ],
    "items": [
        \{
            "startDate": "2024-09-17T10:00",
            "endDate": "2024-09-17T10:00",
            "workScheduleItemTypeID": 2,
            "externalID": "1234"
        }
    ]
}

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

\{
    "workScheduleID": integer,
    "creationDate": "string",
    "name": "string",
    "workScheduleGroupID": integer,
    "workScheduleTypeID": integer,
    "startDate": "string",
    "endDate": "string",
    "isAutoProlongation": boolean,
    "entityType": integer,
    "scheduleSettings": \{
        "monday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "tuesday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "wednesday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "thursday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "friday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "saturday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "sunday": \{
            "startTime": "string",
            "endTime": "string"
        }
    },
    "shiftSettings": \{
        "shiftTypeID": integer,
        "startTime": "string",
        "endTime": "string"
    },
    "exceptions": [
        \{
            "exceptionID": integer,
            "startDate": "string",
            "endDate": "string",
            "workScheduleItemTypeID": integer,
            "userID": integer,
            "externalID": "string",
            "subscriberID": integer,
            "creationDate": "string",
            "description": "string"
        }
    ],
    "items": [
        \{
            "workScheduleItemID": integer,
            "startDate": "string",
            "creationDate": "string",
            "description": "string",
            "endDate": "string",
            "workScheduleItemTypeID": integer,
            "userID": integer,
            "externalID": "string"
        }
    ]
}

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

\{
    "workScheduleID": 1,
    "creationDate": "2024-09-17T10:54:06.570",
    "name": "График",
    "workScheduleGroupID": 1,
    "workScheduleTypeID": 0,
    "startDate": "2024-09-16T18:43:50.387",
    "endDate": "2024-10-16T18:00",
    "isAutoProlongation": false,
    "entityType": 1,
    "scheduleSettings": \{
        "monday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "tuesday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "wednesday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "thursday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "friday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        }
    },
    "exceptions": [
        \{
            "exceptionID": 1,
            "startDate": "2024-09-17T10:00",
            "endDate": "2024-09-17T10:00",
            "workScheduleItemTypeID": 2,
            "userID": 1,
            "externalID": "123",
            "subscriberID": 1,
            "creationDate": "2024-09-17T10:54:06.570",
            "description": "Командировка"
        }
    ],
    "items": [
        \{
            "workScheduleItemID": 2,
            "startDate": "2024-09-17T10:00",
            "creationDate": "2024-09-17T10:54:06.570",
            "description": "Командировка",
            "endDate": "2024-09-17T10:00",
            "workScheduleItemTypeID": 2,
            "userID": 1,
            "externalID": "1234"
        }
    ]
}

Получение рабочих интервалов графика работы cотрудника

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

Функция позволяет получить рабочие интервалы графика работы сотрудника.

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

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

Параметр Описание
subscriberID ИД сотрудника (обязательный параметр)
dateFrom Дата, начиная с которой нужно получить рабочие интервалы (подробнее о формате времени). Если не передать период, то рабочие интервалы вернутся за период в 30 дней, начиная с текущего момента.
dateTo Дата, заканчивая которой нужно получить рабочие интервалы (подробнее о формате времени). Если не передать период, то рабочие интервалы вернутся за период в 30 дней, начиная с текущего момента.

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

Функция возвращает структуру с параметрами графика работы Сотрудника:

Параметр Описание
workScheduleItemTypeID ИД типа рабочего интервала
startTime Время начала рабочего интервала (подробнее о формате времени).
endTime Время окончания рабочего интервала (подробнее о формате времени).
workScheduleItemTypeID ИД типа рабочего интервала
userID ИД пользователя, добавившего рабочий интервал
creationDate Дата начала создания рабочего интервала (подробнее о формате времени).

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

GET /v6/api/subscriberManagement/subscribers/\{subscriberID}/workSchedule/items?dateFrom=\{string}&dateTo=\{string} HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

GET /v6/api/subscriberManagement/subscribers/1/workSchedule/items?dateFrom= 2024-09-17&dateTo=2024-09-19 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

\{
    "items": [
        \{
            "workScheduleItemID": integer,
            "startDate": "string",
            "endDate": "string",
            "workScheduleItemTypeID": integer,
            "userID": integer,
            "creationDate": "string"
        },
        \{
            "workScheduleItemID": integer,
            "startDate": "string",
            "endDate": "string",
            "workScheduleItemTypeID": integer,
            "userID": integer,
            "creationDate": "string"
        }
    ]
}

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

\{
    "items": [
        \{
            "workScheduleItemID": 278,
            "startDate": "2024-09-18T09:00:00",
            "endDate": "2024-09-18T18:00:00",
            "workScheduleItemTypeID": 1,
            "userID": 89051,
            "creationDate": "2024-09-17T12:24:39.293"
        },
        \{
            "workScheduleItemID": 279,
            "startDate": "2024-09-19T09:00:00",
            "endDate": "2024-09-19T18:00:00",
            "workScheduleItemTypeID": 1,
            "userID": 89051,
            "creationDate": "2024-09-17T12:24:39.293"
        }
    ]
}

Получение исключений из рабочего графика сотрудника

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

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

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

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

Параметр Описание
subscriberID ИД сотрудника (обязательный параметр)
dateFrom Дата, начиная с которой нужно получить исключения (подробнее о формате времени). Если не передать период, то исключения вернутся за период в 30 дней, начиная с текущего момента.
dateTo Дата, заканчивая которой нужно получить исключения (подробнее о формате времени). Если не передать период, то исключения вернутся за период в 30 дней, начиная с текущего момента.

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

Функция возвращает структуру с параметрами исключений графика работы сотрудника:

Параметр Описание
exceptionID ИД исключения
startTime Время начала исключения (подробнее о формате времени)
endTime Время окончания исключения (подробнее о формате времени)
externalID Внешний идентификатор исключения
workScheduleItemTypeID ИД типа исключения в графике работы
userID ИД пользователя, добавившего исключение в графике работы сотрудника
creationDate Дата начала создания исключения в графике работы (подробнее о формате времени)

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

GET /v6/api/subscriberManagement/subscribers/\{subscriberID}/workSchedule/exceptions?dateFrom=\{string}&dateTo=\{string} HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

GET /v6/api/subscriberManagement/subscribers/1/workSchedule/exceptions?dateFrom= 2024-09-17&dateTo=2024-09-19 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

\{
  "exceptions": [
    \{
      "exceptionID": integer,
      "startDate": "string",
      "endDate": "string",
      "externalID": "string",
      "workScheduleItemTypeID": integer,
      "userID": integer,
      "description": "string",
      "creationDate": "string"
    }
  ]
}

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

\{
  "exceptions": [
    \{
      "exceptionID": 4536,
      "startDate": "2024-09-20T00:00:00",
      "endDate": "2024-09-20T23:59:59",
      "externalID": "123",
      "workScheduleItemTypeID": 7,
      "userID": 89051,
      "description": "Заболел",
      "creationDate": "2024-09-17T12:24:39.283"
    }
  ]
}

Получение списка бригад

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

Функция позволяет получить бригады Сотрудников.

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

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

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

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

Параметр Описание
teamID ИД бригады
name Название бригады
creationDate Дата создания бригады (подробнее о формате времени).

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

GET /v6/api/subscriberManagement/teams HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

GET /v6/api/subscriberManagement/teams HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

[
  \{
    "teamID": integer,
    "name": "string",
    "creationDate": "string"
  },
  \{
    "teamID": integer,
    "name": "string",
    "creationDate": "string"
  }
]

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

[
  \{
    "teamID": 644168,
    "name": "Монтажники",
    "creationDate": "2024-09-17T10:00:14.343+03:00"
  },
  \{
    "teamID": 644170,
    "name": "Электрики",
    "creationDate": "2024-09-17T10:17:19.503+03:00"
  }
]

Получение распределения сотрудников в бригаду на текущий момент

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

Функция позволяет получить распределения сотрудников в бригаду на текущий момент.

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

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

Параметр Описание
teamID ИД бригады
date Дата, на которую нужно получить распределения Сотрудников в бригаду (подробнее о формате времени). Если параметр не передан, то будут возвращены распределения на текущий день.

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

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

Параметр Описание
startDate Дата и время начала распределения сотрудников в бригаду (подробнее о формате времени).
endDate Дата и время окончания распределения сотрудников в бригаду (подробнее о формате времени).
Параметры сотрудников, распределенных в бригаду (массив структур subscribers)
subscriberID ИД сотрудника
name Имя сотрудника

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

GET /v6/api/subscriberManagement/teams/\{teamID}/allocations/current?date=\{string} HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

GET /v6/api/subscriberManagement/teams/1/allocations/current?date=2024-09-16 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

\{
    "allocation": \{
        "startDate": "string",
        "endDate": "string",
        "subscribers": [
            \{
                "subscriberID": integer,
                "name": "string"
            },
            \{
                "subscriberID": integer,
                "name": "string"
            }
        ]
    }
}

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

\{
    "allocation": \{
        "startDate": "2024-09-17T13:00:30+03:00",
        "endDate": "2024-09-17T18:00:59+03:00",
        "subscribers": [
            \{
                "subscriberID": 1,
                "name": "Иванов Иван"
            },
            \{
                "subscriberID": 2,
                "name": "Петров Петр"
            }
        ]
    }
}

Общая информация об API

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

Работа с транспортными средствами

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

Содержание

Получение списка сотрудниковПолучение сотрудникаПолучение сотрудника по внешнему идентификаторуОбновление сотрудникаИзменение сотрудникаУдаление сотрудникаПолучение списка групп сотрудниковПолучение группы сотрудниковДобавление группы сотрудниковОбновление группы сотрудниковУдаление группы сотрудниковПолучение компетенций сотрудникаЗакрепление компетенций за сотрудникомОткрепление привязанной компетенции от сотрудникаПолучение весогабаритных характеристик компетенций сотрудникаОбновление весогабаритных характеристик сотрудникаПолучения списка гео-зон СотрудникаЗакрепление гео-зон за сотрудникомОткрепление привязанной гео-зоны от сотрудникаЗапрос местоположения сотрудниковПолучение местоположения сотрудникаПолучение последнего известного местоположения сотрудниковОбновление графика работы сотрудникаПолучение рабочих интервалов графика работы cотрудникаПолучение исключений из рабочего графика сотрудникаПолучение списка бригадПолучение распределения сотрудников в бригаду на текущий момент