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 - возвращается идентификатор добавленного фотообъекта (type ID)

Throws:

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

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

create(outletId) → Result

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

Parameters:

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

Return:

Result -

Результат выполнения операции.
В поле value - идентификатор имеющегося черновика или только что созданного (type 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 - идентификатор текущего документа, если документ является черновиком,
или идентификатор новой версии текущего документа (type 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 - заголовочная часть документа Фотоотчет (type DocumentHeader)

Throws:

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

lastDocId(outletId) → Result

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

Parameters:

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

Return:

Result -

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

photoObject(docId, photoObjectId) → Result

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

Parameters:

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

Return:

Result -

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

Throws:

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

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

photoObjectIdList(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 транзакция откатится