 |
Метод GetInstructionsFolderList (Получить список поручений для папки)
|
|
|
|
Метод служит для получения списка поручений для заданной папки.
Формат вызова:
string GetInstructionsFolderList(
int folderID,
int startPosition,
int itemCount,
LanDocs.CommonTypes.ServerTypes.GroupAttributes groupAttributes,
string[] members,
string constraint,
bool disableLogging
)
Параметры:
§ folderID – идентификатор папки;
§ startPosition – смещение от начала списка. Для выборки с самого начала: 0 или -1;
§ itemCount – число требуемых элементов. Рекомендуемый диапазон значений для быстрой работы метода - не более 500-1000 элементов. При значении -1 система сама ограничит число элементов подходящим значением (см. 5.1);
§ groupAttributes – один из стандартных наборов полей. Рекомендуется ListItems;
§ members – дополнительные аттрибуты не входящие в стандартный набор. Если какой-либо аттрибут нужен для приложения, то его лучше указывать, даже если он входит в стандартный набор на момент разработки приложения;
§ contstraint – дополнительное условие отбора элементов;
§ disableLogging – позволяет отключить логирование операции. Это может быть полезно для приложений выполняющих фоновую загрузку, когда операция фактически не отражает действия пользователя. Но в этом случае прлиожение должно само залогировать действия пользователя;
Результат выполнения операции:
Возвращает cериализованный в строку DataSet.
Примеры:
Вывод списка поручений из папки:
GetInstructionsFolderList(MailFolderID,
-1, -1, LanDocsServerTypes.GroupAttributes.ListItems, null, null)
Вывод количества поручений из папки:
GetInstructionsFolderListCount(MailFolderID, null)
Метод GetInstruction (Получить атрибуты поручения)
Метод служит для получения атрибутов заданного поручения.
Формат вызова:
string GetInstruction(
int instructionID,
LanDocs.CommonTypes.ServerTypes.GroupAttributes groupAttributes,
string[] members
)
Параметры:
§ InstructionID – идентификатор поручения.
Пример:
Вывод реквизитов поручения:
|
|
|
GetInstruction(InstructionID, LanDocsServerTypes.GroupAttributes.ListItems, null)
Метод GetRepositoryModule (Получить XML-представление модуля в виде строки)
Метод служит для представления модуля репозитория в виде XML-строки.
Формат вызова:
String GetRepositoryModule(string name)
Параметр:
§ Name – имя модуля репозитория.
Результат выполнения операции:
Возвращает по имени модуля репозитория его XML-представление в виде строки.
Новые методы web-сервиса BMService.asmx
В данном разделе описаны доработки web-сервиса BMService.asmx, произведенные в процессе выпуска промышленной версии Сервера контента (3.0.2). В доработках были учтены замечания, которые высказывали разработчики компаний-партнеров.
OpenVersionedServerSession
Метод позволяет авторизоваться и открыть сессию на сервере приложений для приложения, рассчитанного на определенную модель данных приложения: для поддержания обратной совместимости, сервер приложений может менять формат возвращаемых данных, в зависимости от переданной версии клиента.
Описание:
service.OpenVersionedServerSession(“dba”, “password”, “3.0.1.45”);
Параметры:
§ Login – логин для входа в систему;
§ Password – пароль для входа в систему;
§ Version – номер версии сервера контента (четыре цифры) на работу с которой рассчитано приложение (обычно версия сервера контента на момент разработки внешнего приложения, например 3.0.1.45). Если передать пустую строку, то это соответствует значению, устанавливаемому при открытии сессии методами OpenServerSession и OpenWindowsServerSession. Сервер контента в этом случае формирует данные в режиме эмуляции версии до 2.0.8.7. Для вновь разрабатываемых приложений передавать пустое значение не рекомендуется.
Результат выполнения: успешно/неуспешно.
OpenWindowsServerSession
Метод позволяет авторизоваться и открыть сессию на сервере приложений, используя Windows-аутентификацию (Windows authentication). Для работы этого метода Windows-аутентификация должна быть разрешена на уровне IIS. Обычно для правильной работы Windows-аутентификации в ASP.NET анонимные соединения в IIS должны быть запрещены.
|
|
|
Для указания модели данных, на которое расчитано клиентское приложение, используйте метод SetVersion.
Описание:
server.OpenWindowsServerSession()
Результат выполнения: успешно/неуспешно либо исключение.
Неуспешно (результат = false) означает, что пользователь был успешно аутентифицирован, но ему не разрешено работать с сервером приложений LanDocs.
Рекомендуется сразу после успешного завершения вызвать метод SetVersion
SetVersion
Метод позволяет задать версию модели данных на которую pассчитывает клиентское приложение: для поддержания обратной совместимости, сервер приложений может менять формат возвращаемых данных, в зависимости от переданной версии клиента.
Описание:
service.SetVersion(“3.0.1.45”);
Параметры:
§ Version – номер версии сервера контента (четыре цифры) на работу с которой рассчитано приложение (обычно версия сервера контента на момент разработки внешнего приложения, например 3.0.1.45). Если передать пустую строку, то это соответствует значению, устанавливаемому при открытии сессии методами OpenServerSession и OpenWindowsServerSession. Сервер контента в этом случае формирует данные в режиме эмуляции версии до 2.0.8.7. Для вновь разрабатываемых приложений передавать пустое значение не рекомендуется.
Результат выполнения: исключение в случае ошибки.
SaveDocumentOperation
Метод позволяет сохранить операцию над документом, не накладывая ЭП. Обычно это используется при отказе выполнять операцию надо документом.
Описание:
String SaveDocumentOperation(int operationTypeID, int objectID, bool rejected, string message);
Параметры:
§ OperationTypeID (Int) – тип операции из справочника INSTRUCTIONTYPES;
§ Objected (Int) – идентификатор объекта (например, документа);
§ Rejected (Bool) – зарегистрировать как отказ или подтверждение выполнения;
§ Message (String) – дополнительные комментарии к операции.
Результат выполнения:
Возвращается строка с текстовым результатом выполнения операции типа Success. В случае ошибки при сохранении данных вернется SOAP fault.
Пример использования:
String result = service.SaveDocumentOperation(int operationTypeID, int objectID, bool rejected, string message)
SaveFileVersionSign
Метод позволяет сохранить ЭП операции над файлом в отдельном запросе. В качестве времени операции будет подставлено время сервера приложений.
|
|
|
Описание:
public string SaveFileVersionSign(int operationTypeID, byte[] operationESign, int fileID, byte[] fileSign)
Параметры:
§ OperationTypeID (int) – тип операции из справочника INSTRUCTIONTYPES;
§ OperationESign (Byte[]) – цифровая подпись операции над файлом, формируется на основе типа операции и цифровой подписи файла;
§ FileID (Int) – идентификатор версии файла;
§ FileSign (Byte[]) – цифровая подпись содержимого файла.
Результат выполнения:
Возвращается строка с текстовым результатом выполнения операции типа Success. В случае ошибки при сохранении данных вернется SOAP fault.
Пример использования:
String result = service.SaveFileVersionSign(operationTypeID, operationESign, fileID, fileSign);
SetReadFlag
Метод выставляет или сбрасывает флаг «Прочитан» для объекта.
Описание:
void SetReadFlag(int objectId, bool read);
Параметры:
§ Objected – идентификатор объекта;
§ Read – признак «Прочитан». true – прочитан, false –не прочитан.
Пример использования:
Service.SetReadFlag(docId, read);
GetServiceVersion
Метод возвращает текущую версию сервиса, включая номер сборки. Метод предназначен для включения этой информации в журналы работы внешних приложений.
Пример использования:
string version = service.GetServiceVersion();
Пример возвращенного значения:
3.3.0.33.1412 RC
§ 3.3.0.33 – версия сервисов (обычно совпадает с версией сервера контента);
§ 1412 – номер сборки;
§ RС - статус
LockObject
Метод блокирует объект.
Описание:
bool LockObject(int objectID);
Параметр
§ ObjectID – идентификатор объекта.
Результат выполнения:
Метод возвращает:
§ true – объект был заблокирован успешно,
§ false – объект уже был заблокирован этим пользователем ранее;
§ исключение (SOAP Fault) – блокировка не удалась.
| В текущей реализации метод всегда возвращает true, если блокировка наложена данным пользователем, т.е. не различает ситуаци «заблокирован сейчас» и «был заблокирован данным пользователем раньше». Это будет исправлено в дальнейших версиях в соответствии с данной спецификацией. |
UnlockObject
Метод снимает блокировку с объекта.
Описание:
public bool UnlockObject(int objectID);
Параметр:
§ ObjectID – идентификатор объекта.
Результат выполнения:
Метод возвращает:
|
|
|
§ true – блокировка была снята успешно;
§ false – объект остался заблокирован другим пользователем.
|
| В текущей реализации метод всегда возвращает true, если не было системных ошибок, т.е. не различает ситуации «блокировка была снята» и «объект остался заблокирован другим пользователем». Это будет исправлено в дальнейших версиях в соответствии с данной спецификацией. |
LockFilesForVersions
Метод позволяет в одной транзакции наложить блокировку на версии нескольких файлов и возвращает актуальные идентификаторы файлов. Метод может быть полезен при подписании документов или поручений, к которым прикреплено несколько файлов.
Описание:
int[] LockFilesForVersions(int[] versions);
Параметр:
§ Versions – список версий на блокировку.
Результат выполнения:
Метод возвращает идентификаторы файлов (последние версии), соответствующие этим версиям.
|
|
|
