api.survey.doc

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

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

api.survey.doc

Открытые члены
	answer (docId, topicId, questionId)
	Получить строку документа ОЛ Подробнее...
	answers (docId)
	Получить все строки документа ОЛ Подробнее...
	create (outletId, distributorId, templateId)
	Создать новый документ ОЛ на основе заданного шаблона Подробнее...
	del (docId)
	Удалить документ ОЛ Подробнее...
	documentIdList (surveyConditions)
	Получить список всех идентификаторов ОЛ для переданных условий Подробнее...
	edit (docId)
	Отредактировать документ ОЛ Подробнее...
	editHeader (header)
	Изменить заголовочную часть документа ОЛ Подробнее...
	header (docId)
	Получить заголовочную часть документа ОЛ Подробнее...
	putAnswer (docId, topicId, questionId, answer)
	Добавить/отредактировать строку документа ОЛ Подробнее...
	questionIdList (docId, topicId)
	Получить список всех идентификаторов вопросов, для которых есть строки в документе ОЛ в разрезе указанной темы Подробнее...
	topicIdList (docId)
	Получить список всех идентификаторов тем, для вопросов которых есть строки в документе ОЛ Подробнее...
	validate (docId)
	Валидировать документ ОЛ Подробнее...

Методы

answer (docId, topicId, questionId)

answer	(	docId	,
		topicId	,
		questionId
	)

Получить строку документа ОЛ

Аргументы

docId	[ID] - Идентификатор существующего документа ОЛ
topicId	[ID] - Идентификатор существующей темы, присутствующей в данном ОЛ
questionId	[ID] - Идентификатор существующего вопроса, присутствующего в указанной теме

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

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

Возвращает

Result - Результат получения строки документа ОЛ.
В поле value - строка документа ОЛ (Answer)

answers (docId)

* answers

(

docId

)

Получить все строки документа ОЛ

Аргументы

docId

[ID] - Идентификатор существующего документа ОЛ

Возвращает

Result - Результат получения всех строк документа ОЛ.
В поле value - строки документа ОЛ (Answer[])

create (outletId, distributorId, templateId)

create	(	outletId	,
		distributorId	,
		templateId
	)

Создать новый документ ОЛ на основе заданного шаблона

Аргументы

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

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

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

Возвращает

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

del (docId)

del

(

docId

)

Удалить документ ОЛ

Аргументы

docId

[ID] - Идентификатор существующего документа ОЛ

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

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

Возвращает

Result - Признак успешного удаления документа ОЛ

documentIdList (surveyConditions)

* documentIdList

(

surveyConditions

)

Получить список всех идентификаторов ОЛ для переданных условий

Аргументы

surveyConditions

[SurveyConditions] - Условия для получения списка идентификаторов ОЛ

Возвращает

Result - Результат получения списка идентификаторов ОЛ.
В поле value - список идентификаторов ОЛ для переданных условий (IDList)

edit (docId)

edit

(

docId

)

Отредактировать документ ОЛ

Аргументы

docId

[ID] - Идентификатор существующего документа ОЛ

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

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

Возвращает

Result - Результат редактирования документа.
В поле value - идентификатор черновика документа ОЛ (ID)

editHeader (header)

editHeader

(

header

)

Изменить заголовочную часть документа ОЛ

Аргументы

header

[SurveyDocHeader] - Новые параметры для существующей заголовочной части документа ОЛ

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

В случае отсутствия параметра id в объекте header вернется ошибка

В случае отсутствия параметра templateId в объекте header вернется ошибка

В случае неправильно сформированного объекта header вернется ошибка сохранения данных

Возвращает

Result - Признак успешного сохранения заголовочной части документа ОЛ (если не успешно, то результат содержит текст ошибки)

header (docId)

* header

(

docId

)

Получить заголовочную часть документа ОЛ

Аргументы

docId

[ID] - Идентификатор существующего документа ОЛ

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

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

Возвращает

Result - Результат получения заголовка документа.
В поле value - заголовочная часть документа ОЛ (SurveyDocHeader)

putAnswer (docId, topicId, questionId, answer)

putAnswer	(	docId	,
		topicId	,
		questionId	,
		answer
	)

Добавить/отредактировать строку документа ОЛ

Аргументы

docId	[ID] - Идентификатор существующего документа ОЛ
topicId	[ID] - Идентификатор существующей темы, присутствующей в данном ОЛ
questionId	[ID] - Идентификатор существующего вопроса, присутствующего в указанной теме
answer	[Answer] - Новая строка документа ОЛ или новые параметры существующей строки документа ОЛ

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

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

В случае неправильно сформированного объекта answer вернется ошибка сохранения данных

Возвращает

Result - Признак успешного сохранения строки документа ОЛ (если не успешно, то результат содержит текст ошибки)

questionIdList (docId, topicId)

questionIdList	(	docId	,
		topicId
	)

Получить список всех идентификаторов вопросов, для которых есть строки в документе ОЛ в разрезе указанной темы

Аргументы

docId	[ID] - Идентификатор существующего документа ОЛ
topicId	[ID] - Идентификатор существующей темы, присутствующей в данном ОЛ

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

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

Возвращает

Result - Результат получения списка вопросов.
В поле value - cписок всех идентификаторов вопросов, для которых есть строки в документе ОЛ в разрезе указанной темы (IDList)

topicIdList (docId)

topicIdList

(

docId

)

Получить список всех идентификаторов тем, для вопросов которых есть строки в документе ОЛ

Аргументы

docId

[ID] - Идентификатор существующего документа ОЛ

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

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

Возвращает

Result - Результат получения списка тем.
В поле value - список всех идентификаторов тем, для вопросов которых есть строки в документе ОЛ (IDList)

validate (docId)

validate

(

docId

)

Валидировать документ ОЛ

Аргументы

docId

[ID] - Идентификатор существующего документа ОЛ

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

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

Возвращает

Result - Признак успешного завершения валидации документа ОЛ