Share via

3.1.5.3.31 remove documents

  • Article

The remove documents request is used by the client to delete specific documents or folders from the site.

Parameters

service_name: This parameter is deprecated. For semantics, see service_name in section 3.1.5.3.1.

url_list: A VECTOR-URL-STRING (section 2.2.2.2.3) list of service-relative URLs that the client wants to be deleted. The server SHOULD delete the URLs listed here, subject to authorization checks.

time_tokens: If present and nonempty, this VECTOR-TIME (section 2.2.2.2.1) argument lists the vti_timelastmodified (section 2.2.2.3.82) metakey values as known on the client for the corresponding documents in the url_list argument. If the VECTOR-TIME is empty or the parameter is not present, the server MUST ignore this parameter; otherwise, it MAY refuse to delete documents in which the time stamp does not match the actual vti_timelastmodified value as known on the server <46>.

validateWelcomeNames: For semantics, see validateWelcomeNames in section 3.1.5.3.1.

Entry Point

FPAuthorScriptUrl

Return Values

message: For semantics, see message in section 3.1.5.3.1.

failed_dirs: A VECTOR-URL-DIRECTORY (section 2.2.2.2.16) that specifies the name and metadata for the folders that failed to be removed. The server MUST respond with a (potentially empty) list of folders that could not be removed.

failed_docs: A VECTOR-DOCINFO (section 2.2.2.2.12) that specifies the name and metadata for the documents that failed to be removed. The server MUST respond with a (potentially empty) list of documents that could not be removed. The server SHOULD send empty METADICTs (section 2.2.2.2.11) in this return value.

removed_dirs: A VECTOR-URL-DIRECTORY that contains the name and metadata for the folders that were removed. The server SHOULD send empty METADICTs in this return value.<47>

removed_docs: A VECTOR-DOCINFO that contains the name and metadata for the documents that were removed. The server SHOULD send empty METADICTs in this value <48>.