GET api/Documents/{id}/CheckoutStatus

Retrieves the checkout status of a document.

Request

Parameters

Name Description Default
id Document number (unique ID).

Response

Body

Content Type: application/xml or application/json
Checkout status or an error message.

XML JSON 
<Response>                         
  <Result>                         
    <Status>string</Status>        <!--'NotCheckedOut', 'CheckedOut', 'ReadOnly' or 'Unknown'--> 
    <Member>                       
      <ID>long</ID>                
      <Code>string</Code>          
      <Contact>                    
        <ID>long</ID>              
        <FileAs>string</FileAs>    
      </Contact>                   
    </Member>                      
  </Result>                        
  <Message>string</Message>        <!--Error message--> 
</Response>                        
{                                
   "Result": {                   
      "Status": "string",        // 'NotCheckedOut', 'CheckedOut', 'ReadOnly' or 'Unknown'
      "Member": {                
         "ID": "long",           
         "Code": "string",       
         "Contact": {            
            "ID": "long",        
            "FileAs": "string"   
         }                       
      }                          
   },                            
   "Message": "string"           // Error message
}

Status Codes

Code Condition
200 OK The 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 query the status of the document.
404 Not FoundDocument not found.
406 Not Acceptable Content type specified in the Accept header isn't supported.
409 ConflictCheckout status could not be determined.
500 Internal Server Error An internal error occurred.

Remarks

If checkout status cannot be determined, the document may not exist in the library.

A status of ReadOnly indicates that the document is locked for editing by another user. This typically occurs when an application has not released the handle to the file.