Documentation Center

DocumentObj 2.5 FolderLocations

This method retrieves the BaseFolders and the folder paths of multiple logical objects in Content Manager. This can be used to show the folder paths in Inbox and Search screens.


Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services making this parameter redundant.
pasLogicalIdsStringArrayInString array with the logical identifiers of the objects
psOutXMLObjLocationListStringOutObjectLocationList XML structure containing the folder paths of the objects.

Note that:
  • Only content folders are returned. Shortcut or Query Folders that contain the object are never returned.
  • The basefolder returned in peOutBaseFolder is always one of the root folders. So for an editor template, the peBaseFolder will contain the value System and pasOutFolderPath will contain an entry for Editor template, if located within System.
  • When a logical object is not found for a given logical identifier (either because it does not exist or the user does not have read access to the object), no error is given and no ishobject is returned for that logical identifier.
  • The order of the returned objects in psOutXMLObjLocationList is random.
  • All logical identifiers within Content Manager are in uppercase.
  • For publications use the dedicated API function PublicationOutput25.FolderLocations.