Retrieve Cruise Itineraries
get
/spms/v2/ships/{shipId}/cruiseItineraries
This is to retrieve Cruise information name of the cruise and to retrieve Cruise day information for a cruise for each day being on which port or it being a day at sea
Request
Supported Media Types
- application/json
Path Parameters
-
shipId(required): number
Ship Id
Query Parameters
-
cruiseClosed: boolean
Cruise Closed
-
cruiseId: number
Cruise Id
-
endDate: string
End Date
-
limit: integer(int32)
Minimum Value:
1
Paging limit -
offset: integer(int32)
Minimum Value:
0
Paging offset -
orderBy: string
order by cruiseId, centerId, externalCruiseId, description, startDate, endDate, islandDate, safetyAssemblyTime with format column1:asc/desc,column2:asc/desc
-
startDate: string
Start Date
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : CruiseItinerariesList
Type:
object
Title:
Show Source
CruiseItinerariesList
-
count:
number
The total number of items in the list.Example:
3
-
hasMore:
boolean
Flag which indicates whether or not there are more items.Example:
false
-
items:
array items
-
limit:
number
Paging limitExample:
5
-
offset:
number
Paging offsetExample:
10
Nested Schema : items
Type:
Show Source
array
-
Array of:
object cruiseItinerary
Cruise Itinerary
Example:
[
{
"cruiseId":"1",
"centerId":"2",
"externalCruiseId":"3",
"cruiseDescription":"SI 27",
"cruiseStartDate":"2005-02-22",
"cruiseEndDate":"2005-03-04",
"islandDate":"2005-03-04",
"cruiseCurrency":{
"departmentId":"9500",
"comment":"Euro"
},
"safetyAssemblyTime":"06:59:00",
"itineraries":[
{
"cruiseItineraryId":"1",
"itineraryId":"ITI10",
"arrivalPortName":"Phuket Tender Port",
"portType":"P",
"portComment":"AT SEA",
"weather":"Sunny Day",
"comment":"Cruise Day - onboard activitivies with crew show.",
"arrivalCountry":"Argentina",
"departureDate":"2005-02-23",
"departureTime":"00:00:00",
"arrivalDate":"2005-02-23",
"arrivalTime":"00:00:00",
"allAbroadTime":"06:59:00",
"isCurrentHarbor":false
},
{
"cruiseItineraryId":"2",
"itineraryId":"ITI10",
"arrivalPortName":null,
"portType":"T",
"portComment":"AT SEA",
"weather":"Sunny Day",
"comment":"Cruise Day - onboard activitivies with crew show.",
"arrivalCountry":"Antigua and Barbuda",
"departureDate":"2005-02-23",
"departureTime":"00:00:00",
"arrivalDate":"2005-02-23",
"arrivalTime":"00:00:00",
"allAbroadTime":"06:59:00",
"isCurrentHarbor":true
}
]
}
]
Nested Schema : cruiseItinerary
Type:
object
Cruise Itinerary
Show Source
-
centerId:
string
Minimum Length:
1
Maximum Length:10
Center IdExample:CI01
-
cruiseCurrency:
object cruiseCurrency
Cruise Currency
-
cruiseDescription:
string
Minimum Length:
1
Maximum Length:255
Cruise DescriptionExample:SI 27
-
cruiseEndDate:
string(ISO 8601)
Cruise End DateExample:
2009-10-31
-
cruiseId:
number
Minimum Value:
1
Pattern:^[0-9]*$
cruise IdExample:1001
-
cruiseStartDate:
string(ISO 8601)
Cruise Start DateExample:
2009-10-31
-
externalCruiseId:
string
Minimum Length:
1
Maximum Length:10
External Cruise IdExample:ECI01
-
islandDate:
string(ISO 8601)
Cruise End DateExample:
2009-10-31
-
itineraries:
array itineraries
Itineraries
-
safetyAssemblyTime:
string(ISO 8601)
Safety Assembly TimeExample:
06:59:00
Nested Schema : cruiseCurrency
Type:
object
Cruise Currency
Show Source
-
comment:
string
Minimum Length:
1
Maximum Length:50
Currency CommentExample:Euro
-
departmentId:
number
Minimum Value:
1
Pattern:^[0-9]*$
Department IdExample:9500
Nested Schema : itineraries
Type:
array
Itineraries
Show Source
-
Array of:
object itinerary
Itinerary
Nested Schema : itinerary
Type:
object
Itinerary
Show Source
-
allAbroadTime:
string(ISO 8601)
All Abroad TimeExample:
06:59:00
-
arrivalCountry:
string
Arrival CountryExample:
Italy
-
arrivalDate:
string(ISO 8601)
Arrival DateExample:
2009-10-31
-
arrivalPortName:
string
Arrival NameExample:
TUNIS LA GOULETTE
-
arrivalTime:
string(ISO 8601)
Arrival TimeExample:
10:30:00
-
comment:
string
CommentExample:
onboard activities
-
cruiseItineraryId:
number
Minimum Value:
1
Pattern:^[0-9]*$
Itinerary IdExample:1001
-
departureDate:
string(ISO 8601)
Departure DateExample:
2009-10-31
-
departureTime:
string(ISO 8601)
Departure TimeExample:
06:59:00
-
isCurrentHarbor:
boolean
This is to indicate the ship has arrived and docked at the harborExample:
true
-
itineraryId:
string
Cruise Itinerary idExample:
CI001
-
portComment:
string
Port CommentExample:
AT SEA
-
portType:
string
Port TypeExample:
P
-
weather:
string
WeatherExample:
Sunny Day
204 Response
No Content
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
"title":"Unauthorized",
"detail":"Valid token is required to access this resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Forbidden",
"detail":"Access to this resource is forbidden"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
"title":"Method Not Supported",
"detail":"HTTP method not supported for this resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
"title":"Not Acceptable",
"detail":"Request a Mime type that is supported for this Resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
"title":"Internal Server Error",
"detail":"Issue fulfilling request. Please retry or contact support"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
"title":"Service Unavailable",
"detail":"Service Unavailable. Try again later"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source