Method GetDocuments

GetDocuments(String, List<String>, GetDocumentOptionsContract)

Returns a list of document informations

Declaration

List<DocumentContract> GetDocuments(string connectionId, List<string> documentIds, 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
GetDocumentOptionsContract	options	Document option parameters. See also GetDocumentOptionsContract

Returns

Type	Description
System.Collections.Generic.List<DocumentContract>	List of document informations

Examples

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

Example for returns a list of document informations.

{
   "connectionId": "1fbe116a-20a9-4378-b198-6cf3283f0238",
   "documentIds": ["7d58533d-75db-e911-a946-00155d290a08", "d2c01001-18d0-e911-a93a-00155d290a08"],
   "options": {
     "IgnoreDocumentNotFoundExceptions": true,
     "IgnoreNotEnoughRightsException": "false" }
}

Response:

{
   "GetDocumentsResult": [{
     "Abonnements": [],
     "AccessRightsEnumList": ["CheckOut", "Delete", "DeleteVersion", "EditAnnotation", "EditContent", 
     "EditProperties", "GrantAccessToOtherUsers", "Move", "SetSecurity", "OverwriteVersion", "ViewVersionLog", 
     "ViewChangeLog",  "ViewAccessLog", "EditMultiple", "ChangeRequiredList", "CreateBlog", "DeleteBlog", "EditBlog",
     "ViewBlog", "RemoveDocumentContent", "ExecuteApplication", "Export", "SendAsFax", "Print", "Send", "View"],
     "AnnotationManager": {
       "PostItAnnotations": [],
       "RectangleAnnotations": [],
       "StampAnnotations": [],
       "TextAnnotations": [] },
     "Blogs": [],
     "CheckOutStateEnum": "NotCheckedOut",
     "CheckOutUserId": "00000000-0000-0000-0000-000000000000",
     "DocumentData": [{
       "Id": "d659533d-75db-e911-a946-00155d290a08",
       "Name": "TestDocu.pdf",
       "Renditions": [{
         "ContentProtections": [],
         "Extension": "pdf",
         "Files": [{
           "BlobPath": "2019\\09\\20\\000\\000\\001TestDocu.pdf",
           "BlobStoreId": "217f2561-959e-4e3d-bbc0-99109043f1bd" }],
         "HashValue": [36, 26, 152, 24, 55, 245, 42, 107, 2, 203, 231, 232, 139, 28, 245, 227, 240, 182, 71, 15,
         60, 151, 44, 89, 106, 220, 125, 143, 219, 63, 228, 166, 172, 34, 106, 119, 57, 26, 146, 34, 141, 30, 158, 
         211, 33, 121, 116, 84, 15, 199, 232, 57, 73, 23, 175, 43, 13, 81, 71, 92, 33, 76, 255, 243],
         "Id": "e459533d-75db-e911-a946-00155d290a08",
         "PageCount": 1,
         "Size": 166054 }]
        }],
     "HasOverlay": false,
     "Id": "7d58533d-75db-e911-a946-00155d290a08",
     "ImportTemplateId": "54bdac99-17d0-e911-a93a-00155d290a08",
     "InfoStoreId": "3bb6448c-b9cf-e911-a939-00155d290a08",
     "LifeCycleManager": {
       "CheckOutLifeCycleStateId": null,
       "LifeCycleEndDate": null,
       "LifeCycleId": null,
       "LifeCycleProtections": null,
       "LifeCycleStartDate": null,
       "LifeCycleStateId": null,
       "NextAutomaticLifeCycleStateId": null,
       "NextLifeCycleStates": [] },
     "MainFileLength": 166054,
     "Name": "TestDocu.pdf",
     "PageCount": 1,
     "Properties": [{
       "PropertyTypeId": "f972ea44-17d0-e911-a93a-00155d290a08",
       "Values": ["TestDocu"] }, {
       "PropertyTypeId": "b398b135-17d0-e911-a93a-00155d290a08",
       "Values": ["7858"] }, {
       "PropertyTypeId": "0086153f-c1cf-e911-a939-00155d290a08",
       "Values": [] }, {
       "PropertyTypeId": "b76783b1-c1cf-e911-a939-00155d290a08",
       "Values": ["Gelmas Stoff", "spätestens bis 2020 einzahlen"] }, {
       "PropertyTypeId": "69a14957-17d0-e911-a93a-00155d290a08",
       "Values": ["Test"] }],
     "ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
     "Reminders": [],
     "SigningProfileId": null,
     "VersionId": "7d58533d-75db-e911-a946-00155d290a08"
     }, {
     "Abonnements": [],
     "AccessRightsEnumList": ["CheckOut", "Delete", "DeleteVersion", "EditAnnotation", "EditContent",
     "EditProperties", "GrantAccessToOtherUsers", "Move", "SetSecurity", "OverwriteVersion", "ViewVersionLog", 
     "ViewChangeLog", "ViewAccessLog", "EditMultiple", "ChangeRequiredList", "CreateBlog", "DeleteBlog", "EditBlog", 
     "ViewBlog", "RemoveDocumentContent", "ExecuteApplication", "Export", "SendAsFax", "Print", "Send", "View"],
     "AnnotationManager": {
       "PostItAnnotations": [],
       "RectangleAnnotations": [],
       "StampAnnotations": [],
      "TextAnnotations": [] },
     "Blogs": [],
     "CheckOutStateEnum": "NotCheckedOut",
     "CheckOutUserId": "00000000-0000-0000-0000-000000000000",
     "DocumentData": [{
       "Id": "09c21001-18d0-e911-a93a-00155d290a08",
       "Name": "TestDocu.pdf",
       "Renditions": [{
         "ContentProtections": [],
         "Extension": "pdf",
         "Files": [{
           "BlobPath": "2019\\09\\05\\001\\000\\000TestDocu.pdf",
           "BlobStoreId": "b5959c11-e5d9-4d11-a03c-c9fcccdfdb5b" }],
        "HashValue": [149, 113, 75, 201, 8, 70, 130, 160, 72, 231, 51, 7, 236, 121, 126, 2, 151,
        93, 169, 82, 79, 183, 57, 87, 7, 63, 203, 177, 220, 
        13, 254, 221, 80, 64, 184, 35, 185, 54, 121, 97, 32, 157, 59, 235, 236, 206, 156, 220, 203,
        244, 136, 48, 76, 5, 15, 47, 34, 76, 250, 179, 29, 83, 90, 19],
         "Id": "17c21001-18d0-e911-a93a-00155d290a08",
         "PageCount": 0,
         "Size": 3715356 }]
        }],
     "HasOverlay": false,
     "Id": "d2c01001-18d0-e911-a93a-00155d290a08",
     "ImportTemplateId": "e8ccb88b-17d0-e911-a93a-00155d290a08",
     "InfoStoreId": "5ff3c8f6-b8cf-e911-a939-00155d290a08",
     "LifeCycleManager": {
       "CheckOutLifeCycleStateId": null,
       "LifeCycleEndDate": "2019-09-06T06:11:39",
       "LifeCycleId": "f90cd545-6cd0-e911-a93a-00155d290a08",
       "LifeCycleProtections": {[
         "DeleteAfterExpiration": false,
         "Id": "8ebe4c2f-6cd0-e911-a93a-00155d290a08",
         "ProtectAnnotationChange": false,
         "ProtectCheckOut": false,
         "ProtectContentChange": true,
         "ProtectDelete": true,
         "ProtectPropertyChange": true,
         "ProtectProtectionDomainChange": true,
         "ProtectionDurationTicks": 3000000000 }],
       "LifeCycleStartDate": "2019-09-06T06:06:39",
       "LifeCycleStateId": "84be4c2f-6cd0-e911-a93a-00155d290a08",
       "NextAutomaticLifeCycleStateId": null,
       "NextLifeCycleStates": ["17f340f4-6bd0-e911-a93a-00155d290a08"] },
     "MainFileLength": 3715356,
     "Name": "TestDocu.pdf",
     "PageCount": 0,
     "Properties": [{
       "PropertyTypeId": "760fa49a-c1cf-e911-a939-00155d290a08",
       "Values": ["TestDocu"] }, {
       "PropertyTypeId": "3ecaf07d-c1cf-e911-a939-00155d290a08",
       "Values": ["12564"] }, {
       "PropertyTypeId": "0086153f-c1cf-e911-a939-00155d290a08",
       "Values": ["996.69"] }, {
      "PropertyTypeId": "b76783b1-c1cf-e911-a939-00155d290a08",
      "Values": [] }],
     "ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
     "Reminders": [],
     "SigningProfileId": null,
     "VersionId": "d2c01001-18d0-e911-a93a-00155d290a08" }]
}

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)