NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Retrieve excursion booking details

get

/spms/v1/excursions/bookings/{reservationId}

This is to retrieve excursion booking details for a reservation

Request

Supported Media Types

• application/json

Path Parameters

• reservationId: integer
  This is reservation Id

Query Parameters

• boardCardNumber: string
  Boardcard number
• bookingId: integer
  This is booking Id
• bookingStatus: string
  This is booking status

  Allowed Values: [ "posted", "unposted" ]
• excursionDate: string
  Excursion date
• excursionName: string
• overnightTour: boolean
  This is the value show the excursion got overnight tour or not

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieve Excursion booking details

Body ()

Root Schema : Excursion Bookings list

Type: object

Title: Excursion Bookings list

The object returned in Oracle Standard when function is executed successfully

Show Source

• items(optional): array items

{
    "title":"Excursion Bookings list",
    "description":"The object returned in Oracle Standard when function is executed successfully",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExcursionBookings"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Excursion Bookings
  Title: Excursion Bookings

  Retrieve Excursion Bookings

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

Nested Schema : Excursion Bookings

Type: object

Title: Excursion Bookings

Retrieve Excursion Bookings

Show Source

• boardCardNumber(optional): string
  Example: 1000872
• bookingId(optional): integer
  Example: 1000872
• bookingStatus(optional): string
  This value is the status of the booking

  Example: posted
• excursionDate(optional): string
  Example: 2020-06-26
• excursionName(optional): string
  Example: Island Hopping
• overnightTour(optional): boolean
  This value will determine whether the booked excursion has an overnight tour or not.

  Example: true

{
    "title":"Excursion Bookings",
    "description":"Retrieve Excursion Bookings",
    "type":"object",
    "properties":{
        "bookingId":{
            "type":"integer",
            "example":1000872
        },
        "excursionName":{
            "type":"string",
            "example":"Island Hopping"
        },
        "bookingStatus":{
            "type":"string",
            "example":"posted",
            "description":"This value is the status of the booking"
        },
        "excursionDate":{
            "type":"string",
            "example":"2020-06-26"
        },
        "overnightTour":{
            "type":"boolean",
            "example":"true",
            "description":"This value will determine whether the booked excursion has an overnight tour or not."
        },
        "boardCardNumber":{
            "type":"string",
            "example":"1000872"
        }
    }
}

204 Response

No content

401 Response

You are not authorized to use this API

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

404 Response

Reservation ID not found

Body ()

Root Schema : schema

Type: string

Example:

Reservation ID not found

405 Response

This method is not available

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

500 Response

Error occurred while processing this request

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

502 Response

Bad Gateway

503 Response

Service not available

Back to Top