3.1.5.3.11 put document

  • Article

The put document request is used by the client to write a single file to a directory in an existing site.

Tokens

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

document: A DOCINFO specifying the name and metadata of the file to write to the directory. The client MUST send this parameter.

put_option: A set of flags describing how the operation behaves; see Put-Option (section 2.2.2.2.18) for specific semantics for the options.

comment: A STRING that provides a check-in comment for the file being uploaded. The server MUST ignore this parameter unless the "checkin" PUT-OPTION-VAL is specified in the put_option parameter. Because clients conforming to the FrontPage Server Extensions Remote Protocol MUST NOT send the "checkin" PUT-OPTION-VAL, as specified in Put-Option, servers MAY ignore this parameter.

keep_checked_out: A BOOLEAN value used to determine a specified document's behavior in source control. If TRUE, the document SHOULD be checked in to source control and immediately checked back out; if FALSE, the document SHOULD be checked in. The server MUST treat this as equivalent to the "checkout" PUT-OPTION-VAL, as specified in Put-Option. Clients conforming to the FrontPage Server Extensions Remote Protocol MUST send FALSE, either explicitly or by omitting this parameter.

validateWelcomeNames: For semantics, see section 3.1.5.3.1.

URL

FPAuthorScriptUrl

Return Values

The server can return the error codes 0x00090002, 0x0009000E, and 0x0009000F 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.

document: A DOCINFO containing the name and metadata of the document as it was saved. Note that even though the return value is called "document", it does not contain the document stream. The server MAY update the metadata when the document is saved. The server MUST return the updated metadata in the document return value.

Note The document contents MUST be sent right after the parameters in the client request. Because arguments always end with an LF in URL Mode, there is no need for further delimiters. The document stream cannot be encoded in any way, as whatever is sent over the wire will be directly stored as the file contents, without further translation.