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

Получение списка объектов

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

Функция GET /v6/api/mapObjectManagement/mapObjects?lon1={double}&lat1={double}&lon2={double}&lat2={double}&mapObjectGroupIDs={long}&count={integer}&offset={integer}&withCustomTemplateItems={boolean}&name={string}&withAssets={boolean} позволяет получить список объектов.

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

Чтобы получить объекты, находящиеся внутри прямоугольной области, необходимо передать параметры lon1, lat1, lon2, lat2. Прямоугольник строится по двум заданным координатам – противоположным углам прямоугольника.

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

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

Параметр	Описание
lon1	Долгота первой точки прямоугольника (в градусах)
lat1	Широта первой точки прямоугольника (в градусах)
lon2	Долгота второй точки прямоугольника (в градусах)
lat2	Широта второй точки прямоугольника (в градусах)
mapObjectGroupIDs	ИД групп объектов, объекты из которых необходимо получить. Подробнее о передаче нескольких идентификаторов
count	Количество возвращаемых записей (можно указать не более 1000)
offset	Отступ (integer)
withCustomTemplateItems	Нужно ли возвращать дополнительные поля объектов. Существуют следующие значения:true – возвращать дополнительные поля; false — без дополнительных полей.
name	Название объекта
withAssets	Определяет, будет ли возвращаться информация об активах в ответе. Возможные значения: null или отсутствие параметра — информация об активах не возвращается; true — информация об активах возвращается; false — информация об активах не возвращается.
assetWorkScheduleID	Идентификатор графика, привязанного к расписаниям объекта. Если у объектов есть несколько разных расписаний, можно отфильтровать объекты с конкретным графиком с помощью параметра «assetWorkScheduleID».
customFieldExternalIDs	Внешние ИД дополнительных полей
customFieldValues	Значения дополнительных полей

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

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

Параметр	Описание
mapObjectID	ИД объекта
regionID	ИД региона
radius	Радиус объекта (в метрах)
longitude	Географическая долгота (в градусах)
latitude	Географическая широта (в градусах)
mapObjectGroupID	ИД группы объекта
imageIndex	Индекс иконки объекта, числовые обозначение см. п. 28.2.
name	Название объекта
address	Адрес объекта
enabled	Признак активности объекта. Существуют следующие значения: true — объект включен (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте и в приложении «МТС Координатор»); false — объект выключен.
comment	Комментарий к объекту
workScheduleID	ИД графика объекта
assets	Активы объекта
externalID	Внешний ИД объекта
Параметры активов (массив структур assets)
assetsID	ИД актива
name	Имя актива
workScheduleID	ИД графика актива
customFieldFormTemplateID	ИД шаблона дополнительных полей объекта
Параметры дополнительных полей объекта (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы:string – строка;text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

GET /v6/api/mapObjectManagement/mapObjects?lon1=\{double}&lat1=\{double}&lon2=\{double}&lat2=\{double}&mapObjectGroupIDs=\{long}&count=\{integer}&offset=\{integer}&withCustomTemplateItems=\{boolean}&name=\{string}&withAssets=\{boolean} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/mapObjectManagement/mapObjects?lon1=37.5765572127192&lat1=55.7387521301682&lon2=27.541002648247711&lat2=53.90313848510363&mapObjectGroupIDs=1&count=2&offset=2&withCustomTemplateItems=true&name="Имя объекта"&withAssets=true HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

[
    \{
        "mapObjectID": integer,
        "regionID": integer,
        "radius": integer,
        "longitude": number,
        "latitude": number,
        "mapObjectGroupID": integer,
        "imageIndex": integer,
        "name": "string",
        "address": "string",
        "enabled": boolean,
        "comment": "string",
        "workScheduleID": integer, 
        "customFieldsFormTemplateID": integer,
        "customFieldFormItems": [
            \{
                "externalID": "string",
                "name": "string",
                "value": "string",
                "type": "string"
            }
        ],
        "assets": [
            \{
               "assetID": integer,
               "name": "string",
               "workScheduleID": integer
            }
        ]
    }
]

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

[
    \{
        "mapObjectID": 1,
        "regionID": 1,
        "radius": 150,
        "longitude": 37.5765572127199,
        "latitude": 55.7387521301683,
        "mapObjectGroupID": 1,
        "imageIndex": 0,
        "name": "Типография",
        "address": "Россия, Москва, улица Плющиха, 53/25с1",
        "enabled": true,
        "comment": "работает с утра",
        "workScheduleID": 250,
        "customFieldsFormTemplateID": 1,
        "customFieldFormItems": [
            \{
                "externalID": "1",
                "name": "режим работы",
                "value": "12:00 – 15:00",
                "type": "string"
            }
        ],
       "assets": [ 
           \{
               "assetID": 1035,
               "name": "Входная дверь"
           }, 
           \{   
               "assetID": 1236,
               "name": "Чердак"
           }
       ]
    }   
]

Получение объекта

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

Функция GET /v6/api/mapObjectManagement/mapObjects/{mapObjectID} позволяет получить объект по его идентификатору.

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

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

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

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

Параметр	Описание
mapObjectID	ИД объекта
regionID	ИД региона
radius	Радиус объекта (в метрах)
longitude	Географическая долгота (в градусах)
latitude	Географическая широта (в градусах)
mapObjectGroupID	ИД группы объекта
imageIndex	Индекс иконки объекта, числовые обозначение см. п. 28.2.
name	Название объекта
address	Адрес объекта
enabled	Признак активности объекта. Существуют следующие значения: true — объект включен (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте и в приложении «МТС Координатор»); false — объект выключен.
comment	Комментарий к объекту
workScheduleID	ИД графика объекта
assets	Активы объекта
externalID	Внешний ИД объекта
Параметры активов (массив структур assets)
assetsID	ИД актива
name	Имя актива
workScheduleID	ИД графика актива
customFieldFormTemplateID	ИД шаблона дополнительных полей объекта
Параметры дополнительных полей объекта (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы:string – строка;text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

GET /v6/api/mapObjectManagement/mapObjects/\{mapObjectID} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/mapObjectManagement/mapObjects/1 HTTP/1.1
Host: api.mpoisk.ru		
Authorization: Bearer token

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

\{
    "mapObjectID": integer,
    "regionID": integer,
    "radius": integer,
    "longitude": number,
    "latitude": number,
    "mapObjectGroupID": integer,
    "imageIndex": integer,
    "name": "string",
    "address": "string",
    "enabled": boolean,
    "comment": "string",
    "workScheduleID": integer, 
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ],
    "assets": [
        \{
            "assetID": integer,
            "name": "string",
            "workScheduleID": integer
        }
    ],
    "externalID": "string"
}

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

\{
    "mapObjectID": 1,
    "regionID": 1,
    "radius": 150,
    "longitude": 37.5765572127199,
    "latitude": 55.7387521301683,
    "mapObjectGroupID": 1,
    "imageIndex": 0,
    "name": "Типография",
    "address": "Россия, Москва, улица Плющиха, 53/25с1",
    "enabled": true,
    "comment": "работает с утра",
    "workScheduleID": 250,
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "name": "режим работы",
            "value": "12:00 – 15:00",
            "type": "string"
         }
    ],
    "assets": [ 
        \{
            "assetID": 1035,
            "name": "Входная дверь"
        }, 
        \{   
            "assetID": 1236,
            "name": "Чердак"
        }
    ],
    "externalID": "18237"
}

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

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

Функция GET /v6/api/mapObjectManagement/mapObjects/externalID/{externalID} позволяет получить объект по его внешнему идентификатору.

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

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

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

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

Параметр	Описание
mapObjectID	ИД объекта
regionID	ИД региона
radius	Радиус объекта (в метрах)
longitude	Географическая долгота (в градусах)
latitude	Географическая широта (в градусах)
mapObjectGroupID	ИД группы объекта
imageIndex	Индекс иконки объекта, числовые обозначение см. п. 28.2.
name	Название объекта
address	Адрес объекта
enabled	Признак активности объекта. Существуют следующие значения: true — объект включен (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте и в приложении «МТС Координатор»); false — объект выключен.
comment	Комментарий к объекту
workScheduleID	ИД графика объекта
assets	Активы объекта
externalID	Внешний ИД объекта
Параметры активов (массив структур assets)
assetsID	ИД актива
name	Имя актива
workScheduleID	ИД графика актива
customFieldFormTemplateID	ИД шаблона дополнительных полей объекта
Параметры дополнительных полей объекта (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы:string – строка;text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

GET /v6/api/mapObjectManagement/mapObjects/externalID/\{externalID} HTTP/1.1
Host: host
Authorization: Bearer token

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

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

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

\{
    "mapObjectID": integer,
    "regionID": integer,
    "radius": integer,
    "longitude": number,
    "latitude": number,
    "mapObjectGroupID": integer,
    "imageIndex": integer,
    "name": "string",
    "address": "string",
    "enabled": boolean,
    "comment": "string",
    "workScheduleID": integer, 
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ],
    "assets": [
        \{
            "assetID": integer,
            "name": "string",
            "workScheduleID": integer
        }
    ],
    "externalID": "string"
}

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

\{
    "mapObjectID": 1,
    "regionID": 1,
    "radius": 150,
    "longitude": 37.5765572127199,
    "latitude": 55.7387521301683,
    "mapObjectGroupID": 1,
    "imageIndex": 0,
    "name": "Типография",
    "address": "Россия, Москва, улица Плющиха, 53/25с1",
    "enabled": true,
    "comment": "работает с утра",
    "workScheduleID": 250,
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "name": "режим работы",
            "value": "12:00 – 15:00",
            "type": "string"
         }
    ],
    "assets": [ 
        \{
            "assetID": 1035,
            "name": "Входная дверь"
        }, 
        \{   
            "assetID": 1236,
            "name": "Чердак"
        }
    ],
    "externalID": "18237"
}

Создание объекта

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

Функция POST /v6/api/mapObjectManagement/mapObjects позволяет создать один объект.

Для создания сразу нескольких необходимо использовать функцию POST /v6/api/jobManagement/jobs/mapObjects.

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

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

Параметр	Описание
radius	Радиус объекта (в метрах)
longitude	Географическая долгота (в градусах)
latitude	Географическая широта (в градусах)
mapObjectGroupID	ИД группы объекта
imageIndex	Индекс иконки объекта, числовые обозначение см. п. 28.2.
name	Название объекта
address	Адрес объекта
enabled	Признак активности объекта. Существуют следующие значения: true — объект включен (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте и в приложении «МТС Координатор»); false — объект выключен.
comment	Комментарий к объекту
workScheduleID	ИД графика объекта
assets	Активы объекта
externalID	Внешний ИД объекта
Параметры активов (массив структур assets)
assetsID	ИД актива
name	Имя актива
workScheduleID	ИД графика актива
customFieldFormTemplateID	ИД шаблона дополнительных полей объекта
Параметры дополнительных полей объекта (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы:string – строка;text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

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

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

Параметр	Описание
mapObjectID	ИД объекта
regionID	ИД региона
radius	Радиус объекта (в метрах)
longitude	Географическая долгота (в градусах)
latitude	Географическая широта (в градусах)
mapObjectGroupID	ИД группы объекта
imageIndex	Индекс иконки объекта, числовые обозначение см. п. 28.2.
name	Название объекта
address	Адрес объекта
enabled	Признак активности объекта. Существуют следующие значения: true — объект включен (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте и в приложении «МТС Координатор»); false — объект выключен.
comment	Комментарий к объекту
workScheduleID	ИД графика объекта
assets	Активы объекта
externalID	Внешний ИД объекта
Параметры активов (массив структур assets)
assetsID	ИД актива
name	Имя актива
workScheduleID	ИД графика актива
customFieldFormTemplateID	ИД шаблона дополнительных полей объекта
Параметры дополнительных полей объекта (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы:string – строка;text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

POST /v6/api/mapObjectManagement/mapObjects HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "radius": integer,
    "longitude": number,
    "latitude": number,
    "mapObjectGroupID": integer,
    "imageIndex": integer,
    "name": "string",
    "address": "string",
    "enabled": boolean,
    "comment": "string",
    "workScheduleID": integer, 
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ],
    "assets": [
        \{
            "assetID": integer,
            "name": "string",
            "workScheduleID": integer
        }
    ],
    "externalID": "string"
}

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

POST /v6/api/mapObjectManagement/mapObjects HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token
       
\{
    "radius": 150,
    "longitude": 37.5765572127199,
    "latitude": 55.7387521301683,
    "mapObjectGroupID": 1,
    "imageIndex": 0,
    "name": "Типография",
    "address": "Россия, Москва, улица Плющиха, 53/25с1",
    "enabled": true,
    "comment": "работает с утра",
    "workScheduleID": 250,
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "name": "режим работы",
            "value": "12:00 – 15:00",
            "type": "string"
        }
    ],
    "assets": [ 
        \{
            "assetID": 1035,
            "name": "Входная дверь"
        }, 
        \{   
            "assetID": 1236,
            "name": "Чердак"
        }
    ],
    "externalID": "18237"
}

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

\{
    "mapObjectID": integer,
    "regionID": integer,
    "radius": integer,
    "longitude": number,
    "latitude": number,
    "mapObjectGroupID": integer,
    "imageIndex": integer,
    "name": "string",
    "address": "string",
    "enabled": boolean,
    "comment": "string",
    "workScheduleID": integer, 
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ],
    "assets": [
        \{
            "assetID": integer,
            "name": "string",
            "workScheduleID": integer
        }
    ],
    "externalID": "string"
}

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

\{
    "mapObjectID": 1,
    "regionID": 1,
    "radius": 150,
    "longitude": 37.5765572127199,
    "latitude": 55.7387521301683,
    "mapObjectGroupID": 1,
    "imageIndex": 0,
    "name": "Типография",
    "address": "Россия, Москва, улица Плющиха, 53/25с1",
    "enabled": true,
    "comment": "работает с утра",
    "workScheduleID": 250,
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "name": "режим работы",
            "value": "12:00 – 15:00",
            "type": "string"
         }
    ],
    "assets": [ 
        \{
            "assetID": 1035,
            "name": "Входная дверь"
        }, 
        \{   
            "assetID": 1236,
            "name": "Чердак"
        }
    ],
    "externalID": "18237"
}

Обновление объекта

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

Функция PUT /v6/api/mapObjectManagement/mapObjects/{mapObjectID} позволяет обновить объект (должны быть переданы все атрибуты объекта для обновления, т.е. объект обновляется полностью).

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

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

Параметр	Описание
mapObjectID	ИД объекта
radius	Радиус объекта (в метрах)
longitude	Географическая долгота (в градусах)
latitude	Географическая широта (в градусах)
mapObjectGroupID	ИД группы объекта
imageIndex	Индекс иконки объекта, числовые обозначение см. п. 28.2.
name	Название объекта
address	Адрес объекта
enabled	Признак активности объекта. Существуют следующие значения: true — объект включен (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте и в приложении «МТС Координатор»); false — объект выключен.
comment	Комментарий к объекту
workScheduleID	ИД графика объекта
assets	Активы объекта
externalID	Внешний ИД объекта
Параметры активов (массив структур assets)
assetsID	ИД актива
name	Имя актива
workScheduleID	ИД графика актива
customFieldFormTemplateID	ИД шаблона дополнительных полей объекта
Параметры дополнительных полей объекта (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы:string – строка;text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

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

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

PUT /v6/api/mapObjectManagement/mapObjects/\{mapObjectID} HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "radius": integer,
    "longitude": number,
    "latitude": number,
    "mapObjectGroupID": integer,
    "imageIndex": integer,
    "name": "string",
    "address": "string",
    "enabled": boolean,
    "comment": "string",
    "workScheduleID": integer, 
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ],
    "assets": [
        \{
            "assetID": integer,
            "name": "string",
            "workScheduleID": integer
        }
    ],
    "externalID": "string"
}

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

PUT /v6/api/mapObjectManagement/mapObjects/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token
        
\{
    "radius": 150,
    "longitude": 37.5765572127199,
    "latitude": 55.7387521301683,
    "mapObjectGroupID": 1,
    "imageIndex": 0,
    "name": "Типография",
    "address": "Россия, Москва, улица Плющиха, 53/25с1",
    "enabled": true,
    "comment": "работает с утра",
    "workScheduleID": 250,
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "name": "режим работы",
            "value": "12:00 – 15:00",
            "type": "string"
        }
    ],
    "assets": [ 
        \{
            "assetID": 1035,
            "name": "Входная дверь"
        }, 
        \{   
            "assetID": 1236,
            "name": "Чердак"
        }
    ],
    "externalID": "18237"
}

Обновление объекта по внешнему идентификатору

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

Функция PUT /v6/api/mapObjectManagement/mapObjects/externalID/{externalID} позволяет обновить объект по внешнему идентификатору (должны быть переданы все атрибуты объекта для обновления, т.е. объект обновляется полностью).

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

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

Параметр	Описание
externalID	Внешний идентификатор объекта
radius	Радиус объекта (в метрах)
longitude	Географическая долгота (в градусах)
latitude	Географическая широта (в градусах)
mapObjectGroupID	ИД группы объекта
imageIndex	Индекс иконки объекта, числовые обозначение см. п. 28.2.
name	Название объекта
address	Адрес объекта
enabled	Признак активности объекта. Существуют следующие значения: true — объект включен (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте и в приложении «МТС Координатор»); false — объект выключен.
comment	Комментарий к объекту
workScheduleID	ИД графика объекта
assets	Активы объекта
externalID	Внешний ИД объекта
Параметры активов (массив структур assets)
assetsID	ИД актива
name	Имя актива
workScheduleID	ИД графика актива
customFieldFormTemplateID	ИД шаблона дополнительных полей объекта
Параметры дополнительных полей объекта (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы:string – строка;text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

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

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

PUT /v6/api/mapObjectManagement/mapObjects/externalID/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "radius": integer,
    "longitude": number,
    "latitude": number,
    "mapObjectGroupID": integer,
    "imageIndex": integer,
    "name": "string",
    "address": "string",
    "enabled": boolean,
    "comment": "string",
    "workScheduleID": integer, 
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ],
    "assets": [
        \{
            "assetID": integer,
            "name": "string",
            "workScheduleID": integer
        }
    ],
    "externalID": "string"
}

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

PUT /v6/api/mapObjectManagement/mapObjects/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token
        
\{
    "radius": 150,
    "longitude": 37.5765572127199,
    "latitude": 55.7387521301683,
    "mapObjectGroupID": 1,
    "imageIndex": 0,
    "name": "Типография",
    "address": "Россия, Москва, улица Плющиха, 53/25с1",
    "enabled": true,
    "comment": "работает с утра",
    "workScheduleID": 250,
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "name": "режим работы",
            "value": "12:00 – 15:00",
            "type": "string"
        }
    ],
    "assets": [ 
        \{
            "assetID": 1035,
            "name": "Входная дверь"
        }, 
        \{   
            "assetID": 1236,
            "name": "Чердак"
        }
    ],
    "externalID": "18237"
}

Изменение объекта

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

Функция PATCH /v6/api/mapObjectManagement/mapObjects/{mapObjectID} позволяет изменить только часть параметров объекта.

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

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

Параметр	Описание
mapObjectID	ИД объекта
radius	Радиус объекта (в метрах)
longitude	Географическая долгота (в градусах)
latitude	Географическая широта (в градусах)
mapObjectGroupID	ИД группы объекта
imageIndex	Индекс иконки объекта, числовые обозначение см. п. 28.2.
name	Название объекта
address	Адрес объекта
enabled	Признак активности объекта. Существуют следующие значения: true — объект включен (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте и в приложении «МТС Координатор»); false — объект выключен.
comment	Комментарий к объекту
workScheduleID	ИД графика объекта
assets	Активы объекта
externalID	Внешний ИД объекта
Параметры активов (массив структур assets)
assetsID	ИД актива
name	Имя актива
workScheduleID	ИД графика актива
customFieldFormTemplateID	ИД шаблона дополнительных полей объекта
Параметры дополнительных полей объекта (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы:string – строка;text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

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

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

Параметр	Описание
mapObjectID	ИД объекта
regionID	ИД региона
radius	Радиус объекта (в метрах)
longitude	Географическая долгота (в градусах)
latitude	Географическая широта (в градусах)
mapObjectGroupID	ИД группы объекта
imageIndex	Индекс иконки объекта, числовые обозначение см. п. 28.2.
name	Название объекта
address	Адрес объекта
enabled	Признак активности объекта. Существуют следующие значения: true — объект включен (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте и в приложении «МТС Координатор»); false — объект выключен.
comment	Комментарий к объекту
workScheduleID	ИД графика объекта
assets	Активы объекта
externalID	Внешний ИД объекта
Параметры активов (массив структур assets)
assetsID	ИД актива
name	Имя актива
workScheduleID	ИД графика актива
customFieldFormTemplateID	ИД шаблона дополнительных полей объекта
Параметры дополнительных полей объекта (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы:string – строка;text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

PATCH /v6/api/mapObjectManagement/mapObjects/\{mapObjectID} HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "radius": integer,
    "longitude": number,
    "latitude": number,
    "mapObjectGroupID": integer,
    "imageIndex": integer,
    "name": "string",
    "address": "string",
    "enabled": boolean,
    "comment": "string",
    "workScheduleID": integer, 
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ],
    "assets": [
        \{
            "assetID": integer,
            "name": "string",
            "workScheduleID": integer
        }
    ],
    "externalID": "string"
}

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

PATCH /v6/api/mapObjectManagement/mapObjects/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token
        
\{
    "radius": 150,
    "longitude": 37.5765572127199,
    "latitude": 55.7387521301683,
    "mapObjectGroupID": 1,
    "imageIndex": 0,
    "name": "Типография",
    "address": "Россия, Москва, улица Плющиха, 53/25с1",
    "enabled": true,
    "comment": "работает с утра",
    "workScheduleID": 250,
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "name": "режим работы",
            "value": "12:00 – 15:00",
            "type": "string"
        }
    ],
    "assets": [ 
        \{
            "assetID": 1035,
            "name": "Входная дверь"
        }, 
        \{   
            "assetID": 1236,
            "name": "Чердак"
        }
    ],
    "externalID": "18237"
}

Изменение объекта по внешнему идентификатору

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

Функция PATCH /v6/api/mapObjectManagement/mapObjects/externalID/{externalID} позволяет изменить только часть параметров объекта.

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

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

Параметр	Описание
externalID	Внешний идентификатор объекта
radius	Радиус объекта (в метрах)
longitude	Географическая долгота (в градусах)
latitude	Географическая широта (в градусах)
mapObjectGroupID	ИД группы объекта
imageIndex	Индекс иконки объекта, числовые обозначение см. п. 28.2.
name	Название объекта
address	Адрес объекта
enabled	Признак активности объекта. Существуют следующие значения: true — объект включен (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте и в приложении «МТС Координатор»); false — объект выключен.
comment	Комментарий к объекту
workScheduleID	ИД графика объекта
assets	Активы объекта
externalID	Внешний ИД объекта
Параметры активов (массив структур assets)
assetsID	ИД актива
name	Имя актива
workScheduleID	ИД графика актива
customFieldFormTemplateID	ИД шаблона дополнительных полей объекта
Параметры дополнительных полей объекта (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы:string – строка;text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

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

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

Параметр	Описание
mapObjectID	ИД объекта
regionID	ИД региона
radius	Радиус объекта (в метрах)
longitude	Географическая долгота (в градусах)
latitude	Географическая широта (в градусах)
mapObjectGroupID	ИД группы объекта
imageIndex	Индекс иконки объекта, числовые обозначение см. п. 28.2.
name	Название объекта
address	Адрес объекта
enabled	Признак активности объекта. Существуют следующие значения: true — объект включен (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте и в приложении «МТС Координатор»); false — объект выключен.
comment	Комментарий к объекту
workScheduleID	ИД графика объекта
assets	Активы объекта
externalID	Внешний ИД объекта
Параметры активов (массив структур assets)
assetsID	ИД актива
name	Имя актива
workScheduleID	ИД графика актива
customFieldFormTemplateID	ИД шаблона дополнительных полей объекта
Параметры дополнительных полей объекта (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы:string – строка;text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

PATCH /v6/api/mapObjectManagement/mapObjects/externalID/\{externalID} HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "radius": integer,
    "longitude": number,
    "latitude": number,
    "mapObjectGroupID": integer,
    "imageIndex": integer,
    "name": "string",
    "address": "string",
    "enabled": boolean,
    "comment": "string",
    "workScheduleID": integer, 
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ],
    "assets": [
        \{
            "assetID": integer,
            "name": "string",
            "workScheduleID": integer
        }
    ],
    "externalID": "string"
}

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

PATCH /v6/api/mapObjectManagement/mapObjects/externalID/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token
        
\{
    "radius": 150,
    "longitude": 37.5765572127199,
    "latitude": 55.7387521301683,
    "mapObjectGroupID": 1,
    "imageIndex": 0,
    "name": "Типография",
    "address": "Россия, Москва, улица Плющиха, 53/25с1",
    "enabled": true,
    "comment": "работает с утра",
    "workScheduleID": 250,
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "name": "режим работы",
            "value": "12:00 – 15:00",
            "type": "string"
        }
    ],
    "assets": [ 
        \{
            "assetID": 1035,
            "name": "Входная дверь"
        }, 
        \{   
            "assetID": 1236,
            "name": "Чердак"
        }
    ],
    "externalID": "18237"
}

Удаление объектов

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

Функция DELETE /v6/api/mapObjectManagement/mapObjects/{mapObjectID} позволяет удалить сразу несколько объектов.

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

В запросе передается массив ИД объектов, которые нужно удалить.

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

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

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

DELETE /v6/api/mapObjectManagement/mapObjects HTTP/1.1
Host: host
Authorization: Bearer token


[
    integer,
    integer
]

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

DELETE /v6/api/mapObjectManagement/mapObjects HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

[
    1,
    2
]

Удаление объекта

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

Функция DELETE /v6/api/mapObjectManagement/mapObjects/{mapObjectID} позволяет удалить объект.

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

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

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

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

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

DELETE /v6/api/mapObjectManagement/mapObjects/\{mapObjectID} HTTP/1.1
Host: host
Authorization: Bearer token

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

DELETE /v6/api/mapObjectManagement/mapObjects/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Удаление объекта по внешнему идентификатору

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

Функция DELETE /v6/api/mapObjectManagement/mapObjects/externalID/{externalID} позволяет удалить объект.

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

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

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

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

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

DELETE /v6/api/mapObjectManagement/mapObjects/externalID/\{externalID} HTTP/1.1
Host: host
Authorization: Bearer token

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

DELETE /v6/api/mapObjectManagement/mapObjects/externalID/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

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

Функция GET /v6/api/mapObjectManagement/mapObjectGroups позволяет получить список групп объектов.

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

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

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

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

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

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

GET /v6/api/mapObjectManagement/mapObjectGroups HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/mapObjectManagement/mapObjectGroups HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

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

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

[
  \{
    "mapObjectGroupID": 1,
    "parentID": 3,
    "name": "Москва",
    "color": 1,
    "regionID": 1
  },
  \{
    "mapObjectGroupID": 2,
    "parentID": 3,
    "name": "Московская область",
    "color": 4,
    "regionID": 2
  }
]

Получение группы объектов

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

Функция GET /v6/api/mapObjectManagement/mapObjectGroups/{mapObjectGroupID} позволяет получить список групп объектов.

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

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

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

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

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

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

GET /v6/api/mapObjectManagement/mapObjectGroups/\{mapObjectGroupID} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/mapObjectManagement/mapObjectGroups/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

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

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

\{
    "mapObjectGroupID": 1,
    "parentID": 3,
    "name": "Москва",
    "color": 2,
    "regionID": 1
}

Создание группы объектов

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

Функция POST /v6/api/mapObjectManagement/mapObjectGroups позволяет создать группу объектов.

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

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

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

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

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

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

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

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

POST /v6/api/mapObjectManagement/mapObjectGroups HTTP/1.1
Host: host
Authorization: Bearer token

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

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

POST /v6/api/mapObjectManagement/mapObjectGroups HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "parentID": 3,
    "name": "Москва",
    "color": 2,
    "regionID": 1
}

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

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

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

\{
    "mapObjectGroupID": 1,
    "parentID": 3,
    "name": "Москва",
    "color": 2,
    "regionID": 1
}

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

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

Функция PUT /v6/api/mapObjectManagement/mapObjectGroups/{mapObjectGroupID} позволяет обновить группу объектов (должны быть переданы все атрибуты группы объектов для обновления, т.е. группа объектов обновляется полностью).

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

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

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

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

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

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

PUT /v6/api/mapObjectManagement/mapObjectGroups/\{mapObjectGroupID} HTTP/1.1
Host: host
Authorization: Bearer token

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

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

PUT /v6/api/mapObjectManagement/mapObjectGroups/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "parentID": 3,
    "name": "Москва (центр)",
    "color": 4,
    "regionID": 1
}

Изменение группы объектов

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

Функция PATCH /v6/api/mapObjectManagement/mapObjectGroups/{mapObjectGroupID} позволяет изменить только часть параметров группы объектов.

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

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

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

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

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

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

PATCH /v6/api/mapObjectManagement/mapObjectGroups/\{mapObjectGroupID} HTTP/1.1
Host: host
Authorization: Bearer token

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

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

PATCH /v6/api/mapObjectManagement/mapObjectGroups/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "parentID": 3,
    "name": "Москва (центр)",
    "color": 4,
    "regionID": 1
}

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

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

Функция DELETE /v6/api/mapObjectManagement/mapObjectGroups/{mapObjectGroupID} позволяет удалить группу объектов по ее идентификатору.

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

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

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

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

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

DELETE /v6/api/mapObjectManagement/mapObjectGroups/\{mapObjectGroupID} HTTP/1.1
Host: host
Authorization: Bearer token

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

DELETE /v6/api/mapObjectManagement/mapObjectGroups/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Получение привязанных к объекту сотрудников

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

Функция GET /v6/api/mapObjectManagement/mapObjects/{mapObjectID}/subscribers позволяет получить привязанных к объекту сотрудников.

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

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

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

Функция возвращает параметр subscriberIDs — идентификаторы сотрудников, привязанных к объекту.

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

GET /v6/api/mapObjectManagement/mapObjects/\{mapObjectID}/subscribers HTTP/1.1
Host: host
Authorization: Bearer token

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

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

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

\{
  "subscriberIDs": [
    integer
  ]
}

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

\{
  "subscriberIDs": [
    1
  ]
}

Привязка сотрудников к объекту

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

Функция PUT /v6/api/mapObjectManagement/mapObjects/{mapObjectID}/subscribers позволяет привязать к объекту сотрудников.

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

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

Параметр	Описание
mapObjectID	Идентификатор объекта
subscriberIDs	Идентификаторы сотрудников, которых нужно привязать к объекту. Подробнее о передаче нескольких идентификаторов
subscriberGroupIDs	Идентификаторы групп сотрудников, которых нужно привязать к объекту. Подробнее о передаче нескольких идентификаторов

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

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

Функция возвращает параметр subscriberIDs — идентификаторы сотрудников, привязанных к объекту.

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

PUT /v6/api/mapObjectManagement/mapObjects/\{mapObjectID}/subscribers HTTP/1.1
Host: host
Authorization: Bearer token

\{
  "subscriberIDs": [
    integer
  ],
  "subscriberGroupIDs": [
    integer
  ]
}

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

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

\{
  "subscriberIDs": [
    1
  ],
  "subscriberGroupIDs": [
    2
  ]
}

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

\{
  "subscriberIDs": [
    integer
  ]
}

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

\{
  "subscriberIDs": [
    1
  ]
}

Удаление привязок сотрудников к объекту

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

Функция DELETE /v6/api/mapObjectManagement/mapObjects/{mapObjectID}/subscribers позволяет удалить привязки сотрудников к объекту.

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

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

Параметр	Описание
mapObjectID	Идентификатор объекта
subscriberIDs	Идентификаторы сотрудников, которых нужно привязать к объекту. Подробнее о передаче нескольких идентификаторов

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

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

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

DELETE /v6/api/mapObjectManagement/mapObjects/\{mapObjectID}/subscribers HTTP/1.1
Host: host
Authorization: Bearer token

\{
  "subscriberIDs": [
    integer
  ]
}

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

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

\{
  "subscriberIDs": [
    1
  ]
}

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

Содержание