DESCRIPTION
This endpoint checks out the document with the ID specified.
URL STRUCTURE
https://[hostname]/document/check-out/{documentId:[0-9]+}METHOD
GET
HEADERS
**Authorization:** string Base64 [email]:[key]
ARGUMENTS
| Name | Type | Description |
|---|---|---|
| documentId | int | Document ID to be checked |
RETURNS
Returns the new document checked-out
{
"id": "281",
"matterId": "307",
"title": "Content Notes Special Characters",
"filename": "Content Notes Special Characters.docx",
"date": "2019-11-12 00:00:00",
"fileSize": "14373",
"setupBy": null,
"setupDate": null,
"fileContent": null,
"incomingDocId": null,
"publishedStatus": {
"id": "2"
},
"primaryClassification": {
"id": "0",
"name": "",
"documentNameString": null,
"outgoing": null,
"incoming": null
},
"secondaryClassification": {
"id": "0",
"primaryClassificationId": null,
"name": null,
"country": null,
"category": null,
"subCategory": null,
"doubleCheckRequired": null,
"showInClientPortal": null,
"documentNameString": null,
"primaryClassification": null,
"incoming": null,
"outgoing": null,
"epoImportString": null
},
"status": "C",
"instanceId": "0",
"lockedFromClientAccess": "1",
"notes": "",
"templateId": "83",
"attentionOf": "0",
"usersForInformation": null,
"entity": null,
"entityType": "document",
"titleAddendum": "",
"oldId": "0",
"renewalBatchNumber": "0",
"sender": "jea",
"recipient": "",
"folder": "0",
"filingStatus": "0",
"modifiedDate": "2019-12-10 13:49:34",
"modifiedUserId": null,
"modifiedUser": null,
"createDate": null,
"createUserId": null,
"createUser": null,
"customFields": [
{
"id": "1",
"name": "I'm hungry",
"type": "date",
"value": "",
"entityType": "document",
"required": "0",
"possibleValues": []
}
],
"isCheckedOut": true
}