Method GetRemoteFolder

GetRemoteFolder(String, String, List<String>, RemoteFolderOptionsContract)

Get remote folder for path

Declaration

RemoteFolderContract GetRemoteFolder(string connectionId, string remoteFolderPath, List<string> documentProperties, RemoteFolderOptionsContract options)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
System.String	remoteFolderPath	Folder path to retrieve. See also Path
System.Collections.Generic.List<System.String>	documentProperties	Ids of the properties which are returned in the Properties[] array of the document
RemoteFolderOptionsContract	options	Optional: Remote folder options. Default value for RetrieveDocuments is true. See also RemoteFolderOptionsContract

Returns

Type	Description
RemoteFolderContract	Folder

Examples

POST http://YourServerName/InfoShare/Json/RemoteFolder/GetRemoteFolder

Example for get remote folder.

{
   "connectionId": "e3b3b164-9b0b-4d00-9981-83fe4835df1a",
   "remoteFolderPath": "1eb9edb4-2ce0-e911-a94a-00155d290a08",
   "documentProperties": null,
   "options": {
     "RetrieveDocuments": false,
     "RetrieveColumnConfiguration": false,
     "RetrieveFolderProperties": false }
}

Response:

{
   "GetRemoteFolderResult": {
     "AccessRightsEnum": ["SetMasterColumnConfiguration"],
     "ColumnConfiguration": {
       "Columns": [{
         "PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
         "Width": -2 }],
       "GroupedColumnIds": [],
       "InheritProperties": true,
       "ShowAggregateFunctions": false,
       "ShowColumnFilters": false,
       "ShowGroupsExpanded": false,
       "SortedColumns": [] },
     "Documents": [],
     "Id": "1eb9edb4-2ce0-e911-a94a-00155d290a08",
     "ImportTemplateId": "e8ccb88b-17d0-e911-a93a-00155d290a08",
     "Name": "WebDavShare",
     "Path": "1eb9edb4-2ce0-e911-a94a-00155d290a08",
     "Properties": [],
     "ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
     "SubFolders": [] }
}

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	Root folder not found (10023)
ServiceException	Folder not found {folderPath} (10025)
ServiceException	Property type not found {propertyTypeId} (10034)
ServiceException	Unknown data type for property type (10035)
ServiceException	Verification code is needed: Verification code not yet verified (10152)