api.docphotoꓸdoc

Methods

api.docphotoꓸdoc.addPhotoObject(docId, photoObject) → Result

api.docphotoꓸdoc.create(outletId) → Result

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

api.docphotoꓸdoc.delPhotoObject(docId, photoObjectId) → Result

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

api.docphotoꓸdoc.editComment(docId, comment) → Result

api.docphotoꓸdoc.editPhotoObject(docId, photoObject) → Result

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

api.docphotoꓸdoc.lastDocId(outletId) → Result

api.docphotoꓸdoc.photoObject(docId, photoObjectId) → Result

api.docphotoꓸdoc.photoObjectIdList(docId) → Result

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

Methods description

addPhotoObject(docId, photoObject) → Result

Добавить новый фотообъект с фотографиями в документ Фотоотчет

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа Фотоотчет
photoObject	DocPhoto_PhotoObject	Структура существующего фотообъекта с новыми значениями

Return:

Result -

Результат добавления фотообъекта в Фотоотчет. При успешном результате в поле value возвращается идентификатор ID добавленного фотообъекта

Throws:

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

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

create(outletId) → Result

Создать новый документ Фотоотчет

Parameters:

Name	Type	Description
outletId	ID	Идентификатор ТТ

Return:

Result -

Результат создания документа. При успешном результате в поле value возвращается ID имеющегося черновика или только что созданного

del(docId) → Result

Удалить документ Фотоотчет

Parameters:

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

Return:

Result -

Признак успешного удаления документа Фотоотчет

Throws:

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

delPhotoObject(docId, photoObjectId) → Result

Удалить фотообъект и принадлежащие ему фотографии из документа Фотоотчет. Одновременно с удалением фотографий производится откат регистрации файлов к отправке.

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа Фотоотчет
photoObjectId	ID	Идентификатор существующего фотообъекта

Return:

Result -

Признак успешного удаления фотообьекта

Throws:

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

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

edit(docId) → Result

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

Parameters:

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

Return:

Result -

Результат редактирования документа. При успешном результате в поле value возвращается идентификатор ID текущего документа, если документ является черновиком, или идентификатор новой версии текущего документа

Throws:

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

editComment(docId, comment) → Result

Изменить комментарий документа Фотоотчет

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа Фотоотчет
comment	string	Новый комментарий документа Фотоотчет

Return:

Result -

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

Throws:

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

editPhotoObject(docId, photoObject) → Result

Отредактировать список фотографий и их свойства в фотообъекте документа Фотоотчет. Новые фотографии будут добавлены в фотообъект документа и зарегестрированы к отправке. Старые фотографии, отсутствующие в передаваемом фотообъекте, будут удалены и разрегестрированы для отправки

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа Фотоотчет
photoObject	DocPhoto_PhotoObject	Структура фотообъекта с изменениями

Return:

Result -

Признак успешного изменения данных фотообьекта

Throws:

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

• В случае невалидного объекта photoObject вернется ошибка

header(docId) → Result

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

Parameters:

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

Return:

Result -

Результат получения заголовка документа. В поле value возвращается структура DocumentHeader заголовочной части документа Фотоотчет

Throws:

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

lastDocId(outletId) → Result

Получить ID последнего доступного документа Фотоотчет (черновик либо валидный) в указанной ТТ

Parameters:

Name	Type	Description
outletId	ID	Идентификатор ТТ

Return:

Result -

Результат поиска документа. При успешном результате в поле value возвращается идентификатор ID последнего документа доступного для редактирование, либо черновик, либо валидный документ.

photoObject(docId, photoObjectId) → Result

Получить фотообъект документа Фотоотчет

Parameters:

Name	Type	Description
docId	ID	Идентификатор существующего документа Фотоотчет
photoObjectId	ID	Идентификатор требуемого фотообъекта

Return:

Result -

Результат получения фотообъекта документа Фотоотчет, в поле value возвращается структура DocPhoto_PhotoObject

Throws:

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

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

photoObjectIdList(docId) → Result

Получить список идентификаторов всех фотообъектов в документе Фотоотчет

Parameters:

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

Return:

Result -

Результат получения списка фотообъектов документа, в поле value возвращается список идентификаторов всех фотообъектов, имеющихся в документе Фотоотчет

Throws:

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

validate(docId) → Result

Валидировать документ Фотоотчет

Parameters:

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

Return:

Result -

Признак успешного завершения валидации документа Фотоотчет

Throws:

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