GET api/Cruises?departureDate={departureDate}&portId={portId}&flatten={flatten}

Returns public-facing cruises departing on a given date, optionally filtered by port. By default returns a hierarchical port → operator → ship → cruise tree; set flatten=true for a flat CruiseDTO list.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
departureDate

Departure date (date portion used).

date

Required

portId

Optional port filter (matches ship default port).

integer

None.

flatten

When true, returns a flat array of CruiseAvailabilityFlatDTO instead of the hierarchical structure.

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.