Jump to

• Request
• Response

Retrieve list of all onboard activities bookings for a reservation

get

/spms/v1/onboardActivities/{reservationId}/bookings

This is to retrieve a list of all onboard activities bookings for a reservation

Request

Supported Media Types

• application/json

Path Parameters

• reservationId: integer

Query Parameters

• status: string
  Allowed Values: [ "posted", "unposted", "checkin", "finished", "expected" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Onboard activity listing

Type: object

Title: Onboard activity listing

The object returned in Oracle Standard when function is executed successfully

Show Source

• items(optional): array items

{
    "title":"Onboard activity listing",
    "description":"The object returned in Oracle Standard when function is executed successfully",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/OnboardActivities"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Onboard activity type
  Title: Onboard activity type

  Return different onboard activity type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/OnboardActivities"
    }
}

Nested Schema : Onboard activity type

Type: object

Title: Onboard activity type

Return different onboard activity type

Show Source

• activity(optional): string
  Allowed Values: [ "Excursion", "Spa", "Ticketing" ]
• bookingStatus(optional): array bookingStatus

{
    "title":"Onboard activity type",
    "description":"Return different onboard activity type",
    "type":"object",
    "properties":{
        "activity":{
            "type":"string",
            "enum":[
                "Excursion",
                "Spa",
                "Ticketing"
            ]
        },
        "bookingStatus":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BookingStatus"
            }
        }
    }
}

Nested Schema : bookingStatus

Type: array

Show Source

• Array of: object All Activities Reservation status
  Title: All Activities Reservation status

  Retrieve all activities by booking status

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/BookingStatus"
    }
}

Nested Schema : All Activities Reservation status

Type: object

Title: All Activities Reservation status

Retrieve all activities by booking status

Show Source

• bookings(optional): array bookings
• count(optional): integer
  Example: 1
• status(optional): string
  Allowed Values: [ "posted", "unposted", "checkin", "expected", "finished" ]

{
    "title":"All Activities Reservation status",
    "description":"Retrieve all activities by booking status",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "posted",
                "unposted",
                "checkin",
                "expected",
                "finished"
            ]
        },
        "count":{
            "type":"integer",
            "example":1
        },
        "bookings":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BookingNumbers"
            }
        }
    }
}

Nested Schema : bookings

Type: array

Show Source

• Array of: object All Activities Booking number
  Title: All Activities Booking number

  Retrieve listing by all activities by booking number

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/BookingNumbers"
    }
}

Nested Schema : All Activities Booking number

Type: object

Title: All Activities Booking number

Retrieve listing by all activities by booking number

Show Source

• booking number(optional): integer
  Example: 1321546

{
    "title":"All Activities Booking number",
    "description":"Retrieve listing by all activities by booking number",
    "type":"object",
    "properties":{
        "booking number":{
            "type":"integer",
            "example":1321546
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/OnboardActivityErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter 'reservationId' has incorrect format"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter 'reservationId' has incorrect format"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/OnboardActivityErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorised",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorised",
    "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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/OnboardActivityErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource was forbidden"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : schema

Allowed Values: [ "Invalid booking status", "Invalid reservation ID" ]

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/OnboardActivityErrorResponse"
        }
    ],
    "enum":[
        "Invalid booking status",
        "Invalid reservation ID"
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Invalid reservation ID"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Invalid reservation ID"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/OnboardActivityErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Supported",
        "detail":"HTTP method not supported for this resource"
    }
}

Example:

{
    "type":"https://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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/OnboardActivityErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":"Issue fulfilling request. Please retry or contact support"
    }
}

Example:

{
    "type":"https://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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/OnboardActivityErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable. Try again later"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top