Share via

3.1.4.8 CheckOutFile

  • Article

The CheckOutFile operation<42> is used to check out a document in a document library.

 <wsdl:operation name="CheckOutFile">
     <wsdl:input message="CheckOutFileSoapIn" />
     <wsdl:output message="CheckOutFileSoapOut" />
 </wsdl:operation>

The protocol client sends a CheckOutFileSoapIn request message (section 3.1.4.8.1.1) and the protocol server responds with a CheckOutFileSoapOut response message (section 3.1.4.8.1.2), as follows:

  1. If the pageUrl is null or an empty string, the protocol server MUST return a SOAP fault with error code 0x82000001. This indicates that the pageUrl is an empty string.

  2. If the pageUrl is an invalid URL, the protocol server SHOULD<43> return a SOAP fault with error string "Invalid URI: The format of the URI could not be determined.". There is no error code for this fault.

  3. If the pageUrl does not refer to a document, the protocol server MUST return a SOAP fault. There is no error code for this fault.

  4. If the checkoutToLocal parameter does not resolve to a valid Boolean string (case-insensitive equality to "True" or "False", ignoring leading and trailing white space), the protocol server MUST return a SOAP fault. There is no error code for this fault.

  5. If there are no other errors, the document located at pageUrl MUST be checked out by using checkoutToLocal and lastmodified elements, as specified in the CheckOutFileSoapIn request message.