3.1.5.3.6 get document

The get document request can be used by the client to retrieve a document and its metadata for viewing or editing on a client.

Tokens

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

document_name: A URL-STRING that the client MUST send, and the server MUST interpret this value as the service-relative path of the document to retrieve. The client MUST send this parameter.

effective_protocol_version: A VERSION (section 2.2.2.2.9) provides a way for the client to supersede the version sent as the PROTOCOL-VERSION-STRING in the METHOD-KEY-VALUE of the request. For details, see section 2.2.2.2.6. A client conforming to the FrontPage Server Extensions Remote Protocol MUST NOT send this parameter. A server SHOULD ignore this parameter.

old_theme_html: A BOOLEAN value that determines how theme elements are rendered on a page. If TRUE, the page is returned using HTML that is compatible with effective_protocol_version. If FALSE, the effective_protocol_version corresponds to Microsoft FrontPage 97 or an earlier version of FrontPage that does not support themes. In this case, the theme information disappears, and the theme elements are rendered in the HTML used on the page. A client conforming to the FrontPage Server Extensions Remote Protocol MUST send FALSE (either by omitting the parameter and taking the default or by explicitly sending FALSE). A server MAY assume this parameter to be FALSE.

expandWebPartPages: A BOOLEAN value reserved for future use. This parameter MUST be ignored by the server regardless of a TRUE or FALSE value. The client MUST send false for this parameter, either explicitly or by omitting the parameter.

force: A BOOLEAN value reserved for future use. This parameter MUST be ignored by the server, regardless of a TRUE or FALSE value. The client MUST send FALSE for this parameter, either explicitly or by omitting the parameter.

doc_version: A STRING containing the source control version number of the document being retrieved. An empty string (the default value) is a request for the current version of the document. A client conforming to the FrontPage Server Extensions Remote Protocol MUST omit this parameter or explicitly send the empty string. A server MAY ignore this parameter and always send the most recent version of the document.

get_option: A STRING value that determines how documents are checked out of source control. Passing any string not listed in the following table is considered the same as "none".

Value	Meaning
none	Do not check out the file.
chkoutExclusive	Check out the file exclusively.
chkoutNonExclusive	Check out the file nonexclusively, if the source control system is configured to allow nonexclusive checkouts. If it is not, the server SHOULD treat this as chkoutExclusive instead.<36>

The checkout MUST logically occur before the server begins sending the document to the client. If the checkout cannot occur, the server MUST return an error message with a Status set to one of the error values listed in section 2.2.2.2.17.1 and not return the document.

timeout: An UNSIGNED-INT that specifies the number of minutes the server MUST retain the short-term checkout. To retain the lock longer, the client MUST renew its short-term checkout within this interval. For details, see checkout document, section 3.1.5.3.2. The client MUST NOT send negative values, and the server SHOULD ignore them by not specifying a timeout. The value zero is reserved for server implementations that understand long-term checkout and thus MUST NOT be sent by clients. Servers MAY ignore requests in which this parameter is set to zero by not specifying a timeout. Range from 1 through 4294967296.<37>

validateWelcomeNames: For semantics, see section 3.1.5.3.1.

URL

FPAuthorScriptUrl

Return Values

The server can return the error code 0x0009003E 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: The DOCINFO that contains the document name and metadata for the document that has been retrieved.