api.survey.service

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

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

api.survey.service

Открытые члены
	questions (templateId, topicId, outletId, distributorId)
	Получить список всех вопросов в разрезе указанной темы шаблона Подробнее...
	questionTitle (questionId)
	Получить заголовок вопроса по его идентификатору Подробнее...
	resolveDistributorId (templateId, outletId)
	Получить идентификатор дистрибьютора, на которого можно оформить документ ОЛ на основе заданного шаблона Подробнее...
	resolveOutletId (templateId, territoryOutletId)
	Получить идентификатор торговой точки, на которую можно создать документ ОЛ на основе заданного шаблона Подробнее...
	templateById (templateId)
	Получить шаблон ОЛ Подробнее...
	templateIdList (outletId)
	Получить список всех идентификаторов шаблонов, назначенных на данную торговую точку Подробнее...
	topics (templateId)
	Получить список всех тем, назначенных в данный шаблон Подробнее...
	topicTitle (topicId)
	Получить заголовок темы по ее идентификатору Подробнее...

Методы

questions (templateId, topicId, outletId, distributorId)

* questions	(	templateId	,
		topicId	,
		outletId	,
		distributorId
	)

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

Аргументы

templateId	[ID] - Идентификатор шаблона
topicId	[ID] - Идентификатор темы, назначенной в данный шаблон
outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] - Идентификатор дистрибьютора

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

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

Возвращает

Result - Результат выполнения операции.
В поле value - список всех вопросов в разрезе указанной темы шаблона (SurveyQuestion[])

questionTitle (questionId)

questionTitle

(

questionId

)

Получить заголовок вопроса по его идентификатору

Аргументы

questionId

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

Возвращает

Result - Результат выполнения операции.
В поле value - заголовок вопроса (String)

resolveDistributorId (templateId, outletId)

resolveDistributorId	(	templateId	,
		outletId
	)

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

Аргументы

templateId	[ID] - Идентификатор шаблона
outletId	[ID] - Идентификатор торговой точки

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

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

Возвращает

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

resolveOutletId (templateId, territoryOutletId)

resolveOutletId	(	templateId	,
		territoryOutletId
	)

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

Аргументы

templateId	[ID] - Идентификатор шаблона
territoryOutletId	[ID] - Идентификатор торговой точки из территории

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

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

Возвращает

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

templateById (templateId)

* templateById

(

templateId

)

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

Аргументы

templateId

[ID] - Идентификатор существующего шаблона

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

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

Возвращает

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

templateIdList (outletId)

templateIdList

(

outletId

)

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

Аргументы

outletId

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

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

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

Возвращает

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

topics (templateId)

topics

(

templateId

)

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

Аргументы

templateId

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

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

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

Возвращает

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

topicTitle (topicId)

topicTitle

(

topicId

)

Получить заголовок темы по ее идентификатору

Аргументы

topicId

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

Возвращает

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