POST api/customer/CustomerBookings

Returns current / future customer bookings across all marinas

Request Information

URI Parameters

None.

Body Parameters

CustomerBookingsRequestModel
NameDescriptionTypeAdditional information
AccountCode

Either account code or boatno can be specified

string

None.

boatno

Either account code or boatno can be specified

integer

None.

includeCancelled

Optional parmater to indicate if cancelled bookings should be included - defaults to false

boolean

None.

showAll

Optional parmater to indicate if all bookings should be included or just bookings where the departure date is in the future - defaults to the latter

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "accountCode": "sample string 1",
  "boatno": 2,
  "includeCancelled": true,
  "showAll": true
}

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="includeCancelled"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="showAll"

True
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

CustomerBookingListModel
NameDescriptionTypeAdditional information
bookings

List of bookings

Collection of CustomerBookingModel

None.

Response Formats

application/json, text/json

Sample:
{
  "bookings": [
    {
      "feeBreakdown": [
        {
          "description": "sample string 1",
          "units": 2.0,
          "grossValue": 3.0
        },
        {
          "description": "sample string 1",
          "units": 2.0,
          "grossValue": 3.0
        }
      ],
      "bookingId": 1,
      "pendingBookingId": 1,
      "boatNo": 1,
      "boatName": "sample string 2",
      "arrivalDate": "sample string 3",
      "departureDate": "sample string 4",
      "marina": "sample string 5",
      "marinaCode": "sample string 6",
      "paid": true,
      "originalBookingValue": 8.0,
      "bookingValue": 9.0,
      "freeNightsToUse": 10,
      "confirmed": true,
      "cancelled": true,
      "status": "sample string 13"
    },
    {
      "feeBreakdown": [
        {
          "description": "sample string 1",
          "units": 2.0,
          "grossValue": 3.0
        },
        {
          "description": "sample string 1",
          "units": 2.0,
          "grossValue": 3.0
        }
      ],
      "bookingId": 1,
      "pendingBookingId": 1,
      "boatNo": 1,
      "boatName": "sample string 2",
      "arrivalDate": "sample string 3",
      "departureDate": "sample string 4",
      "marina": "sample string 5",
      "marinaCode": "sample string 6",
      "paid": true,
      "originalBookingValue": 8.0,
      "bookingValue": 9.0,
      "freeNightsToUse": 10,
      "confirmed": true,
      "cancelled": true,
      "status": "sample string 13"
    }
  ]
}

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[0].BookingId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[0].PendingBookingId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[0].BoatNo"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[0].BoatName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[0].ArrivalDate"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[0].DepartureDate"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[0].Marina"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[0].MarinaCode"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[0].Paid"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[0].OriginalBookingValue"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[0].BookingValue"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[0].FreeNightsToUse"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[0].Confirmed"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[0].Cancelled"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[0].Status"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[1].BookingId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[1].PendingBookingId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[1].BoatNo"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[1].BoatName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[1].ArrivalDate"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[1].DepartureDate"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[1].Marina"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[1].MarinaCode"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[1].Paid"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[1].OriginalBookingValue"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[1].BookingValue"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[1].FreeNightsToUse"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[1].Confirmed"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[1].Cancelled"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="bookings[1].Status"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e--