9201: Get documents
- Usman Tanveer
- Nick Jensen
Owned by Usman Tanveer
Retrieves documents for an account.
Endpoint ID: | 9201 | |||||
| Method: | GET | |||||
| URL: | /entity/id/{entityID}/documents /entity/ext-key/{externalRelationID}/{externalRelationType}/documents | |||||
entityID | Rubiq entity ID that uniquely identifies an account to return data for | |||||
externalRelationID | External key that uniquely identifies an account to return data for | |||||
externalRelationType | Type of external key | |||||
| Request body: | None | |||||
Response body: | JSON data with properties corresponding to the fields in the documents. Please note that fields with null value is not returned by this end point. Example Response [
{
"content": "base64 encoded text",
"compressed": false,
"createdBy": "mailbox@mailserver.com",
"createdDate": "01-01-2016T12:00:00",
"description": "Description of the document",
"documentID": 1,
"expiryDate": "31-12-2016T23:59:59",
"mimeType": "image",
"name": "Test Document",
"sizeCompressed": 500,
"sizeOriginal": 1500,
"updatedBy": "mailbox@mailserver.com",
"updatedDate": "01-03-2016T12:00:00"
}
]
| |||||
| Status codes: | 200 | Documents found with success | ||||
| 404 | Account was not found The following sub codes may be returned:
| |||||