Список версий МТ

Главная

api.route

Маршрут

Methods

api.route.addOutletToTerritory(outletId, routeId) → Boolean
api.route.availableRouteList(positionId) → IDList
api.route.code(routeId) → String
api.route.distributorIdList(positionId) → IDList
api.route.distributorName(distributorId) → String
api.route.nearestOutletId(routeId, locationCoordinates) → ID
api.route.outletIdList(routeId) → IDList
api.route.outletInfo(outletId) → OutletData
api.route.route(routeId) → Route
api.route.title(routeId) → String

Methods description

addOutletToTerritory(outletId, routeId) → Boolean

Добавить торговую точку к территории

Parameters:
Name Type Description
outletId ID

Идентификатор торговой точки
routeId ID

Идентификатор маршрута
Return:
Boolean

availableRouteList(positionId) → IDList

Получить список маршрутов, к которым данная позиция имеет доступ

Parameters:
Name Type Description
positionId ID

Идентификатор позиции
Return:
IDList -

Массив идентификаторов маршрутов

code(routeId) → String

Получить код маршрута

Parameters:
Name Type Description
routeId ID

Идентификатор маршрута
Return:
String

distributorIdList(positionId) → IDList

Получить список дистрибьюторов

Parameters:
Name Type Description
positionId ID

Позиция
Return:
IDList

distributorName(distributorId) → String

Получить имя дистрибьютора

Parameters:
Name Type Description
distributorId ID

Дистрибьютор
Return:
String

nearestOutletId(routeId, locationCoordinates) → ID

Найти ближайшую торговую точку

Parameters:
Name Type Argument Description
routeId ID optional 

Идентификатор маршрута, по-умолчанию текущий
locationCoordinates LatLng optional 

Координаты, относительно которых осуществляется поиск, по-умолчанию текущие
Return:
ID -

Идентификатор торговой точки

outletIdList(routeId) → IDList

Получить список идентификаторов торговых точек, входящих в территорию маршрута

Parameters:
Name Type Description
routeId ID

Идентификатор маршрута
Return:
IDList

outletInfo(outletId) → OutletData

Вернуть информацию о торговой точке из территории

Parameters:
Name Type Description
outletId ID

Идентификатор торговой точки территории
Return:
OutletData -

Информация о торговой точке

route(routeId) → Route

Получить данные маршрута

Parameters:
Name Type Description
routeId ID

Идентификатор маршрута
Return:
Route

title(routeId) → String

Получить название маршрута

Parameters:
Name Type Description
routeId ID

Идентификатор маршрута
Return:
String