POST api/VoucherCodeCheck

Validates a voucher code against the booking model being created (cruise, existing vouchers, etc.). This overload allows empty voucher codes.

Request Information

URI Parameters

None.

Body Parameters

Booking model containing cruise information and any vouchers already applied.

BookingModel

Name	Type	Additional information
TestMode	boolean	None.
BookingId	globally unique identifier	None.
BookingIdHashCheck	string	None.
CruiseId	integer	Required
Salutation	string	Required
FirstName	string	Required
LastName	string	Required
HouseNumber	string	Required
Street	string	Required
Town	string	Required
County	string	None.
Postcode	string	Required String length: inclusive between 0 and 9
CountryCode	string	Required
SeperateBillingInstructions	boolean	None.
PostDocuments	boolean	None.
AcceptedTermsAndConditions	boolean	None.
BillingSalutation	string	None.
BillingFirstName	string	None.
BillingLastName	string	None.
BillingHouseNumber	string	None.
BillingStreet	string	None.
BillingTown	string	None.
BillingCounty	string	None.
BillingPostcode	string	String length: inclusive between 0 and 9
BillingCountryCode	string	None.
Vehicles	Collection of VehicleDTO	None.
EmailAddress	string	Required
ConfirmEmailAddress	string	Required
Telephone	string	Required
Vouchers	Collection of string	None.
ParkingZoneId	integer	None.
AcceptedGhostAlarmConditions	boolean	None.
GhostAlarmPresent	boolean	None.
SuccessUrl	string	None.
FailureUrl	string	None.

Request Formats

application/json, text/json

Sample:

{
  "testMode": true,
  "bookingId": "8be864ad-2550-430a-bb88-bbd4dc71c8ac",
  "bookingIdHashCheck": "sample string 3",
  "cruiseId": 4,
  "salutation": "sample string 5",
  "firstName": "sample string 6",
  "lastName": "sample string 7",
  "houseNumber": "sample string 8",
  "street": "sample string 9",
  "town": "sample string 10",
  "county": "sample string 11",
  "postcode": "sample string 12",
  "countryCode": "sample string 13",
  "seperateBillingInstructions": true,
  "postDocuments": true,
  "acceptedTermsAndConditions": true,
  "billingSalutation": "sample string 17",
  "billingFirstName": "sample string 18",
  "billingLastName": "sample string 19",
  "billingHouseNumber": "sample string 20",
  "billingStreet": "sample string 21",
  "billingTown": "sample string 22",
  "billingCounty": "sample string 23",
  "billingPostcode": "sample string 24",
  "billingCountryCode": "sample string 25",
  "vehicles": [
    {
      "vehicleTypeId": 1,
      "colour": "sample string 2",
      "driverName": "sample string 3",
      "registrationNumber": "sample string 4",
      "make": "sample string 5",
      "model": "sample string 6",
      "disabledParking": true,
      "disabledBadgeNumber": "sample string 8",
      "adaptedVehicle": true,
      "adaptedVehicleNotes": "sample string 10",
      "services": [
        {
          "serviceId": 1,
          "answers": [
            {
              "questionId": 1,
              "checkBoxAnswers": [
                {
                  "answer": true,
                  "fieldId": 2
                },
                {
                  "answer": true,
                  "fieldId": 2
                }
              ],
              "textBoxAnswers": [
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                },
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                }
              ],
              "radioButtonAnswer": 1,
              "calendarAnswers": [
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                },
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                }
              ]
            },
            {
              "questionId": 1,
              "checkBoxAnswers": [
                {
                  "answer": true,
                  "fieldId": 2
                },
                {
                  "answer": true,
                  "fieldId": 2
                }
              ],
              "textBoxAnswers": [
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                },
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                }
              ],
              "radioButtonAnswer": 1,
              "calendarAnswers": [
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                },
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                }
              ]
            }
          ]
        },
        {
          "serviceId": 1,
          "answers": [
            {
              "questionId": 1,
              "checkBoxAnswers": [
                {
                  "answer": true,
                  "fieldId": 2
                },
                {
                  "answer": true,
                  "fieldId": 2
                }
              ],
              "textBoxAnswers": [
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                },
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                }
              ],
              "radioButtonAnswer": 1,
              "calendarAnswers": [
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                },
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                }
              ]
            },
            {
              "questionId": 1,
              "checkBoxAnswers": [
                {
                  "answer": true,
                  "fieldId": 2
                },
                {
                  "answer": true,
                  "fieldId": 2
                }
              ],
              "textBoxAnswers": [
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                },
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                }
              ],
              "radioButtonAnswer": 1,
              "calendarAnswers": [
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                },
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "vehicleTypeId": 1,
      "colour": "sample string 2",
      "driverName": "sample string 3",
      "registrationNumber": "sample string 4",
      "make": "sample string 5",
      "model": "sample string 6",
      "disabledParking": true,
      "disabledBadgeNumber": "sample string 8",
      "adaptedVehicle": true,
      "adaptedVehicleNotes": "sample string 10",
      "services": [
        {
          "serviceId": 1,
          "answers": [
            {
              "questionId": 1,
              "checkBoxAnswers": [
                {
                  "answer": true,
                  "fieldId": 2
                },
                {
                  "answer": true,
                  "fieldId": 2
                }
              ],
              "textBoxAnswers": [
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                },
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                }
              ],
              "radioButtonAnswer": 1,
              "calendarAnswers": [
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                },
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                }
              ]
            },
            {
              "questionId": 1,
              "checkBoxAnswers": [
                {
                  "answer": true,
                  "fieldId": 2
                },
                {
                  "answer": true,
                  "fieldId": 2
                }
              ],
              "textBoxAnswers": [
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                },
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                }
              ],
              "radioButtonAnswer": 1,
              "calendarAnswers": [
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                },
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                }
              ]
            }
          ]
        },
        {
          "serviceId": 1,
          "answers": [
            {
              "questionId": 1,
              "checkBoxAnswers": [
                {
                  "answer": true,
                  "fieldId": 2
                },
                {
                  "answer": true,
                  "fieldId": 2
                }
              ],
              "textBoxAnswers": [
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                },
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                }
              ],
              "radioButtonAnswer": 1,
              "calendarAnswers": [
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                },
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                }
              ]
            },
            {
              "questionId": 1,
              "checkBoxAnswers": [
                {
                  "answer": true,
                  "fieldId": 2
                },
                {
                  "answer": true,
                  "fieldId": 2
                }
              ],
              "textBoxAnswers": [
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                },
                {
                  "answer": "sample string 1",
                  "fieldId": 2
                }
              ],
              "radioButtonAnswer": 1,
              "calendarAnswers": [
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                },
                {
                  "answer": "2026-03-17T19:59:14.3079717Z",
                  "fieldId": 2
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "emailAddress": "sample string 26",
  "confirmEmailAddress": "sample string 27",
  "telephone": "sample string 28",
  "vouchers": [
    "sample string 1",
    "sample string 2"
  ],
  "parkingZoneId": 1,
  "acceptedGhostAlarmConditions": true,
  "ghostAlarmPresent": true,
  "successUrl": "sample string 30",
  "failureUrl": "sample string 31"
}

application/xml, text/xml

Sample:

<BookingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CruiseParking.Website.API.BookingModels">
  <AcceptedGhostAlarmConditions>true</AcceptedGhostAlarmConditions>
  <AcceptedTermsAndConditions>true</AcceptedTermsAndConditions>
  <BillingCountryCode>sample string 25</BillingCountryCode>
  <BillingCounty>sample string 23</BillingCounty>
  <BillingFirstName>sample string 18</BillingFirstName>
  <BillingHouseNumber>sample string 20</BillingHouseNumber>
  <BillingLastName>sample string 19</BillingLastName>
  <BillingPostcode>sample string 24</BillingPostcode>
  <BillingSalutation>sample string 17</BillingSalutation>
  <BillingStreet>sample string 21</BillingStreet>
  <BillingTown>sample string 22</BillingTown>
  <BookingId>8be864ad-2550-430a-bb88-bbd4dc71c8ac</BookingId>
  <BookingIdHashCheck>sample string 3</BookingIdHashCheck>
  <ConfirmEmailAddress>sample string 27</ConfirmEmailAddress>
  <CountryCode>sample string 13</CountryCode>
  <County>sample string 11</County>
  <CruiseId>4</CruiseId>
  <EmailAddress>sample string 26</EmailAddress>
  <FailureUrl>sample string 31</FailureUrl>
  <FirstName>sample string 6</FirstName>
  <GhostAlarmPresent>true</GhostAlarmPresent>
  <HouseNumber>sample string 8</HouseNumber>
  <LastName>sample string 7</LastName>
  <ParkingZoneId>1</ParkingZoneId>
  <PostDocuments>true</PostDocuments>
  <Postcode>sample string 12</Postcode>
  <Salutation>sample string 5</Salutation>
  <SeperateBillingInstructions>true</SeperateBillingInstructions>
  <Street>sample string 9</Street>
  <SuccessUrl>sample string 30</SuccessUrl>
  <Telephone>sample string 28</Telephone>
  <TestMode>true</TestMode>
  <Town>sample string 10</Town>
  <Vehicles>
    <VehicleDTO>
      <AdaptedVehicle>true</AdaptedVehicle>
      <AdaptedVehicleNotes>sample string 10</AdaptedVehicleNotes>
      <Colour>sample string 2</Colour>
      <DisabledBadgeNumber>sample string 8</DisabledBadgeNumber>
      <DisabledParking>true</DisabledParking>
      <DriverName>sample string 3</DriverName>
      <Make>sample string 5</Make>
      <Model>sample string 6</Model>
      <RegistrationNumber>sample string 4</RegistrationNumber>
      <Services>
        <ServiceDTO>
          <Answers>
            <AnswerDTO>
              <CalendarAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
              </CalendarAnswers>
              <CheckBoxAnswers>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
              </CheckBoxAnswers>
              <QuestionId>1</QuestionId>
              <RadioButtonAnswer>1</RadioButtonAnswer>
              <TextBoxAnswers>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
              </TextBoxAnswers>
            </AnswerDTO>
            <AnswerDTO>
              <CalendarAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
              </CalendarAnswers>
              <CheckBoxAnswers>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
              </CheckBoxAnswers>
              <QuestionId>1</QuestionId>
              <RadioButtonAnswer>1</RadioButtonAnswer>
              <TextBoxAnswers>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
              </TextBoxAnswers>
            </AnswerDTO>
          </Answers>
          <ServiceId>1</ServiceId>
        </ServiceDTO>
        <ServiceDTO>
          <Answers>
            <AnswerDTO>
              <CalendarAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
              </CalendarAnswers>
              <CheckBoxAnswers>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
              </CheckBoxAnswers>
              <QuestionId>1</QuestionId>
              <RadioButtonAnswer>1</RadioButtonAnswer>
              <TextBoxAnswers>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
              </TextBoxAnswers>
            </AnswerDTO>
            <AnswerDTO>
              <CalendarAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
              </CalendarAnswers>
              <CheckBoxAnswers>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
              </CheckBoxAnswers>
              <QuestionId>1</QuestionId>
              <RadioButtonAnswer>1</RadioButtonAnswer>
              <TextBoxAnswers>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
              </TextBoxAnswers>
            </AnswerDTO>
          </Answers>
          <ServiceId>1</ServiceId>
        </ServiceDTO>
      </Services>
      <VehicleTypeId>1</VehicleTypeId>
    </VehicleDTO>
    <VehicleDTO>
      <AdaptedVehicle>true</AdaptedVehicle>
      <AdaptedVehicleNotes>sample string 10</AdaptedVehicleNotes>
      <Colour>sample string 2</Colour>
      <DisabledBadgeNumber>sample string 8</DisabledBadgeNumber>
      <DisabledParking>true</DisabledParking>
      <DriverName>sample string 3</DriverName>
      <Make>sample string 5</Make>
      <Model>sample string 6</Model>
      <RegistrationNumber>sample string 4</RegistrationNumber>
      <Services>
        <ServiceDTO>
          <Answers>
            <AnswerDTO>
              <CalendarAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
              </CalendarAnswers>
              <CheckBoxAnswers>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
              </CheckBoxAnswers>
              <QuestionId>1</QuestionId>
              <RadioButtonAnswer>1</RadioButtonAnswer>
              <TextBoxAnswers>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
              </TextBoxAnswers>
            </AnswerDTO>
            <AnswerDTO>
              <CalendarAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
              </CalendarAnswers>
              <CheckBoxAnswers>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
              </CheckBoxAnswers>
              <QuestionId>1</QuestionId>
              <RadioButtonAnswer>1</RadioButtonAnswer>
              <TextBoxAnswers>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
              </TextBoxAnswers>
            </AnswerDTO>
          </Answers>
          <ServiceId>1</ServiceId>
        </ServiceDTO>
        <ServiceDTO>
          <Answers>
            <AnswerDTO>
              <CalendarAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
              </CalendarAnswers>
              <CheckBoxAnswers>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
              </CheckBoxAnswers>
              <QuestionId>1</QuestionId>
              <RadioButtonAnswer>1</RadioButtonAnswer>
              <TextBoxAnswers>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
              </TextBoxAnswers>
            </AnswerDTO>
            <AnswerDTO>
              <CalendarAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
                <DateAnswers>
                  <FieldId>2</FieldId>
                  <Answer>2026-03-17T19:59:14.3079717+00:00</Answer>
                </DateAnswers>
              </CalendarAnswers>
              <CheckBoxAnswers>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
                <CheckboxAnswer>
                  <FieldId>2</FieldId>
                  <Answer>true</Answer>
                </CheckboxAnswer>
              </CheckBoxAnswers>
              <QuestionId>1</QuestionId>
              <RadioButtonAnswer>1</RadioButtonAnswer>
              <TextBoxAnswers>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
                <TextAnswer>
                  <FieldId>2</FieldId>
                  <Answer>sample string 1</Answer>
                </TextAnswer>
              </TextBoxAnswers>
            </AnswerDTO>
          </Answers>
          <ServiceId>1</ServiceId>
        </ServiceDTO>
      </Services>
      <VehicleTypeId>1</VehicleTypeId>
    </VehicleDTO>
  </Vehicles>
  <Vouchers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Vouchers>
</BookingModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Voucher validation result including validity status and status message.

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.