1. Oracle Hospitality Cruise REST API
  2. Tasks
  3. Cruise
  4. Itinerary

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
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : CruiseItinerariesList
Type: object
Title: CruiseItinerariesList
Show Source
Nested Schema : items
Type: array
Show Source
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"
            },
            {
                "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"
            }
        ]
    }
]
Nested Schema : cruiseItinerary
Type: object
Cruise Itinerary
Show Source
Nested Schema : cruiseCurrency
Type: object
Cruise Currency
Show Source
Nested Schema : itineraries
Type: array
Itineraries
Show Source
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

204 Response

No Content

401 Response

Unauthorized
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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
Back to Top