Retrieve Current Cruise Itineraries
get
/spms/v2/ships/{shipId}/cruiseItineraries/currentCruise
This is to retrieve current Cruise information name of the cruise and to retrieve Cruise day information for the cruise for each day being on which port or it being a day at sea
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: number
Ship Id
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : GetCurrentCruise
Type:
object
Title:
Show Source
GetCurrentCruise
-
centerId(optional):
string
Minimum Length:
1
Maximum Length:10
Center IdExample:CI01
-
cruiseCurrency(optional):
object cruiseCurrency
Cruise Currency
-
cruiseDescription(optional):
string
Minimum Length:
1
Maximum Length:255
Cruise DescriptionExample:SI 27
-
cruiseEndDate(optional):
string(ISO 8601)
Cruise End DateExample:
2009-10-31
-
cruiseId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
cruise IdExample:1001
-
cruiseStartDate(optional):
string(ISO 8601)
Cruise Start DateExample:
2009-10-31
-
externalCruiseId(optional):
string
Minimum Length:
1
Maximum Length:10
External Cruise IdExample:ECI01
-
islandDate(optional):
string(ISO 8601)
Cruise End DateExample:
2009-10-31
-
itineraries(optional):
array itineraries
Itineraries
-
safetyAssemblyTime(optional):
string(ISO 8601)
Safety Assembly TimeExample:
06:59:00
Nested Schema : cruiseCurrency
Type:
object
Cruise Currency
Show Source
-
comment(optional):
string
Minimum Length:
1
Maximum Length:50
Currency CommentExample:Euro
-
departmentId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Department IdExample:9500
Nested Schema : itineraries
Type:
array
Itineraries
Show Source
-
Array of:
object itinerary
Itinerary
Example:
[
{
"itineraryId":1,
"arrivalPortName":"TUNIS LA GOULETTE",
"portType":"At Port",
"portComment":"TUNIS LA GOULETTE",
"weather":"Spring",
"comment":"comment",
"arrivalCountry":"Argentina",
"departureDate":"2005-03-04",
"departureTime":"06:59:00",
"arrivalDate":"2005-03-04",
"arrivalTime":"06:59:00",
"allAbroadTime":"06:59:00"
}
]
Nested Schema : itinerary
Type:
object
Itinerary
Show Source
-
allAbroadTime(optional):
string(ISO 8601)
All Abroad TimeExample:
06:59:00
-
arrivalCountry(optional):
string
Arrival Country
-
arrivalDate(optional):
string(ISO 8601)
Arrival DateExample:
2009-10-31
-
arrivalPortName(optional):
string
Arrival NameExample:
TUNIS LA GOULETTE
-
arrivalTime(optional):
string(ISO 8601)
Arrival TimeExample:
2009-10-31
-
comment(optional):
string
Comment
-
cruiseItineraryId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Itinerary IdExample:1001
-
departureDate(optional):
string(ISO 8601)
Departure DateExample:
2009-10-31
-
departureTime(optional):
string(ISO 8601)
Departure TimeExample:
06:59:00
-
itineraryId(optional):
string
Cruise Itinerary idExample:
CI001
-
portComment(optional):
string
Port Comment
-
portType(optional):
string
Port TypeExample:
P
-
weather(optional):
string
Weather
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
404 Response
Not Found
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.5",
"title":"Not Found",
"detail":"Ship 123 was not found"
}
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