3.1.5.3.9 move document

  • Article

The move document request is used by the client to change the URL of a selected document or folder in the site. Note that moving a document will change its URL.

Tokens

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

oldUrl: A URL-STRING that specifies the original service-relative URL for a document or folder whose URL is to be changed. The client MUST send this parameter.

newUrl: A URL-STRING that specifies the new service-relative URL for a document or folder whose URL is to be changed. The client MUST send this parameter.

url_list: A VECTOR-URL-STRING list of service-relative URLs of documents whose links ought to be considered for link fixup purposes. This is a hint passed from the client to the server. Servers that implement link fixup SHOULD NOT rely on the client sending the correct list. Clients that conform to the FrontPage Server Extensions Remote Protocol MUST send an empty list (either explicitly or by omitting the parameter and taking the default). Servers MAY ignore this parameter.

rename_option: This tells the server to change certain behaviors during the rename or copy operation, as defined in Rename-Option<45> (section 2.2.2.2.19).

put_option: A set of flags describing how the operation ought to behave as detailed in Put-Option (section 2.2.2.2.18). In particular, the server MUST overwrite an existing file or folder if, and only if, the "overwrite" flag is added.<46>

docopy: A BOOLEAN value specifying whether the move document request copies or moves a file or folder to the destination. If TRUE, the file or folder SHOULD be copied; if FALSE, the file or folder SHOULD be moved. The default value is FALSE.

validateWelcomeNames: For semantics, see section 3.1.5.3.1.

URL

FPAuthorScriptUrl

Return Values

The server can return the error codes 0x00020019 and 0x00090002 2.2.2.2.17.1.

message: A STRING description of the action taken by the server. This is intended for debugging and SHOULD be ignored by the client.

oldUrl: A URL-STRING specifying the former URL for a document or folder whose name or directory has changed.

newUrl: A URL-STRING specifying the new URL for a document or folder whose name or directory has changed.

document_list: A DOCUMENT-LIST-RETURN-TYPE (section 2.2.2.2.13) specifying the set of documents whose metadata has changed as a byproduct of the move due to fixing links.

moved_docs: A DOCUMENT-LIST-RETURN-TYPE of URLs and metadata for moved or copied files. Clients MAY assume and servers MUST ensure that this return value is equivalent to the document_list return value of the list documents method (section 3.1.5.3.8) when newUrl is the URL of a folder, assuming that the following three parameter values were passed into list documents (section 3.1.5.3.8).

Parameter values passed into list document:

  • initialUrl: The value that the client passed to the newUrl parameter of the current call to move the documents.

  • listRecurse: TRUE.

  • includeParent: TRUE

moved_dirs: A VECTOR-URL-DIRECTORY of URLs and metadata for moved or copied folders. Clients MAY assume and servers MUST ensure that this return value is equivalent to the urldirs return value of the list documents method (section 3.1.5.3.8) when newUrl is the URL of a folder, assuming the following parameter values were passed into list documents (section 3.1.5.3.8).

Parameter values passed into list documents:

  • initialUrl: The value that the client passed to the newUrl parameter of the current call to move the documents.

  • listRecurse: TRUE.

  • includeParent: TRUE

As with the preceding moved_docs return value, the client SHOULD use this result to update any metadata cache it is maintaining.