api.visits

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

Работа с визитами

api.visits

Открытые члены
	addToRoute (outletId, date)
	Создать дополнительный визит на определенную дату Подробнее...
	canFinish (outletId)
	Проверить возможность завершения визита в ТТ Подробнее...
	canStart (outletId)
	Проверить возможность начала визита в ТТ Подробнее...
	currentVisit (routeId)
	Получить текущий визит Подробнее...
	dateOfLastVisit (outletId, countVisits)
	Функция, возвращающая дату последнего посещения в торговую точку Подробнее...
	deleteFactVisit (visitId)
	Удалить фактический завершенный визит, без неудаленных валидных документов оформленных в этом визите Подробнее...
	factVisitDaysByOutlet (outletId, routeId, dayLimit)
	Вернуть дни фактических визитов в торговую точку, отсортированные из будущего в прошлое Подробнее...
	finish (outletId, reasonId)
	Завершить визит в ТТ Подробнее...
	isFinished (outletId, date, routeId)
	Совершен ли визит в ТТ Подробнее...
	isStarted (outletId, routeId)
	Начат ли визит в ТТ Подробнее...
	nextExpectedOutletVisitId (outletId, routeId)
	Вернуть следующий плановый или дополнительный визит в торговую точку за период равный настройке многонедельности данного маршрута Подробнее...
	nextExpectedRouteVisitId (routeId)
	Получить следующий по порядку визит на маршруте Подробнее...
	reasonModel ()
	Функция, возвращающая список результатов визита Подробнее...
	start (outletId)
	Начать визит в ТТ Подробнее...
	visitInfo (visitId)
	Вернуть объект, описывающий фактический или плановый визит Подробнее...
	visitList (dateOrPeriod, routeOrRouteList)
	Получить список визитов Подробнее...
	visitListByOutlet (outletId, dateOrPeriod, routeOrRouteList)
	Получить список визитов в торговую точку Подробнее...

Методы

addToRoute (outletId, date)

addToRoute	(	outletId	,
		date
	)

Создать дополнительный визит на определенную дату

Аргументы

outletId	[ID] - Идентификатор торговой точки
date	[Date] - Дата, на которую добавляется визит

Возвращает

Result - Результат выполнения операции.
В поле value - идентификатор добавленного на маршрут визита (ID)

canFinish (outletId)

canFinish

(

outletId

)

Проверить возможность завершения визита в ТТ

Аргументы

outletId

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

Возвращает

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

canStart (outletId)

canStart

(

outletId

)

Проверить возможность начала визита в ТТ

Аргументы

outletId

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

Возвращает

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

currentVisit (routeId)

* currentVisit

(

routeId

)

Получить текущий визит

Аргументы

routeId

[ID] optional - Идентификатор маршрута, если не задан, то текущий

Возвращает

Visit

dateOfLastVisit (outletId, countVisits)

dateOfLastVisit	(	outletId	,
		countVisits
	)

Функция, возвращающая дату последнего посещения в торговую точку

Уст.:

(2018-11-30) Метод устарел, замены не требует

Возвращает

Date

deleteFactVisit (visitId)

deleteFactVisit

(

visitId

)

Удалить фактический завершенный визит, без неудаленных валидных документов оформленных в этом визите

Аргументы

visitId

[ID] - Идентификатор завершенного фактического визита

Возвращает

Result - Результат выполнения операции.
При ошибке в text должна содержаться дополнительная информация об ошибке

factVisitDaysByOutlet (outletId, routeId, dayLimit)

factVisitDaysByOutlet	(	outletId	,
		routeId	,
		dayLimit
	)

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

Аргументы

outletId	[ID] - Идентификатор торговой точки
routeId	[ID] - Идентификатор маршрута. Если невалидный, то используется текущий маршрут
dayLimit	[Number] - Ограничение на количество возвращаемых дней, 0 - без ограничений

Возвращает

Date[]

finish (outletId, reasonId)

finish	(	outletId	,
		reasonId
	)

Завершить визит в ТТ

Аргументы

outletId	[ID] - Идентификатор торговой точки
reasonId	[ID] - Идентификатор результата визита

Возвращает

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

isFinished (outletId, date, routeId)

isFinished	(	outletId	,
		date	,
		routeId
	)

Совершен ли визит в ТТ

Аргументы

outletId	[ID] - Идентификатор торговой точки
date	[Date] optional - Дата, если не задана, то текущая
routeId	[ID] optional - Идентификатор маршрута, если не задан, то текущий

Возвращает

Boolean

isStarted (outletId, routeId)

isStarted	(	outletId	,
		routeId
	)

Начат ли визит в ТТ

Аргументы

outletId	[ID] - Идентификатор торговой точки
routeId	[ID] optional - Маршрут, если не задан, то текущий

Возвращает

Boolean

nextExpectedOutletVisitId (outletId, routeId)

nextExpectedOutletVisitId	(	outletId	,
		routeId
	)

Вернуть следующий плановый или дополнительный визит в торговую точку за период равный настройке многонедельности данного маршрута

Аргументы

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

Возвращает

ID - Идентификатор планового или дополнительного визита

nextExpectedRouteVisitId (routeId)

nextExpectedRouteVisitId

(

routeId

)

Получить следующий по порядку визит на маршруте

Аргументы

routeId

[ID] optional - Идентификатор маршрута, если не задан, то текущий

Возвращает

ID - Идентификатор планового или дополнительного визита

reasonModel ()

* reasonModel

(

)

Функция, возвращающая список результатов визита

Возвращает

VisitResult[]

start (outletId)

start

(

outletId

)

Начать визит в ТТ

Аргументы

outletId

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

Возвращает

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

visitInfo (visitId)

visitInfo

(

visitId

)

Вернуть объект, описывающий фактический или плановый визит

Аргументы

visitId

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

Возвращает

Visit - Информация о визите

visitList (dateOrPeriod, routeOrRouteList)

visitList	(	dateOrPeriod	,
		routeOrRouteList
	)

Получить список визитов

Аргументы

dateOrPeriod	[Date or Period] optional - Дата или период, если не задано, то текущая дата
routeOrRouteList	[ID or IDList] optional - Маршрут или список маршрутов, если не задан, то текущий

Возвращает

Visit[]

visitListByOutlet (outletId, dateOrPeriod, routeOrRouteList)

visitListByOutlet	(	outletId	,
		dateOrPeriod	,
		routeOrRouteList
	)

Получить список визитов в торговую точку

Аргументы

outletId	[ID] - Идентификатор торговой точки
dateOrPeriod	[Date or Period] optional - Дата или период, если не задано, то текущая дата
routeOrRouteList	[ID or IDList] optional - Маршрут или список маршрутов, если не задан, то текущий

Возвращает

Visit[]