| GET | /Debtors/{DebtorID}/Documents/{DocumentID} | Retrieves a debtor document. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DebtorID | path | string | No | |
| DocumentID | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentID | form | string | No | |
| DocumentType | form | DocumentType | No | |
| FileID | form | string | No | |
| PhysicalFileName | form | string | No | |
| FullPhysicalFileName | form | string | No | |
| Description | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| LastModifiedByStaffID | form | string | No | |
| LastModifiedByStaffUsername | form | string | No | |
| LastModifiedByStaffTitle | form | string | No | |
| LastModifiedByStaffFirstName | form | string | No | |
| LastModifiedByStaffSurname | form | string | No | |
| FileBinary | form | byte[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentTypeID | form | string | No | |
| Description | form | string | No | |
| DefaultType | form | bool? | No | |
| ItemNo | form | int? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Debtors/{DebtorID}/Documents/{DocumentID} HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"DocumentID":"String","DocumentType":{"DocumentTypeID":"String","Description":"String","DefaultType":false,"ItemNo":0},"FileID":"String","PhysicalFileName":"String","FullPhysicalFileName":"String","Description":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastModifiedByStaffID":"String","LastModifiedByStaffUsername":"String","LastModifiedByStaffTitle":"String","LastModifiedByStaffFirstName":"String","LastModifiedByStaffSurname":"String","FileBinary":"AA=="}