Share via

3.1.4.8.2.1 CheckOutFile

  • Article

The CheckOutFile element specifies details for the request to check out a document with the provided pageUrl, checkoutToLocal flag, and lastmodified date.

 <s:element name="CheckOutFile">
   <s:complexType>
     <s:sequence>
       <s:element minOccurs="0" maxOccurs="1" name="pageUrl" type="s:string" />
       <s:element minOccurs="0" maxOccurs="1" name="checkoutToLocal" type="s:string" />
       <s:element name="lastmodified" type="s:string" minOccurs="0"/>
     </s:sequence>
   </s:complexType>
 </s:element>

pageUrl: The URL of the document to check out.

checkoutToLocal: This element MUST be "true", if the caller wants to keep a local version for offline editing.

lastmodified: A string in date format [RFC1123] section 5.2.14 that represents the date and time of the last modification by the site (2) to the file; for example, "20 Jun 1982 12:00:00 GMT".<44> If a valid date is passed, it needs to be equal to the lastmodified time stamp on the document that is being checked out. If an invalid date format is passed, this parameter is ignored.