POST api/fileHandler/RetrieveCustomerDocument
Please note... file download via website not currently implemented - please use postman for testing this call
Request Information
URI Parameters
None.
Body Parameters
RetrieveCustomerDocumentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| DocId |
Unique ID of document record |
integer |
None. |
| AccountCode |
Either account code or boatno can be specified |
string |
None. |
| boatno |
Either account code or boatno can be specified |
integer |
None. |
| DocumentRecordType |
Contract document type |
integer |
None. |
| RecordID |
Document valid from date |
string |
None. |
| FileName |
Name and path of file |
string |
None. |
| FTPLocation |
Name and path of FTP location |
string |
None. |
| DocDate |
Date/time document created |
date |
None. |
Request Formats
application/json, text/json
Sample:
{
"docId": 1,
"accountCode": "sample string 2",
"boatno": 3,
"documentRecordType": 4,
"recordID": "sample string 5",
"fileName": "sample string 6",
"ftpLocation": "sample string 7",
"docDate": "2026-03-30T05:20:38.6006657+01:00"
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="DocId" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="AccountCode" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="boatno" 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="DocumentRecordType" 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="RecordID" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="FileName" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="FTPLocation" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="DocDate" 2026-03-30T05:20:38.6006657+01:00 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |