Method GetZIPInfos

GetZIPInfos(String, String, String, String, String, String)

Get zip specific information

Declaration

ZipInfoContract GetZIPInfos(string connectionId, string documentId, string versionId, string documentDataId, string renditionId, string password)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
System.String	documentId	The document id. See also Id
System.String	versionId	Optional: The version id. See also GetVersionListItems(String, String, Int32, Int32)
System.String	documentDataId	Optional: The document data id. See also DocumentData
System.String	renditionId	Optional: The rendition id. See also DocumentData
System.String	password	The password.

Returns

Type	Description
ZipInfoContract	Zip information

Examples

POST https://YourServerName/InfoShare/Json/DocumentProcessing/GetZIPInfos

Example for retrieving zip information

{
    "connectionId": "0e2c3de4-5e90-43ed-9eec-3e1742dffacb",
    "documentId": "0fd43d97-928c-494e-96c0-d357f1f975af"
}

Response:

{
    "GetZIPInfosResult":
      {
        "AllItems":
          [{  
            "FileSize":0,
            "FullFolderName":"testZIP\/",
            "Id":"testZIP\/",
            "IsFolder":true,
            "Name":"" 
            },{
            "FileSize":11984,
            "FullFolderName":null,
            "Id":"testZIP\/Auftragsbest„tignung.tif",
            "IsFolder":false,
            "Name":"Auftragsbest„tignung.tif"
            },{
            "FileSize":2950,
            "FullFolderName":null,
            "Id":"testZIP\/Lieferschein S Gesell Grosskonzert.pdf",
            "IsFolder":false,"Name":"Lieferschein S Gesell Grosskonzert.pdf"
            },{
            "FileSize":0,
            "FullFolderName":"testZIP\/Neuer Ordner_Stufe1\/",
            "Id":"testZIP\/Neuer Ordner_Stufe1\/",
            "IsFolder":true,
            "Name":""
            },{ ..... 
           }],
         "FileSize":10225095}}
}

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	Document without file {documentId} (10004)
ServiceException	No document found for documentId {documentId} (10005)
ServiceException	Could not retrieve version {versionId} for document {documentId} (10130)
ServiceException	Verification code is needed: Verification code not yet verified (10152)
ServiceException	Password for ZIP file is wrong. (10273)