api.docphoto.doc

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

Общие функции работы с документом Фотоотчет

api.docphoto.doc

Открытые члены
	addPhotoObject (docId, photoObject)
	Добавить новый фотообъект с фотографиями в документ Фотоотчет Подробнее...
	create (outletId)
	Создать новый документ Фотоотчет Подробнее...
	del (docId)
	Удалить документ Фотоотчет Подробнее...
	delPhotoObject (docId, photoObjectId)
	Удалить фотообъект и принадлежащие ему фотографии из документа Фотоотчет Подробнее...
	edit (docId)
	Отредактировать документ Фотоотчет Подробнее...
	editComment (docId, comment)
	Изменить комментарий документа Фотоотчет Подробнее...
	editPhotoObject (docId, photoObject)
	Отредактировать список фотографий и их свойства в фотообъекте документа Фотоотчет. Новые фотографии будут добавлены в фотообъект документа и зарегистрированы к отправке. Старые фотографии, отсутствующие в передаваемом фотообъекте, будут удалены и разрегистрированы для отправки Подробнее...
	header (docId)
	Получить заголовочную часть документа Фотоотчет Подробнее...
	lastDocId (outletId)
	Получить ID последнего доступного документа Фотоотчет (черновик либо валидный) в указанной ТТ Подробнее...
	photoObject (docId, photoObjectId)
	Получить фотообъект документа Фотоотчет Подробнее...
	photoObjectIdList (docId)
	Получить список идентификаторов всех фотообъектов в документе Фотоотчет Подробнее...
	validate (docId)
	Валидировать документ Фотоотчет Подробнее...

Методы

addPhotoObject (docId, photoObject)

addPhotoObject	(	docId	,
		photoObject
	)

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

Аргументы

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

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

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

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

Возвращает

Result - Результат добавления фотообъекта в Фотоотчет.
В поле value - идентификатор добавленного фотообъекта (ID)

create (outletId)

create

(

outletId

)

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

Аргументы

outletId

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

Возвращает

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

del (docId)

del

(

docId

)

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

Аргументы

docId

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

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

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

Возвращает

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

delPhotoObject (docId, photoObjectId)

delPhotoObject	(	docId	,
		photoObjectId
	)

Удалить фотообъект и принадлежащие ему фотографии из документа Фотоотчет

Аргументы

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

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

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

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

Возвращает

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

edit (docId)

edit

(

docId

)

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

Аргументы

docId

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

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

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

Возвращает

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

editComment (docId, comment)

editComment	(	docId	,
		comment
	)

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

Аргументы

docId	[ID] - Идентификатор существующего документа Фотоотчет
comment	[String] - Новый комментарий документа Фотоотчет

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

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

Возвращает

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

editPhotoObject (docId, photoObject)

editPhotoObject	(	docId	,
		photoObject
	)

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

Аргументы

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

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

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

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

Возвращает

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

header (docId)

* header

(

docId

)

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

Аргументы

docId

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

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

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

Возвращает

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

lastDocId (outletId)

lastDocId

(

outletId

)

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

Аргументы

outletId

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

Возвращает

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

photoObject (docId, photoObjectId)

* photoObject	(	docId	,
		photoObjectId
	)

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

Аргументы

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

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

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

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

Возвращает

Result - Результат получения фотообъекта документа Фотоотчет,
В поле value - фотообъект в документе Фотоотчет (DocPhoto_PhotoObject)

photoObjectIdList (docId)

photoObjectIdList

(

docId

)

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

Аргументы

docId

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

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

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

Возвращает

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

validate (docId)

validate

(

docId

)

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

Аргументы

docId

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

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

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

Возвращает

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