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

Главная

api.visits

Визиты

Methods

api.visits.canFinish(outletId) → Result
api.visits.canStart(outletId) → Result
api.visits.currentVisit(routeId) → Visit
api.visits.dateOfLastVisit(idOutlet, days) → Date
api.visits.dateOfLastVisitOrOrder(idOutlet, days) → String
api.visits.factVisitDaysByOutlet(routeId, outletId, dayLimit) → DateList
api.visits.finish(outletId, reasonId) → Result
api.visits.isFinished(outletId, date, routeId) → Boolean
api.visits.isStarted(outletId, routeId) → Boolean
api.visits.nextVisit(routeId, outletId) → Visit
api.visits.nextVisitDate(outletId, routeId) → Date
api.visits.nextVisitDayCount(routeId, outletId) → Number
api.visits.reasonModel() → Array.<Object>
api.visits.start(outletId) → Result
api.visits.visitList(dateOrPeriod, routeOrRouteList) → VisitList
api.visits.visitListByOutlet(outletId, date, route) → VisitList

Methods description

canFinish(outletId) → Result

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

Parameters:
Name Type Description
outletId ID

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

Если не успешно, то результат содержит текст ошибки

canStart(outletId) → Result

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

Parameters:
Name Type Description
outletId ID

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

Если не успешно, то результат содержит текст ошибки

currentVisit(routeId) → Visit

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

Parameters:
Name Type Argument Description
routeId ID optional 

Идентификатор маршрута, если не задан, то текущий
Return:
Visit

dateOfLastVisit(idOutlet, days) → Date

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

Parameters:
Name Type Description
idOutlet ID
days Number
Return:
Date

dateOfLastVisitOrOrder(idOutlet, days) → String

Функция получения даты последнего визита или оформления последнего заказа (то, что ближе к сегодняшней дате)

Parameters:
Name Type Description
idOutlet ID
days Number
Return:
String -

формат: yyyy-MM-dd

factVisitDaysByOutlet(routeId, outletId, dayLimit) → DateList

Функция возвращает дни фактических визитов

Parameters:
Name Type Description
routeId ID

Торговая точка
outletId ID

Маршрут
dayLimit Number

ограничение на количество дней возврата, 0 - без ограничений
Return:
DateList

finish(outletId, reasonId) → Result

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

Parameters:
Name Type Argument Description
outletId ID

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

Идентификатор результата визита
Return:
Result -

Если не успешно, то результат содержит текст ошибки

isFinished(outletId, date, routeId) → Boolean

Получить признак, что совершен визит в ТТ

Parameters:
Name Type Argument Description
outletId ID

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

Дата, если не задана, то текущая
routeId ID optional 

Идентификатор маршрута, если не задан, то текущий
Return:
Boolean

isStarted(outletId, routeId) → Boolean

Получить признак, что начат визит в ТТ

Parameters:
Name Type Argument Description
outletId ID

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

Идентификатор маршрута, если не задан, то текущий
Return:
Boolean

nextVisit(routeId, outletId) → Visit

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

Parameters:
Name Type Argument Description
routeId ID optional 

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

Идентификатор ТТ, если не задан, то первая по плану
Return:
Visit

nextVisitDate(outletId, routeId) → Date

Получить следующию дату планового визита

Parameters:
Name Type Description
outletId ID

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

Идентификатор маршрута, если не задан, то текущий
Return:
Date

nextVisitDayCount(routeId, outletId) → Number

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

Parameters:
Name Type Description
routeId ID
outletId ID
Return:
Number

reasonModel() → Array.<Object>

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

Return:
Array.<Object>

start(outletId) → Result

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

Parameters:
Name Type Description
outletId ID

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

Если не успешно, то результат содержит текст ошибки

visitList(dateOrPeriod, routeOrRouteList) → VisitList

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

Parameters:
Name Type Argument Description
dateOrPeriod Date | Period optional 

Дата или период, если не задано, то текущая дата
routeOrRouteList ID | IDList optional 

Маршрут или список маршрутов, если не задан, то текущий
Return:
VisitList

visitListByOutlet(outletId, date, route) → VisitList

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

Parameters:
Name Type Argument Description
outletId ID

Идентификатор торговой точки
date Date | Period optional 

Дата или период, если не задано, то текущая дата
route ID | IDList optional 

Маршрут или список маршрутов, если не задан, то текущий
Return:
VisitList