POST api/bookings/BerthsAvailable
Returns berth availability matching specified parameters
Request Information
URI Parameters
None.
Body Parameters
BerthsAvailableRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| MarinaCode |
Marina code to check availability for |
string |
None. |
| BoatNo |
Either BoatNo or Length can be specified |
integer |
None. |
| Length |
Either BoatNo or Length can be specified |
decimal number |
None. |
| Width |
If Length is specified then Width can also be specified if desired |
decimal number |
None. |
| Depth |
If Length is specified then Depth can also be specified if desired |
decimal number |
None. |
| StartDate |
Preferred start date |
date |
None. |
| EndDate |
Preferred end date |
date |
None. |
| OnlineOnly |
Only find berths available for online bookings |
boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"marinaCode": "sample string 1",
"boatNo": 1,
"length": 1.1,
"width": 1.1,
"depth": 1.1,
"startDate": "2026-03-30T15:10:20.0168389+01:00",
"endDate": "2026-03-30T15:10:20.0168389+01:00",
"onlineOnly": true
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MarinaCode" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="BoatNo" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Length" 1.1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Width" 1.1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Depth" 1.1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="StartDate" 2026-03-30T15:10:20.0168389+01:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="EndDate" 2026-03-30T15:10:20.0168389+01:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="OnlineOnly" True --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
BerthsAvailableListModel| Name | Description | Type | Additional information |
|---|---|---|---|
| berthsAvailable |
List of berths available |
Collection of BerthAvailableModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"berthsAvailable": [
{
"berthNo": "sample string 1",
"berthLength": 2.0,
"berthWidth": 1.0,
"berthDepth": 1.0,
"availableFrom": "sample string 3",
"availableTo": "sample string 4"
},
{
"berthNo": "sample string 1",
"berthLength": 2.0,
"berthWidth": 1.0,
"berthDepth": 1.0,
"availableFrom": "sample string 3",
"availableTo": "sample string 4"
}
]
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="berthsAvailable[0].BerthNo" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="berthsAvailable[0].BerthLength" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="berthsAvailable[0].BerthWidth" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="berthsAvailable[0].BerthDepth" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="berthsAvailable[0].AvailableFrom" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="berthsAvailable[0].AvailableTo" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="berthsAvailable[1].BerthNo" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="berthsAvailable[1].BerthLength" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="berthsAvailable[1].BerthWidth" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="berthsAvailable[1].BerthDepth" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="berthsAvailable[1].AvailableFrom" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="berthsAvailable[1].AvailableTo" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e--