ИнтеграцияИнтеграция по APIРабота с мобильными (MPS) местоположениями и треками

Работа с мобильными (MPS) местоположениями и треками

Получение мобильных (MPS) местоположений сотрудников

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

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

Максимальное количество возвращаемых местоположений — 1000.

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

Все параметры в запросе являются необязательными.

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

Параметр Описание
dateFrom Дата, время начала периода (подробнее о формате времени). Если параметр не передан, то в ответе на запрос вернутся данные за последние 3 дня.
dateTo Дата, время окончания периода (подробнее о формате времени).
subscriberIDs ИД сотрудников. Подробнее о передаче нескольких идентификаторов
count Количество возвращаемых мобильных местоположений (не более 1000).
offset Количество мобильных местоположений, которые необходимо пропустить относительно первого в списке.
lastLocationID ИД последнего местоположения, которым должны заканчиваться нужные данные (функция вернет местоположения с идентификаторами, которые строго меньше указанного).

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

Функция возвращает структуру со следующими параметрами мобильных (MPS) местоположений:

Параметр Описание
locationDate Дата, время местоположения (подробнее о формате времени).
subscriberID ИД сотрудника
state Статус запроса. Существуют следующие значения:0 — новый; 1 — в обработке; 2 — успешно выполнен; 3 — ошибка определения местоположения; 4 — последнее известное местоположение; 5 — Сотрудник временно недоступен.
source Источник запроса. Существуют следующие значения: -1 — неизвестен; 0 — веб-интерфейс; 1 — запрос по SMS; 2 — Сотрудник сам инициировал определение местоположения; 3 — по интервалу; 4 — по расписанию; 6 — зафиксировано событие; 8 — веб-сервис управления Услугой; 9 — действия по запросу Оператора; 10 — действие, инициированное Платформой; 15 — запрос инициирован из приложения; 16 — запрос инициирован USSD-командой; 17 — запрос инициирован с iPhone; 18 — запрос инициирован с iPad; 19 — запрос инициирован с Android; 20 — по сменному графику; 23 — B2B; 24 — интерворкинг; 26 — сервис онлайн-позиционирования.
locationID ИД местоположения
requestDate Дата и время запроса (подробнее о формате времени).
address Адрес местоположения
longitude Географическая долгота адреса (в градусах)
latitude Географическая широта адреса (в градусах)

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

GET /v6/api/mobilePositioningManagement/locations?dateFrom=\{dateTime}&dateTo=\{dateTime}&subscriberIDs=\{long}&count=\{integer}&offset=\{integer}&lastLocationID=\{long} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/mobilePositioningManagement/locations?dateFrom=2021-03-02T15:45:13+03:00&dateTo=2021-03-03T09:00:12+03:00&subscriberIDs=1&count=2&offset=1&lastLocationID=1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

[
  \{
    "locationDate": "dateTime",
    "subscriberID": 1,
    "state": 2,
    "source": integer,
    "locationID": integer,
    "requestDate": "dateTime",
    "address": "string",
    "longitude": number,
    "latitude": number
  },
  \{
    "locationDate": "dateTime",
    "subscriberID": integer,
    "state": integer,
    "source": integer,
    "locationID": integer,
    "requestDate": "dateTime",
    "address": "string",
    "longitude": number,
    "latitude": number
  }
]

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

[
  \{
    "locationDate": "2021-03-03T09:00:12+03:00",
    "subscriberID": 1,
    "state": 2,
    "source": 3,
    "locationID": 4,
    "requestDate": "2021-03-03T09:00:09.49+03:00",
    "address": "г. Москва, район Крюково, Новомалино, пересечение ул. Малинская и ул. Садовая",
    "longitude": 37.196619999999996,
    "latitude": 55.959860000000006
  },
  \{
    "locationDate": "2021-03-02T15:45:13+03:00",
    "subscriberID": 1,
    "state": 2,
    "source": 3,
    "locationID": 3,
    "requestDate": "2021-03-02T15:45:05.36+03:00",
    "address": "г. Москва, ул. Новомарьинская, 12/12К1, район ст.м.Марьино",
    "longitude": 37.753722777777774,
    "latitude": 55.65313333333333
  }
]

Получение мобильных (MPS) треков

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

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

Максимальное количество возвращаемых треков — 1000.

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

Все параметры в запросе являются необязательными.

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

Параметр Описание
dateFrom Дата, время начала периода (подробнее о формате времени). Если параметр не передан, то в ответе на запрос вернутся данные за последние 3 дня.
dateTo Дата, время окончания периода (подробнее о формате времени).
subscriberIDs ИД сотрудников. Подробнее о передаче нескольких идентификаторов
count Количество возвращаемых мобильных местоположений (не более 1000).
offset Количество мобильных местоположений, которые необходимо пропустить относительно первого в списке.
lastTrackID ИД последнего трека, которым должны заканчиваться нужные данные (функция вернет местоположения с идентификаторами, которые строго меньше указанного).

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

Функция возвращает структуру со следующими параметрами мобильных (MPS) треков:

Параметр Описание
trackID ИД трека
subscriberID ИД сотрудника
startDate Дата, время начала трека (подробнее о формате времени).
finishDate Дата, время окончания трека (подробнее о формате времени).
startAddress Адрес начала трека
finishAddress Адрес окончания трека
startLon Географическая долгота адреса начала трека (в градусах)
startLat Географическая широта адреса начала трека (в градусах)
finishLon Географическая долгота адреса окончания трека (в градусах)
finishLat Географическая широта адреса окончания трека (в градусах)
distance Общая протяженность трека (в метрах)
duration Общая длительность трека (в секундах)

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

GET /v6/api/mobilePositioningManagement/tracks?dateFrom=\{dateTime}&dateTo=\{dateTime}&subscriberIDs=\{long}&count=\{intger}&offset=\{integer}&lastTrackID=\{long} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/mobilePositioningManagement/tracks?dateFrom=2021-03-02T15:45:13+03:00&dateTo=2021-03-03T09:00:12+03:00&subscriberIDs=1&count=2&offset=1&lastTrackID=1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

[
  \{
    "trackID": integer,
    "subscriberID": integer,
    "startDate": "dateTime",
    "finishDate": "dateTime",
    "startAddress": "string",
    "finishAddress": "string",
    "startLon": number,
    "startLat": number,
    "finishLon": number,
    "finishLat": number,
    "distance": integer,
    "duration": integer
  },
  \{
    "trackID": integer,
    "subscriberID": integer,
    "startDate": "dateTime",
    "finishDate": "dateTime",
    "startAddress": "string",
    "finishAddress": "string",
    "startLon": number,
    "startLat": number,
    "finishLon": number,
    "finishLat": number,
    "distance": integer,
    "duration": integer
  }
]

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

[
  \{
    "trackID": 4,
    "subscriberID": 1,
    "startDate": "2021-03-03T09:00:12+03:00",
    "finishDate": "2021-03-03T15:15:09+03:00",
    "startAddress": "г. Москва, бульв. Мячковский, 16К2, район ст.м.Марьино",
    "finishAddress": "г. Москва, ул. Новомарьинская, 12/12К1, район ст.м.Марьино",
    "startLon": 37.755718333333334,
    "startLat": 55.65027944444444,
    "finishLon": 37.753722777777774,
    "finishLat": 55.65313333333333,
    "distance": 14611,
    "duration": 22497
  },
  \{
    "trackID": 3,
    "subscriberID": 1,
    "startDate": "2021-03-02T09:00:09+03:00",
    "finishDate": "2021-03-02T15:55:11+03:00",
    "startAddress": "г. Москва, пересечение ул. Поречная и бульв. Мячковский, район ст.м.Марьино",
    "finishAddress": "г. Москва, бульв. Мячковский, 14К2, район ст.м.Марьино",
    "startLon": 37.762928055555555,
    "startLat": 55.64931388888889,
    "finishLon": 37.755610833333336,
    "finishLat": 55.65204972222222,
    "distance": 12860,
    "duration": 24902
  }
]

Получение мобильного (MPS) местоположения сотрудника

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

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

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

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

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

Функция возвращает структуру со следующими параметрами мобильного (MPS) местоположения:

Параметр Описание
locationDate Дата, время местоположения (подробнее о формате времени).
subscriberID ИД сотрудника
state Статус запроса. Существуют следующие значения:0 — новый; 1 — в обработке; 2 — успешно выполнен; 3 — ошибка определения местоположения; 4 — последнее известное местоположение; 5 — Сотрудник временно недоступен.
source Источник запроса. Существуют следующие значения: -1 — неизвестен; 0 — веб-интерфейс; 1 — запрос по SMS; 2 — Сотрудник сам инициировал определение местоположения; 3 — по интервалу; 4 — по расписанию; 6 — зафиксировано событие; 8 — веб-сервис управления Услугой; 9 — действия по запросу Оператора; 10 — действие, инициированное Платформой; 15 — запрос инициирован из приложения; 16 — запрос инициирован USSD-командой; 17 — запрос инициирован с iPhone; 18 — запрос инициирован с iPad; 19 — запрос инициирован с Android; 20 — по сменному графику; 23 — B2B; 24 — интерворкинг; 26 — сервис онлайн-позиционирования.
locationID ИД местоположения
requestDate Дата и время запроса (подробнее о формате времени).
address Адрес местоположения
longitude Географическая долгота адреса (в градусах)
latitude Географическая широта адреса (в градусах)

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

GET /v6/api/mobilePositioningManagement/locations/\{locationID} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/mobilePositioningManagement/locations/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

\{
    "locationDate": "dateTime",
    "objectID": integer,
    "subscriberID": integer,
    "state": integer,
    "source": integer,
    "locationID": integer,
    "requestDate": "dateTime",
    "address": "string",
    "longitude": number,
    "latitude": number,
    "text": "string"
}

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

\{
    "locationDate": "2021-03-03T09:00:12+03:00",
    "objectID": 1,
    "subscriberID": 1,
    "state": 2,
    "source": 3,
    "locationID": 4,
    "requestDate": "2021-03-03T09:00:09.49+03:00",
    "address": "г. Москва, район Крюково, Новомалино, пересечение ул. Малинская и ул. Садовая",
    "longitude": 37.196619999999996,
    "latitude": 55.959860000000006,
    "text": "На объекте"
}