List Documents (Trust)
GET {{baseUrl}}/cas/trusts/:trustId/documents?offset={{offset}}&limit={{limit}}&updatedAfter={{updatedAfter}}
Return a list of documents for a Trust. Document IDs returned can be used for subsequent calls.
Query Parameters
| Form Parameter | type | Mandatory | Description |
|---|---|---|---|
| offset | number | Required | Example = 0 |
| limit | number | Required | Example = 500 |
| updatedAfter | Optional | UTC date in ISO format: yyyy-MM-dd’T’HH:mm:ss. Example: 2000-10-31T01:30:00Z or 2000-10-31T01:30:00 |
updatedAfter parameter - using this new parameter, the documents list will return just the documents that were updated after the date and time specified. The date must be a UTC date in ISO format: yyyy-MM-dd’T’HH:mm:ss. Example: 2000-10-31T01:30:00Z or 2000-10-31T01:30:00
Response Body
Returns a list of objects as described below
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| id | Number | Yes | |
| traceNumber | Number | Yes | |
| name | String | Yes | |
| documentDate | String | Yes | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
| asicDocNumber | String | No | |
| lastUpdatedTimestamp | Date | Yes | Date and time document was updated |
status objects
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| id | Number | Yes | |
| createdBy | String | Yes | The name of user who created the document |
| type | String | Yes | Descriptive name of Status |
| typeId | Number | Yes | Status Unique Identifier |
| effectiveDate | String | Yes | Format will be ISO 8601 date. Equal to status change date |
Additional keys
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| offset | Number | Yes | |
| limit | Number | Yes | |
| total | Number | Yes |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
offset | string | number | |
limit | string | number | |
updatedAfter | string | ||
| `` | null |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"documents":[{"documentDate":"2020-07-03","id":1075468,"lastUpdatedTimestamp":"2020-07-03T04:31:46.108264","name":"Trustee Minutes or Resolutions","status":{"createdBy":"Jeevan Tokhi","effectiveDate":"2020-07-03","id":969219,"type":"DOCUMENT PREPARED","typeId":2},"traceNumber":"103"}],"limit":500,"offset":0,"total":1}