Jump to

• Request
• Response

Retrieve event ticketing booking by reservation Id

get

/spms/v2/ships/{shipId}/reservations/{reservationId}/bookedEventTicketing

This is to retrieve the Event Ticketing booking that are linked to a Cruise reservation Id

Request

Supported Media Types

• application/json

Path Parameters

• reservationId: number
• shipId: number
  Ship Id

Query Parameters

• bookingDateFrom(optional): string
  Booking Date From
• bookingDateTo(optional): string
  Booking Date To
• bookingStatus(optional): string
  Booking Status

  Allowed Values: [ "check in", "expected" ]
• eventTicketBookingId(optional): number
  Event Ticket Booking Id
• eventTicketName(optional): string
  Event Ticket Name

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Event Ticketings

Type: object

Title: Event Ticketings

Event Ticketings

Show Source

• eventTicketBookingDetails(optional): array eventTicketBookingDetails
  Event Tickets Booking Details
• reservationId(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Reservation Id

  Example: 1001

{
    "title":"Event Ticketings",
    "description":"Event Ticketings",
    "type":"object",
    "properties":{
        "reservationId":{
            "$ref":"#/definitions/reservationId"
        },
        "eventTicketBookingDetails":{
            "$ref":"#/definitions/eventTicketBookingDetails"
        }
    }
}

Nested Schema : eventTicketBookingDetails

Type: array

Event Tickets Booking Details

Show Source

• Array of: object eventTicketBookings
  Event Ticket Bookings

{
    "description":"Event Tickets Booking Details",
    "type":"array",
    "items":{
        "$ref":"#/definitions/eventTicketBookings"
    },
    "example":[
        {
            "eventTicketBookingId":1,
            "bookableEvent":{
                "id":1,
                "code":"MV01",
                "eventTicketingName":"Movie - Transformer",
                "description":"Transformer"
            },
            "bookingDate":"2009-10-31",
            "bookingTime":"06:59:00",
            "bookingStatus":"Expected",
            "postingStatus":"Posted",
            "seatingPriceCategory":{
                "id":1,
                "priceCategory":"Price Category 1"
            },
            "seatingZone":{
                "id":1,
                "seatCode":"SZ1",
                "zone":"Zone"
            },
            "netPrice":9,
            "grossPrice":10,
            "quantity":1,
            "discountPercentage":10,
            "refundAmount":0,
            "totalAmount":9
        }
    ]
}

Example:

[
    {
        "eventTicketBookingId":1,
        "bookableEvent":{
            "id":1,
            "code":"MV01",
            "eventTicketingName":"Movie - Transformer",
            "description":"Transformer"
        },
        "bookingDate":"2009-10-31",
        "bookingTime":"06:59:00",
        "bookingStatus":"Expected",
        "postingStatus":"Posted",
        "seatingPriceCategory":{
            "id":1,
            "priceCategory":"Price Category 1"
        },
        "seatingZone":{
            "id":1,
            "seatCode":"SZ1",
            "zone":"Zone"
        },
        "netPrice":9,
        "grossPrice":10,
        "quantity":1,
        "discountPercentage":10,
        "refundAmount":0,
        "totalAmount":9
    }
]

Nested Schema : eventTicketBookings

Type: object

Event Ticket Bookings

Show Source

• bookableEvent(optional): object bookableEvent
  Bookable Event
• bookedDate(optional): string(ISO 8601)
  Booking Date

  Example: 2009-10-31
• bookedTime(optional): string(ISO 8601)
  Booking Time

  Example: 06:59:00
• bookingStatus(optional): string
  Allowed Values: [ "check in", "expected" ]

  Booking Status

  Example: check in
• discountPercentage(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Discount Percentage

  Example: 3
• eventTicketBookingId(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Event Ticket Booking Id

  Example: 1001
• grossPrice(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Gross Price

  Example: 102
• netPrice(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Net Price

  Example: 99
• postingStatus(optional): string
  Allowed Values: [ "posted", "unposted", "onhold" ]

  Posting Status

  Example: posted
• quantity(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Quantity

  Example: 3
• refundAmount(optional): number
  Refund Amount

  Example: 50
• seatCode(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Seat Code

  Example: SZ1
• seatingPriceCategory(optional): object seatingPriceCategory
  Seating Price Category
• seatingZone(optional): object seatingZone
  Seating Zone
• totalAmount(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Total Amount

  Example: 90

{
    "description":"Event Ticket Bookings",
    "type":"object",
    "properties":{
        "eventTicketBookingId":{
            "$ref":"#/definitions/eventTicketBookingId"
        },
        "bookableEvent":{
            "$ref":"#/definitions/bookableEvent"
        },
        "bookedDate":{
            "$ref":"#/definitions/bookedDate"
        },
        "bookedTime":{
            "$ref":"#/definitions/bookedTime"
        },
        "bookingStatus":{
            "$ref":"#/definitions/bookingStatus"
        },
        "postingStatus":{
            "$ref":"#/definitions/postingStatus"
        },
        "seatingZone":{
            "$ref":"#/definitions/seatingZone"
        },
        "seatCode":{
            "$ref":"#/definitions/seatCode"
        },
        "seatingPriceCategory":{
            "$ref":"#/definitions/seatingPriceCategory"
        },
        "netPrice":{
            "$ref":"#/definitions/netPrice"
        },
        "grossPrice":{
            "$ref":"#/definitions/grossPrice"
        },
        "quantity":{
            "$ref":"#/definitions/quantity"
        },
        "discountPercentage":{
            "$ref":"#/definitions/discountPercentage"
        },
        "refundAmount":{
            "$ref":"#/definitions/refundAmount"
        },
        "totalAmount":{
            "$ref":"#/definitions/totalAmount"
        }
    }
}

Nested Schema : bookableEvent

Type: object

Bookable Event

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Bookable Event Code

  Example: MV01
• description(optional): string
  Minimum Length: 1

  Maximum Length: 50

  Bookable Event Description

  Example: Transformer
• eventTicketingName(optional): string
  Minimum Length: 1

  Maximum Length: 50

  Bookable Event Name

  Example: Movie - Transformer
• id(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Event Ticket Booking Id

  Example: 1001

{
    "description":"Bookable Event",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/bookableEventId"
        },
        "code":{
            "$ref":"#/definitions/bookableEventCode"
        },
        "eventTicketingName":{
            "$ref":"#/definitions/bookableEventName"
        },
        "description":{
            "$ref":"#/definitions/bookableEventDescription"
        }
    }
}

Nested Schema : seatingPriceCategory

Type: object

Seating Price Category

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 1000

  Price Category

  Example: Price Category 1
• id(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Price Category Id

  Example: 1001

{
    "description":"Seating Price Category",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/priceCategoryId"
        },
        "code":{
            "$ref":"#/definitions/priceCategory"
        }
    }
}

Nested Schema : seatingZone

Type: object

Seating Zone

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Seat Code

  Example: SZ1
• id(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Zone Id

  Example: 1001
• zone(optional): string
  Minimum Length: 1

  Maximum Length: 50

  Seating Zone

  Example: Zone

{
    "description":"Seating Zone",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/zoneId"
        },
        "code":{
            "$ref":"#/definitions/seatCode"
        },
        "zone":{
            "$ref":"#/definitions/zone"
        }
    }
}

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/EventTicketingErrorResponse"
        }
    ],
    "example":{
        "title":"Bad Request",
        "detail":"Invalid Booking Status.",
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
    }
}

Example:

{
    "title":"Bad Request",
    "detail":"Invalid Booking Status.",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
}

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

You are not authorized to use this API

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

Example:

{
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2"
}

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

You are forbidden to use this API

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

Example:

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

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

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/EventTicketingErrorResponse"
        }
    ],
    "example":{
        "title":"Not Found",
        "detail":"Event ticket details not found.",
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
    }
}

Example:

{
    "title":"Not Found",
    "detail":"Event ticket details not found.",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
}

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

This method is not available

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

Example:

{
    "title":"Method Not Supported",
    "detail":"HTTP method not supported for this resource",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6"
}

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"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/EventTicketingErrorResponse"
        }
    ],
    "example":{
        "title":"Not Acceptable",
        "detail":"Request a Mime type that is supported for this Resource",
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7"
    }
}

Example:

{
    "title":"Not Acceptable",
    "detail":"Request a Mime type that is supported for this Resource",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7"
}

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

Error occured while processing this request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

Example:

{
    "title":"Internal Server Error",
    "details":"Issue fulfilling request. Please retry or contact support",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1"
}

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/EventTicketingErrorResponse"
        }
    ],
    "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