3.1.5.3.16 getDocsMetaInfo

The getDocsMetaInfo request is used by the client to retrieve metadata for the documents and folders in the current site. The getDocsMetaInfo request is similar in function to the list documents (section 3.1.5.3.20) request except that it only retrieves metadata for the documents or folders specified through the url_list parameter.

Parameters

service_name: This parameter is deprecated. See service_name in section 3.1.5.3.1.

listHiddenDocs: A BOOLEAN (section 2.2.2.1.3) value that specifies whether the client requests hidden documents in a site included in the documents to be listed. If TRUE, the server SHOULD list hidden documents; if FALSE, the server MAY leave hidden documents out of the list returned. The server SHOULD default this value to TRUE if it is not sent by the client.

listLinkInfo: For semantics, see listLinkInfo in section 3.1.5.3.1. The server MUST default this value to TRUE if it is not sent by the client.

url_list: A VECTOR-STRING (section 2.2.2.2.1) list of service-relative URLs for which the client requires information. If url_list is not sent or empty, it MUST be treated as though it is a request for the root of the site.

validateWelcomeNames: For semantics, see validateWelcomeNames in section 3.1.5.3.1.

Entry Point

FPAuthorScriptUrl

Return Values

document_list: A DOCUMENT-LIST-RETURN-TYPE (section 2.2.2.2.13) that specifies the name and metadata for the set of documents requested in the url_list parameter.

urldirs: A VECTOR-URL-DIRECTORY (section 2.2.2.2.16) that contains names and metadata for the folders and subsites in the current site requested in the url_list parameter. The server MUST return urldirs if url_List contains at least a folder.

failedUrls: A VECTOR-URL-STRING (section 2.2.2.2.3) list of service-relative URLs specifying which of the entries in the url_list parameter of the request failed to have the corresponding METADICT (section 2.2.2.2.11) applied.