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

Главная

api.surveyꓸservice

Сервисное апи документа Опросный лист (ОЛ).

Methods

api.surveyꓸservice.questions(templateId, topicId, distributorId) → Result
api.surveyꓸservice.resolveDistributorId(templateId, outletId) → Result
api.surveyꓸservice.resolveOutletId(templateId, territoryOutletId) → Result
api.surveyꓸservice.templateById(templateId) → Result
api.surveyꓸservice.templateIdList(outletId) → Result
api.surveyꓸservice.topics(templateId) → Result

Methods description

questions(templateId, topicId, distributorId) → Result

Получить список всех вопросов в разрезе указанной темы шаблона

Parameters:
Name Type Description
templateId ID

Идентификатор шаблона
topicId ID

Идентификатор темы, назначенной в данный шаблон
distributorId ID

Идентификатор дистрибьютора
Return:
Result -

Результат выполнения операции.
В поле value - список всех вопросов в разрезе указанной темы шаблона (type QuestionList)
Throws:

В случае хотя бы одного невалидного идентификатора templateId, topicId или distributorId вернется ошибка

resolveDistributorId(templateId, outletId) → Result

Получить идентификатор дистрибьютора, на которого можно оформить документ ОЛ на основе заданного шаблона

Parameters:
Name Type Description
templateId ID

Идентификатор шаблона
outletId ID

Идентификатор ТТ
Return:
Result -

Результат выполнения операции.
В поле value - идентификатор дистрибьютора, на которого можно оформить документ ОЛ на основе заданного шаблона (type ID)
Throws:

В случае хотя бы одного невалидного идентификатора templateId или outletId вернется ошибка

resolveOutletId(templateId, territoryOutletId) → Result

Получить идентификатор ТТ, на которую можно создать документ ОЛ на основе заданного шаблона

Parameters:
Name Type Description
templateId ID

Идентификатор шаблона
territoryOutletId ID

Идентификатор ТТ из территории
Return:
Result -

Результат выполнения операции.
В поле value - идентификатор ТТ, на которую можно создать документ ОЛ на основе заданного шаблона (type ID)
Throws:

В случае хотя бы одного невалидного идентификатора templateId или territoryOutletId вернется ошибка

templateById(templateId) → Result

Получить шаблон ОЛ

Parameters:
Name Type Description
templateId ID

Идентификатор существующего шаблона
Return:
Result -

Результат выполнения операции.
В поле value - шаблон ОЛ (type Template)
Throws:

В случае невалидного идентификатора templateId вернется ошибка

templateIdList(outletId) → Result

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

Parameters:
Name Type Description
outletId ID

Идентификатор ТТ
Return:
Result -

Результат выполнения операции.
В поле value - список всех идентификаторов шаблонов, назначенных на данную ТТ (type IDList)
Throws:

В случае невалидного идентификатора outletId вернется ошибка

topics(templateId) → Result

Получить список всех тем, назначенных в данный шаблон

Parameters:
Name Type Description
templateId ID

Идентификатор шаблона
Return:
Result -

Результат выполнения операции.
В поле value - список тем, назначенных в данный шаблон (type TopicList)
Throws:

В случае невалидного идентификатора templateId вернется ошибка