list documents Method

Provides a list of the files, folders, and subsites complete with meta-information for each file contained in the initialUrl parameter of the specified Web site.

Syntax

method=list documents:server_extension_version
&service_name=/&listHiddenDocs=(true|false)&listExplorerDocs=(true|false)
[&platform=client_os]&initialURL=url&listRecurse=(true|false)
&listLinkInfo=(true|false)&listFolders=(true|false)&listFiles=(true|false)
&listIncludeParent=(true|false)&listDerived=(true|false)&listBorders=(true|false)
[&vaildateWelcomeNames=(true|false)][&folderList=list_of_urls_and_timestamps]
&listChildWebs=(true|false)

Parameters

service name

listHiddenDocs

listExplorerDocs

platform

initialURL

listRecurse

listLinkInfo

listFolders

listFiles

listIncludeParent

listDerived

listBorders

validateWelcomeNames

folderList

listChildWebs

Decoded

POST /site_url/_vti_bin/_vti_aut/author.dll HTTP/1.0
.
.
.
method=list+documents:6.0.n.nnnn
&service_name=/
&listHiddenDocs=false
&listExplorerDocs=false
&listRecurse=false
&listFiles=true
&listFolders=true
&listLinkInfo=true
&listIncludeParent=true
&listDerived=false
&listBorders=false
&listChildWebs=true
&initialUrl=url

Return Value

Success

See Sample Return Code.

Error

Returns an error message in standard format. For more information, see Error Message Format for FrontPage 2002 Server Extensions from Microsoft.

Sample Return Code