api.surveyꓸdoc

Methods

api.surveyꓸdoc.answer(docId, topicId, questionId) → Result

api.surveyꓸdoc.create(outletId, distributorId, templateId) → Result

api.surveyꓸdoc.del(docId) → Result

api.surveyꓸdoc.edit(docId) → Result

api.surveyꓸdoc.editHeader(header) → Result

api.surveyꓸdoc.header(docId) → Result

api.surveyꓸdoc.putAnswer(docId, topicId, questionId, answer) → Result

api.surveyꓸdoc.questionIdList(docId, topicId) → Result

api.surveyꓸdoc.topicIdList(docId) → Result

api.surveyꓸdoc.validate(docId) → Result

Methods description

answer(docId, topicId, questionId) → Result

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

Parameters:

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

Return:

Result -

Результат выполнения операции.
В поле value - ответ на вопрос ОЛ (type Answer)

Throws:

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

create(outletId, distributorId, templateId) → Result

Создать новый документ ОЛ на основе заданного шаблона. Во время создания документа происходит заполнение историческими и дефолтными ответами.

Parameters:

Name	Type	Description
outletId	ID	Идентификатор ТТ
distributorId	ID	Идентификатор дистрибьютора
templateId	ID	Идентификатор шаблона

Return:

Result -

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

Throws:

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

del(docId) → Result

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

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа ОЛ

Return:

Result -

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

Throws:

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

edit(docId) → Result

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

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа ОЛ

Return:

Result -

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

Throws:

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

editHeader(header) → Result

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

Parameters:

Name	Type	Description
header	Document	Новые параметры для существующей заголовочной части документа ОЛ

Return:

Result -

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

Throws:

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

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

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

header(docId) → Result

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

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа ОЛ

Return:

Result -

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

Throws:

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

putAnswer(docId, topicId, questionId, answer) → Result

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

Parameters:

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

Return:

Result -

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

Throws:

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

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

• Если значения values ответа (answer) не входят в ОДЗ(область допустимых значений) вопроса, вернется ошибка

questionIdList(docId, topicId) → Result

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

Parameters:

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

Return:

Result -

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

Throws:

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

topicIdList(docId) → Result

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

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа ОЛ

Return:

Result -

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

Throws:

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

validate(docId) → Result

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

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа ОЛ

Return:

Result -

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

Throws:

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