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

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

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

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

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

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

Параметр	Описание
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 — идентификатор сотрудника.

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

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

Параметр	Описание
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	ИД сотрудников. Подробнее о передаче нескольких идентификаторов
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
        }
    }
]

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

Содержание