POST api/customer/VisitingBoatDetails
Returns details of the visiting boat
Request Information
URI Parameters
None.
Body Parameters
AccountCodeBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| accountCode |
Fixed length account code |
string |
Required Max length: 10 |
| marinaCode |
Optional marina code |
string |
Max length: 10 |
| boatNo |
Optional boat number |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"accountCode": "HSMM1113",
"marinaCode": null,
"boatNo": null
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="accountCode" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="marinaCode" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="boatNo" 1 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
VisitingBoatModel| Name | Description | Type | Additional information |
|---|---|---|---|
| AccountCode |
Customer account code |
string |
None. |
| BoatName |
Name of boat |
string |
None. |
| BerthNo |
Berth booked or berth boat currently in |
string |
None. |
| BerthPortOrStarboard |
Is the berth port or starboard |
string |
None. |
| WarningMessage |
Warning message for the boat |
string |
None. |
| CustomerName |
Name of customer |
string |
None. |
| MeterMACSPIN |
Meter-MACS PIN |
string |
None. |
| BoatLOA |
Length of boat |
decimal number |
None. |
| EmailAddress |
Customer's email address |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"accountCode": "sample string 1",
"boatName": "sample string 2",
"berthNo": "sample string 3",
"berthPortOrStarboard": "sample string 4",
"warningMessage": "sample string 5",
"customerName": "sample string 6",
"meterMACSPIN": "sample string 7",
"boatLOA": 8.0,
"emailAddress": "sample string 9"
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="AccountCode" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="BoatName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="BerthNo" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="BerthPortOrStarboard" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="WarningMessage" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CustomerName" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MeterMACSPIN" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="BoatLOA" 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="EmailAddress" sample string 9 --MultipartDataMediaFormatterBoundary1q2w3e--