Method GetDocumentsSimple

GetDocumentsSimple(String, List<String>, List<String>, GetDocumentOptionsContract)

Returns a list of simple document informations

Declaration

GetDocumentsSimpleResultContract GetDocumentsSimple(string connectionId, List<string> documentIds, List<string> resultProperties, GetDocumentOptionsContract options)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
System.Collections.Generic.List<System.String>	documentIds	List of document ids
System.Collections.Generic.List<System.String>	resultProperties	Optional: List of property type ids which should be returned
GetDocumentOptionsContract	options	Document option parameters. See also GetDocumentOptionsContract

Returns

Type	Description
GetDocumentsSimpleResultContract	Returns an instance of GetDocumentsSimpleResultContract that contains a list of DocumentSimpleContract and a list of ServiceExceptionListItemContract. If getting a document fails, a ServiceException is added to the latter list together with the document id (see also ObjectId).

Examples

POST http://YourServerName/InfoShare/Json/Document/GetDocumentsSimple

An example that returns a list of simple document informations.

{
   "connectionId": "ad30a38c-711f-4262-9699-36622bf095c7",
   "documentIds": [ "1489e290-f9ac-44d8-a6c7-d8051de6db28", "5c9e6e28-c687-450e-8d9f-04aba04a06a4" ],
   "resultProperties": [ "01004001-38a7-11d8-a902-0050bf427e8f", "01004002-38a7-11d8-a902-0050bf427e8f",
     "01004003-38a7-11d8-a902-0050bf427e8f", "01004004-38a7-11d8-a902-0050bf427e8f", 
     "01004005-38a7-11d8-a902-0050bf427e8f", "01004012-38a7-11d8-a902-0050bf427e8f",
     "01004013-38a7-11d8-a902-0050bf427e8f" ],
   "options": {
     "IgnoreDocumentNotFoundExceptions": true,
     "IgnoreNotEnoughRightsException": "false" }
}

Response:

{
   "GetDocumentsSimpleResult": { 
     "DocumentsSimple": [{
       "AccessRightsEnumList": [ "CheckOut", "EditContent", "EditMultiple", "CancelCheckOut", "Delete", "EditAnnotation",
         "EditProperties", "GrantAccessToOtherUsers", "Move", "SetSecurity", "OverwriteVersion", "ViewVersionLog",
         "ViewChangeLog", "ViewAccessLog", "ChangeRequiredList", "CreateBlog", "DeleteBlog", "EditBlog", "ViewBlog",
         "RemoveDocumentContent", "Export", "View", "Send", "SendAsFax", "Print" ],
       "CheckOutStateEnum": "NotCheckedOut",
       "FolderElementId": null,
       "HasAbonnement": false,
       "HasAnnotation": false,
       "HasBlog": false,
       "HasLinks": false,
       "HasReminders": false,
       "HasSignature": false,
       "HasTempAccess": false,
       "Id": "1489e290-f9ac-44d8-a6c7-d8051de6db28",
       "MainFileLength": 51625,
       "Name": "Test Subject.eml",
       "Properties": [{
         "GlobalValues": [],
         "PropertyTypeId": "01004001-38a7-11d8-a902-0050bf427e8f",
         "Values": [ "Test Subject" ] }, {
         "GlobalValues": [],
         "PropertyTypeId": "01004002-38a7-11d8-a902-0050bf427e8f",
         "Values": [ "Hans.Muster@kendox.com" ] }, {
         "GlobalValues": [],
         "PropertyTypeId": "01004003-38a7-11d8-a902-0050bf427e8f",
         "Values": [ "Test@kendox.com" ] }, {
         "GlobalValues": [],
         "PropertyTypeId": "01004004-38a7-11d8-a902-0050bf427e8f",
         "Values": [] }, {
         "GlobalValues": [],
         "PropertyTypeId": "01004005-38a7-11d8-a902-0050bf427e8f",
         "Values": [] }, {
         "GlobalValues": [],
         "PropertyTypeId": "01004012-38a7-11d8-a902-0050bf427e8f",
         "Values": [ "2023-07-17T07:16:08" ] }, {
         "GlobalValues": [],
         "PropertyTypeId": "01004013-38a7-11d8-a902-0050bf427e8f",
         "Values": [ "2023-07-17T07:16:25" ] }],
       "VersionId": "1489e290-f9ac-44d8-a6c7-d8051de6db28" }, {
       "AccessRightsEnumList": [ "CheckOut", "EditContent", "EditMultiple", "CancelCheckOut", "Delete", "EditAnnotation",
         "EditProperties", "GrantAccessToOtherUsers", "Move", "SetSecurity", "OverwriteVersion", "ViewVersionLog",
         "ViewChangeLog", "ViewAccessLog", "ChangeRequiredList", "CreateBlog", "DeleteBlog", "EditBlog", "ViewBlog",
         "RemoveDocumentContent", "Export", "View", "Send", "SendAsFax", "Print" ],
       "CheckOutStateEnum": "NotCheckedOut",
       "FolderElementId": null,
       "HasAbonnement": false,
       "HasAnnotation": false,
       "HasBlog": false,
       "HasLinks": false,
       "HasReminders": false,
       "HasSignature": false,
       "HasTempAccess": false,
       "Id": "5c9e6e28-c687-450e-8d9f-04aba04a06a4",
       "MainFileLength": 3168,
       "Name": "MailArchiverMailBoxCompleted_22(2).log",
       "Properties": [{
         "GlobalValues": [],
         "PropertyTypeId": "01004001-38a7-11d8-a902-0050bf427e8f",
         "Values": [ "Attachment" ] }, {
         "GlobalValues": [],
         "PropertyTypeId": "01004002-38a7-11d8-a902-0050bf427e8f",
         "Values": [ "Hans.Muster@kendox.com" ] }, {
         "GlobalValues": [],
         "PropertyTypeId": "01004003-38a7-11d8-a902-0050bf427e8f",
         "Values": [ "Test@kendox.com" ] }, {
         "GlobalValues": [],
         "PropertyTypeId": "01004004-38a7-11d8-a902-0050bf427e8f",
         "Values": [] }, {
         "GlobalValues": [],
         "PropertyTypeId": "01004005-38a7-11d8-a902-0050bf427e8f",
         "Values": [] }, {
         "GlobalValues": [],
         "PropertyTypeId": "01004012-38a7-11d8-a902-0050bf427e8f",
         "Values": [ "2023-11-22T12:36:17" ] }, {
         "GlobalValues": [],
         "PropertyTypeId": "01004013-38a7-11d8-a902-0050bf427e8f",
         "Values": [ "2023-11-22T12:36:20" ] }],
       "VersionId": "5c9e6e28-c687-450e-8d9f-04aba04a06a4" }],
     "Exceptions": []
   }     
}

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	No document found for documentId {documentId} (10005)
ServiceException	Unknown data type for property type (10035)
ServiceException	Not enough rights ({accessOperationName}, {accessOperationId}) (10071)
ServiceException	Verification code is needed: Verification code not yet verified (10152)