3.1.5.3.2 checkout document
The checkout document request is used by the client to enable the currently authenticated user to make changes to a document under source control.
Tokens
service_name: This parameter is deprecated; see service_name in section 3.1.5.3.1.
document_name: The client MUST send and the server MUST interpret this URL-STRING as the service-relative path of the document to check out.
force: This parameter is an INT bitmask; bits 0 and 1 are defined as follows. The client MUST set all unused bits to zero; the server MUST ignore unused bits.
|
Mask |
Meaning |
|---|---|
|
Bit 0 0x00000001 |
Force checkout. This feature is currently unimplemented and reserved for future use. Clients MUST NOT set this bit, and servers MUST ignore it. |
|
Bit 1 0x00000002 |
Refresh short-term checkout. The client MUST set this bit if, and only if, it already has a short-term checkout on the file and wants to extend the time-out on it. The server MUST attempt to create a new short-term checkout if this bit is not set, and it MUST attempt to extend an existing short-term checkout if this bit is set. It SHOULD return an error (0x0009000E) if this bit is not set and a short-term checkout exists.<32> |
The client MUST set all unused bits to zero, and the server MUST ignore all unused bits. Range: -2147483648 to 2147483647; only 0 and 2 are currently allowed.
timeout: An INT that defines the number of minutes that a short-term checkout is requested. To retain the lock, the client MUST renew its short-term checkout within this interval. The client MUST NOT send negative values, and the server SHOULD ignore them by not specifying a timeout for the short-term checkout. 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 time for the short-term checkout. Range: 1 to 2147483647.<33>
validateWelcomeNames: For semantics, see section 3.1.5.3.1.
URL
FPAuthorScriptUrl
Return Values
The server can return the error codes 0x0009000E and 0x0009003E 2.2.2.2.17.1.
meta_info: A METADICT containing information about the document that has been checked out.