POST api/AddNote
Adds a note to the specified customer, boat or berth
Request Information
URI Parameters
None.
Body Parameters
AddNoteBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| customerCode |
Customer code to add note for |
string |
None. |
| boatNo |
ID of boat to add note for |
integer |
None. |
| berthNo |
Berth number to add note for |
string |
None. |
| marinaCode |
Marina code to add note to |
string |
None. |
| userNo |
ID of user adding the note |
integer |
None. |
| Note |
Note to add |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"customerCode": "",
"boatNo": 1234,
"berthNo": "",
"marinaCode": "HM",
"userNo": 1,
"Note": "Test note from HavenStar Web API"
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="customerCode" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="boatNo" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="berthNo" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="marinaCode" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="userNo" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Note" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
AddNoteResultBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| noteId |
ID of new note added |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"noteId": 1
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="noteId" 1 --MultipartDataMediaFormatterBoundary1q2w3e--