POST api/ServicePoints/BerthServicePoints
Lists service points linked to supplied berth number
Request Information
URI Parameters
None.
Body Parameters
BerthBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| berthNo |
As name suggests |
string |
None. |
| marinaCode |
As name suggests |
string |
None. |
| length |
As name suggests |
decimal number |
None. |
| width |
As name suggests |
decimal number |
None. |
| depth |
As name suggests |
decimal number |
None. |
| occupied |
Indicates if the berth is currently occupied or not |
boolean |
None. |
| occupiedStatus |
Indicates the status of the boat occupying the berth - Visitor or Contract Holder |
string |
None. |
| boatNo |
ID of the boat on the berth, if occupied |
integer |
None. |
| departureDueDate |
Date boat due to leave the berth if occupied |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"berthNo": "sample string 1",
"marinaCode": "sample string 2",
"length": 3.0,
"width": 4.0,
"depth": 5.0,
"occupied": true,
"occupiedStatus": "sample string 7",
"boatNo": 1,
"departureDueDate": "sample string 8"
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="berthNo" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="marinaCode" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="length" 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="width" 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="depth" 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="occupied" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="occupiedStatus" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="boatNo" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="departureDueDate" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
ServicePointListModel| Name | Description | Type | Additional information |
|---|---|---|---|
| servicePointDetails |
List of service point records |
Collection of ServicePointDetailModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"servicePointDetails": [
{
"servicePointCode": "sample string 1",
"boatNo": 2,
"boatName": "sample string 3",
"berthNo": "sample string 4",
"custCode": "sample string 5",
"custName": "sample string 6",
"lastReading": 7.0,
"currentReading": 8.0,
"walkOrder": 9
},
{
"servicePointCode": "sample string 1",
"boatNo": 2,
"boatName": "sample string 3",
"berthNo": "sample string 4",
"custCode": "sample string 5",
"custName": "sample string 6",
"lastReading": 7.0,
"currentReading": 8.0,
"walkOrder": 9
}
]
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[0].servicePointCode" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[0].boatNo" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[0].boatName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[0].berthNo" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[0].custCode" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[0].custName" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[0].lastReading" 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[0].currentReading" 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[0].walkOrder" 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[1].servicePointCode" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[1].boatNo" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[1].boatName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[1].berthNo" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[1].custCode" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[1].custName" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[1].lastReading" 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[1].currentReading" 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="servicePointDetails[1].walkOrder" 9 --MultipartDataMediaFormatterBoundary1q2w3e--