POST api/customer/CustomerContracts
Returns Customer Contracts
Request Information
URI Parameters
None.
Body Parameters
identifyCustomerModel| Name | Description | Type | Additional information |
|---|---|---|---|
| AccountCode |
Either account code or boatno can be specified |
string |
None. |
| boatno |
Either account code or boatno can be specified |
integer |
None. |
| resultCount |
Number of results to return for associated call, optional parameter, 0 for all results |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"accountCode": "sample string 1",
"boatno": 2,
"resultCount": 3
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="AccountCode" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="boatno" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="resultCount" 3 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
CustomerContractListModel| Name | Description | Type | Additional information |
|---|---|---|---|
| contracts |
As name suggests |
Collection of CustomerContractModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"contracts": [
{
"boatNo": 1,
"renewal": true,
"isNew": true,
"contractID": 4,
"startDate": "sample string 5",
"endDate": "sample string 6",
"value": 7.0,
"contractGroupId": 8,
"contractGroupDescription": "sample string 9",
"confirmed": true
},
{
"boatNo": 1,
"renewal": true,
"isNew": true,
"contractID": 4,
"startDate": "sample string 5",
"endDate": "sample string 6",
"value": 7.0,
"contractGroupId": 8,
"contractGroupDescription": "sample string 9",
"confirmed": true
}
]
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[0].boatNo" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[0].renewal" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[0].isNew" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[0].ContractID" 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[0].startDate" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[0].endDate" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[0].Value" 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[0].contractGroupId" 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[0].contractGroupDescription" sample string 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[0].confirmed" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[1].boatNo" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[1].renewal" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[1].isNew" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[1].ContractID" 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[1].startDate" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[1].endDate" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[1].Value" 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[1].contractGroupId" 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[1].contractGroupDescription" sample string 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="contracts[1].confirmed" True --MultipartDataMediaFormatterBoundary1q2w3e--