api.route

Подробное описание

Получение информации о маршруте

api.route

Открытые члены
	addOutletToTerritory (outletId, routeId)
	Добавить торговую точку к территории Подробнее...
	availableRouteList (positionId)
	Получить список маршрутов, к которым данная позиция имеет доступ Подробнее...
	code (routeId)
	Получить код маршрута Подробнее...
	distributorIdList (positionId)
	Получить список дистрибьюторов Подробнее...
	distributorName (distributorId)
	Получить заголовок дистрибьютора Подробнее...
	filterList ()
	Получить список доступных фильтров Подробнее...
	nearestOutletId (routeId, locationCoordinates)
	Найти ближайшую торговую точку Подробнее...
	outletIdList (routeId)
	Получить список идентификаторов торговых точек, входящих в территорию маршрута Подробнее...
	putFilterList (filterList)
	Изменить список доступных фильтров Подробнее...
	route (routeId)
	Получить информацию по маршруту Подробнее...
	title (routeId)
	Получить заголовок маршрута Подробнее...

Методы

addOutletToTerritory (outletId, routeId)

addOutletToTerritory	(	outletId	,
		routeId
	)

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

Аргументы

outletId	[ID] - Идентификатор торговой точки
routeId	[ID] - Идентификатор маршрута

Возвращает

Boolean - Признак успешности добавления торговой точки к территории

availableRouteList (positionId)

availableRouteList

(

positionId

)

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

Аргументы

positionId

[ID] - Идентификатор позиции

Возвращает

IDList - Список идентификаторов маршрутов

code (routeId)

code

(

routeId

)

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

Аргументы

routeId

[ID] - Идентификатор маршрута

Возвращает

String - Код маршрута

distributorIdList (positionId)

distributorIdList

(

positionId

)

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

Аргументы

positionId

[ID] - Идентификатор позиции

Возвращает

IDList - Список идентификаторов дистрибьюторов

distributorName (distributorId)

distributorName

(

distributorId

)

Получить заголовок дистрибьютора

Аргументы

distributorId

[ID] - Идентификатор дистрибьютора

Возвращает

String - Заголовок дистрибьютора

filterList ()

* filterList

(

)

Получить список доступных фильтров

Возвращает

Result - Результат выполнения операции.
В поле value содержится список доступных фильтров (RouteFilter[])

nearestOutletId (routeId, locationCoordinates)

nearestOutletId	(	routeId	,
		locationCoordinates
	)

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

Аргументы

routeId	[ID] optional - Идентификатор маршрута, по умолчанию текущий
locationCoordinates	[LatLng] optional - Координаты, относительно которых осуществляется поиск, по умолчанию текущие

Возвращает

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

outletIdList (routeId)

outletIdList

(

routeId

)

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

Аргументы

routeId

[ID] - Идентификатор маршрута

Возвращает

IDList - Cписок идентификаторов торговых точек

putFilterList (filterList)

putFilterList

(

filterList

)

Изменить список доступных фильтров

Аргументы

filterList

[RouteFilter[]] - Обновленный список фильтров

Предупреждения

Ключ каждого фильтра в списке должен быть уникальным.
Если в списке присутствует несколько фильтров с одинаковым ключом, будет выбран произвольный

Возвращает

Result - Результат выполнения операции

route (routeId)

* route

(

routeId

)

Получить информацию по маршруту

Аргументы

routeId

[ID] - Идентификатор маршрута

Возвращает

Route - Информация по маршруту

title (routeId)

title

(

routeId

)

Получить заголовок маршрута

Аргументы

routeId

[ID] - Идентификатор маршрута

Возвращает

String - Заголовок маршрута