POST api/Documents/{id}/CheckOut

Checks a document out of the library so that other users cannot modify it.

Request

Parameters

Name Description Default
id Document number (unique ID).

Response

Body

Content Type: application/xml or application/json
Empty response if successful or an error message.

XML JSON 
<Response>                     
  <Message>string</Message>    <!--Error message--> 
</Response>                    
{                        
   "Message": "string"   // Error message
}

Status Codes

Code Condition
204 No ContentThe operation completed successfully.
400 Bad RequestInvalid document number.
401 Unauthorized Access token is invalid, expired or not specified.
403 ForbiddenUser does not have permission to check out the document.
404 Not FoundDocument not found.
406 Not Acceptable Content type specified in the Accept header isn't supported.
409 ConflictDocument could not be checked out.
500 Internal Server Error An internal error occurred.

Remarks

If a document cannot be checked out, it may already be checked out or locked for editing by another user.