Oracle Hospitality Cruise Property Management REST API 23.2.2

Update a guest reservation by Id

put

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

This is to update a guest reservation detail by Reservation Id

Request

Supported Media Types

application/json

Path Parameters

reservationId(required): number

Reservation Id
shipId(required): integer

ship Id

Guest Reservation PUT Object

Root Schema : guestReservationPUTObject

Type: object

Guest Reservation PUT Object

Show Source

agentDetails: object agentDetails

Agent Details
boardCardNumber: string

Pattern: ^[a-zA-Z0-9 ]+?$

Board Card Number

Example: 100500333
bookingNumber: string

Minimum Length: 1

Maximum Length: 100

Booking Number

Example: 123456789
diningDetails: object diningDetails

Dining Details
discountTemplateCode: string

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Discount Template Code

Example: A1
disembarkationDate: string(date)

Disembarkation Date

Example: 2018-11-11
disembarkationHarborCode: string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Disembarkation Harbor Code

Example: D1
disembarkationHarborComments: string

Maximum Length: 20

disembarkation harbor comments

Example: Going to the land
document: object document

Document
embarkationDate(required): string(date)

Embarkation Date

Example: 2018-11-11
embarkationHarborCode: string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Embarkation Harbor Code

Example: E1
embarkationHarborComments: string

Maximum Length: 20

Embarkation harbor comments

Example: Going to the sea
isNoticeAndConsent(required): boolean

Acknowledge Notice and Consent

Example: true
lifeBoatCode: string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Lifeboat Code

Example: L1
manifestPrintout: boolean

Manifest Printout

Example: false
musterStationCode: string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Musterstation Code

Example: M1
numberOfCruiseDays: integer

Minimum Value: 0

Maximum Value: 99999999

Total Number Of Cruise Days

Example: 1
numberOfCruises: integer

Minimum Value: 0

Maximum Value: 99999999

Number Of Cruises

Example: 1
onboardEmail: string

Minimum Length: 1

Maximum Length: 72

Pattern: ^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$

Onboard Email Address * `null` if empty

Example: email@example.com
onboardStatus: boolean

onboardStatus

Example: false
otherParameter: object otherParameter

Other Parameters
profileInformation: object profileInformationPOST

Profile Information for Post
queueId: integer

Minimum Value: 0

Maximum Value: 99999999

Queue Id

Example: 11
setSailPassNumber: string

Minimum Length: 1

Maximum Length: 30

Set Sail Pass Number

Example: 3388
shoreGId: string

Minimum Length: 1

Maximum Length: 50

Shore G Id

Example: G1
shoreResId: string

Minimum Length: 1

Maximum Length: 15

Shore Reservation Id

Example: S1
stateroomNumber: string

Minimum Length: 1

Maximum Length: 20

stateroomNumber

Example: 1001

{
    "description":"Guest Reservation PUT Object",
    "type":"object",
    "properties":{
        "embarkationDate":{
            "$ref":"#/definitions/grEmbarkationDate"
        },
        "embarkationHarborCode":{
            "$ref":"#/definitions/embarkationHarborCode"
        },
        "embarkationHarborComments":{
            "$ref":"#/definitions/embarkationHarborComments"
        },
        "disembarkationDate":{
            "$ref":"#/definitions/grDisembarkationDate"
        },
        "disembarkationHarborCode":{
            "$ref":"#/definitions/disembarkationHarborCode"
        },
        "disembarkationHarborComments":{
            "$ref":"#/definitions/disembarkationHarborComments"
        },
        "bookingNumber":{
            "$ref":"#/definitions/grBookingNumber"
        },
        "stateroomNumber":{
            "$ref":"#/definitions/grStateroomNumber"
        },
        "boardCardNumber":{
            "$ref":"#/definitions/grBoardCardNumber"
        },
        "setSailPassNumber":{
            "$ref":"#/definitions/setSailPassNumber"
        },
        "musterStationCode":{
            "$ref":"#/definitions/musterStationCode"
        },
        "onboardStatus":{
            "$ref":"#/definitions/grOnboardStatus"
        },
        "manifestPrintout":{
            "$ref":"#/definitions/manifestPrintout"
        },
        "document":{
            "$ref":"#/definitions/document"
        },
        "lifeBoatCode":{
            "$ref":"#/definitions/lifeBoatCode"
        },
        "shoreGId":{
            "$ref":"#/definitions/shoreGId"
        },
        "queueId":{
            "$ref":"#/definitions/queueId"
        },
        "onboardEmail":{
            "$ref":"#/definitions/onboardEmail"
        },
        "numberOfCruiseDays":{
            "$ref":"#/definitions/numberOfCruiseDays"
        },
        "numberOfCruises":{
            "$ref":"#/definitions/numberOfCruises"
        },
        "discountTemplateCode":{
            "$ref":"#/definitions/grDiscountTemplateCode"
        },
        "shoreResId":{
            "$ref":"#/definitions/shoreResId"
        },
        "otherParameter":{
            "$ref":"#/definitions/otherParameter"
        },
        "isNoticeAndConsent":{
            "$ref":"#/definitions/isNoticeAndConsent"
        },
        "profileInformation":{
            "$ref":"#/definitions/profileInformationPOST"
        },
        "diningDetails":{
            "$ref":"#/definitions/diningDetails"
        },
        "agentDetails":{
            "$ref":"#/definitions/agentDetails"
        }
    },
    "required":[
        "embarkationDate",
        "isNoticeAndConsent"
    ]
}

Nested Schema : agentDetails

Type: object

Agent Details

Show Source

agentBookingId: string

Minimum Length: 0

Maximum Length: 20

Agent Booking Id

Example: A123
agentId: string

Minimum Length: 0

Maximum Length: 20

Agent Id

Example: A123
agentReferenceId: string

Minimum Length: 0

Maximum Length: 20

Agent Reference Id

Example: A123

{
    "description":"Agent Details",
    "type":"object",
    "properties":{
        "agentId":{
            "$ref":"#/definitions/agentId"
        },
        "agentReferenceId":{
            "$ref":"#/definitions/agentReferenceId"
        },
        "agentBookingId":{
            "$ref":"#/definitions/agentBookingId"
        }
    }
}

Nested Schema : diningDetails

Type: object

Dining Details

Show Source

otherSeating: string

Minimum Length: 0

Maximum Length: 50

Other Seating

Example: A123
referenceTableId: number

Minimum Value: 0

Reference Table Id

Example: 123
restaurantSeating: string

Minimum Length: 0

Maximum Length: 10

Restaurant Seating

Example: A123
tableAssignment: string

Minimum Length: 0

Maximum Length: 3

Table Assignment

Example: A123

{
    "description":"Dining Details",
    "type":"object",
    "properties":{
        "referenceTableId":{
            "$ref":"#/definitions/referenceTableId"
        },
        "restaurantSeating":{
            "$ref":"#/definitions/restaurantSeating"
        },
        "otherSeating":{
            "$ref":"#/definitions/otherSeating"
        },
        "tableAssignment":{
            "$ref":"#/definitions/tableAssignment"
        }
    }
}

Nested Schema : document

Type: object

Document

Show Source

isDocumentChecked: boolean

Document Is Checked

Example: false
isDocumentCollected: boolean

Document Is Collect

Example: false

{
    "description":"Document",
    "type":"object",
    "properties":{
        "isDocumentChecked":{
            "$ref":"#/definitions/isDocumentChecked"
        },
        "isDocumentCollected":{
            "$ref":"#/definitions/isDocumentCollected"
        }
    }
}

Nested Schema : otherParameter

Type: object

Other Parameters

Show Source

isAirSeaOperator: boolean

Is Air Sea Operator

Example: false
isChargeCheckedOutCalls: boolean

Is Charge For Checked Out Calls

Example: false
isCompleteOnlineForm: boolean

Is Complete Online Form

Example: false
isExpressCheckOut: boolean

Is Express Checkout

Example: false
isGroupLeader: boolean

Is Group Leader

Example: false
isKioskCheckInAllowed: boolean

Is Kiosk Check In Allowed

Example: false
isNonInclusiveGuestType: boolean

Is Non Inclusive Guest Type

Example: false
isResident: boolean

Is Resident

Example: false
isStayOvernightTour: boolean

Is Stay Overnight Tour

Example: false
isSwitchToCrewManifest: boolean

Is Switch To Crew Manifest

Example: false

{
    "description":"Other Parameters",
    "type":"object",
    "properties":{
        "isResident":{
            "$ref":"#/definitions/isResident"
        },
        "isAirSeaOperator":{
            "$ref":"#/definitions/isAirSeaOperator"
        },
        "isExpressCheckOut":{
            "$ref":"#/definitions/isExpressCheckOut"
        },
        "isGroupLeader":{
            "$ref":"#/definitions/isGroupLeader"
        },
        "isCompleteOnlineForm":{
            "$ref":"#/definitions/isCompleteOnlineForm"
        },
        "isNonInclusiveGuestType":{
            "$ref":"#/definitions/isNonInclusiveGuestType"
        },
        "isChargeCheckedOutCalls":{
            "$ref":"#/definitions/isChargeCheckedOutCalls"
        },
        "isSwitchToCrewManifest":{
            "$ref":"#/definitions/isSwitchToCrewManifest"
        },
        "isStayOvernightTour":{
            "$ref":"#/definitions/isStayOvernightTour"
        },
        "isKioskCheckInAllowed":{
            "$ref":"#/definitions/isKioskCheckInAllowed"
        }
    }
}

Nested Schema : profileInformationPOST

Type: object

Profile Information for Post

Show Source

birthPlace: string

Maximum Length: 50

Birth Place

Example: Kajang
dateOfBirth(required): string(ISO 8601 (YYYY-MM-DD))

Date Of Birth

Example: 1999-02-15
firstName(required): string

Minimum Length: 1

Maximum Length: 40

First Name

Example: Fabiana
genderCode(required): string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Gender Code

Example: M
guestCategoryCodes: array guestCategoryPOST
lastName(required): string

Minimum Length: 1

Maximum Length: 40

Last Name

Example: Carleo
maritalStatusCode: string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Marital Status Code

Example: S
middleName: string

Minimum Length: 1

Maximum Length: 20

Middle Name * `null` if empty

Example: Alberto
nationalId: string

Minimum Length: 1

Maximum Length: 20

National Id

Example: 22A
nationalityCode(required): string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Nationality Code

Example: MY
otherFirstName: string

Minimum Length: 1

Maximum Length: 80

Other First Name * `null` if empty

Example: Frost
otherLastName: string

Minimum Length: 1

Maximum Length: 100

Other Last Name * `null` if empty

Example: Francis
passportIssuedCountryCode(required): string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Passport Issued Country Code

Example: MY
passportIssuedDate(required): string(ISO 8601)

Passport Issued Date

Example: 2009-10-31
passportIssuedExpiryDate(required): string(date)

Passport Issued Expiry Date

Example: 2018-11-11
passportIssuedPlace(required): string

Maximum Length: 50

Passport Issued Place

Example: Shah Alam
passportNumber(required): string

Minimum Length: 1

Maximum Length: 20

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Passport Number

Example: A145611
permanentResidentId: string

Maximum Length: 30

Permanent Resident

Example: P123
royaltyNumber: string

Maximum Length: 20

Royalty Number

Example: a1234
salutation: string

Minimum Length: 1

Maximum Length: 20

Salutation

Example: MR
title: string

Minimum Length: 1

Maximum Length: 20

Title

Example: MR
vipCode: string

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

VIP Code

Example: L1

{
    "description":"Profile Information for Post",
    "type":"object",
    "properties":{
        "lastName":{
            "$ref":"#/definitions/grLastName"
        },
        "firstName":{
            "$ref":"#/definitions/grFirstName"
        },
        "middleName":{
            "$ref":"#/definitions/grMiddleName"
        },
        "otherLastName":{
            "$ref":"#/definitions/grOtherLastName"
        },
        "otherFirstName":{
            "$ref":"#/definitions/grOtherFirstName"
        },
        "title":{
            "$ref":"#/definitions/grTitle"
        },
        "salutation":{
            "$ref":"#/definitions/grSalutation"
        },
        "genderCode":{
            "$ref":"#/definitions/grGenderCode"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "nationalityCode":{
            "$ref":"#/definitions/grNationalityCode"
        },
        "nationalId":{
            "$ref":"#/definitions/grNationalId"
        },
        "birthPlace":{
            "$ref":"#/definitions/grBirthPlace"
        },
        "passportNumber":{
            "$ref":"#/definitions/grPassportNumber"
        },
        "passportIssuedDate":{
            "$ref":"#/definitions/passportIssuedDate"
        },
        "passportIssuedExpiryDate":{
            "$ref":"#/definitions/passportIssuedExpiryDate"
        },
        "passportIssuedCountryCode":{
            "$ref":"#/definitions/passportIssuedCountryCode"
        },
        "passportIssuedPlace":{
            "$ref":"#/definitions/passportIssuedPlace"
        },
        "vipCode":{
            "$ref":"#/definitions/grVipCode"
        },
        "guestCategoryCodes":{
            "$ref":"#/definitions/guestCategoryPOST"
        },
        "permanentResidentId":{
            "$ref":"#/definitions/permanentResidentId"
        },
        "royaltyNumber":{
            "$ref":"#/definitions/grRoyaltyNumber"
        },
        "maritalStatusCode":{
            "$ref":"#/definitions/maritalStatusCode"
        }
    },
    "required":[
        "lastName",
        "firstName",
        "genderCode",
        "dateOfBirth",
        "nationalityCode",
        "passportNumber",
        "passportIssuedDate",
        "passportIssuedExpiryDate",
        "passportIssuedCountryCode",
        "passportIssuedPlace"
    ]
}

Nested Schema : guestCategoryPOST

Type: array

Show Source

Array of: string

Minimum Length: 1

Maximum Length: 6

Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

Guest Category Codes

Example: GC1

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

Response

Supported Media Types

application/json

200 Response

Updated

Root Schema : guestReservationGETObject

Type: object

Guest Reservation GET Object

Show Source

agentDetails: object agentDetails

Agent Details
boardCardNumber: string

Pattern: ^[a-zA-Z0-9 ]+?$

Board Card Number

Example: 100500333
bookingNumber: string

Minimum Length: 1

Maximum Length: 100

Booking Number

Example: 123456789
diningDetails: object diningDetails

Dining Details
discountTemplate: object grDiscountTemplate

Discount Template
disembarkationDate: string(date)

Disembarkation Date

Example: 2018-11-11
disembarkationHarbor: object grDisembarkationHarbor

Disembarkation Harbor
disembarkationHarborComments: string

Maximum Length: 20

disembarkation harbor comments

Example: Going to the land
document: object document

Document
embarkationDate: string(date)

Embarkation Date

Example: 2018-11-11
embarkationHarbor: object embarkationHarbor

Embarkation Harbor
embarkationHarborComments: string

Maximum Length: 20

Embarkation harbor comments

Example: Going to the sea
isNoticeAndConsent: boolean

Acknowledge Notice and Consent

Example: true
lifeBoat: object lifeBoat

Life Boat
manifestPrintout: boolean

Manifest Printout

Example: false
musterStation: object grMusterStation

musterStation
numberOfCruiseDays: integer

Minimum Value: 0

Maximum Value: 99999999

Total Number Of Cruise Days

Example: 1
numberOfCruises: integer

Minimum Value: 0

Maximum Value: 99999999

Number Of Cruises

Example: 1
onboardEmail: string

Minimum Length: 1

Maximum Length: 72

Pattern: ^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$

Onboard Email Address * `null` if empty

Example: email@example.com
onboardStatus: boolean

onboardStatus

Example: false
otherParameter: object otherParameter

Other Parameters
profileInformation: object profileInformation

Profile Information
queueId: integer

Minimum Value: 0

Maximum Value: 99999999

Queue Id

Example: 11
reservationId: number

Minimum Length: 1

Pattern: ^[0-9]*$

Reservation Id

Example: 1001
reservationStatus: string

Reservation Status, RR=Reservation, RX=Cancelled, RE=Embark today, RN=No Show, CC=Checked In, CL=Leaving today, DD=Disembarked

Example: CC
setSailPassNumber: string

Minimum Length: 1

Maximum Length: 30

Set Sail Pass Number

Example: 3388
shoreGId: string

Minimum Length: 1

Maximum Length: 50

Shore G Id

Example: G1
shoreResId: string

Minimum Length: 1

Maximum Length: 15

Shore Reservation Id

Example: S1
stateroomNumber: string

Minimum Length: 1

Maximum Length: 20

stateroomNumber

Example: 1001

{
    "description":"Guest Reservation GET Object",
    "type":"object",
    "properties":{
        "reservationId":{
            "$ref":"#/definitions/reservationId"
        },
        "reservationStatus":{
            "$ref":"#/definitions/reservationStatus"
        },
        "embarkationDate":{
            "$ref":"#/definitions/grEmbarkationDate"
        },
        "embarkationHarbor":{
            "$ref":"#/definitions/embarkationHarbor"
        },
        "embarkationHarborComments":{
            "$ref":"#/definitions/embarkationHarborComments"
        },
        "disembarkationDate":{
            "$ref":"#/definitions/grDisembarkationDate"
        },
        "disembarkationHarbor":{
            "$ref":"#/definitions/grDisembarkationHarbor"
        },
        "disembarkationHarborComments":{
            "$ref":"#/definitions/disembarkationHarborComments"
        },
        "bookingNumber":{
            "$ref":"#/definitions/grBookingNumber"
        },
        "stateroomNumber":{
            "$ref":"#/definitions/grStateroomNumber"
        },
        "boardCardNumber":{
            "$ref":"#/definitions/grBoardCardNumber"
        },
        "setSailPassNumber":{
            "$ref":"#/definitions/setSailPassNumber"
        },
        "musterStation":{
            "$ref":"#/definitions/grMusterStation"
        },
        "onboardStatus":{
            "$ref":"#/definitions/grOnboardStatus"
        },
        "manifestPrintout":{
            "$ref":"#/definitions/manifestPrintout"
        },
        "document":{
            "$ref":"#/definitions/document"
        },
        "lifeBoat":{
            "$ref":"#/definitions/lifeBoat"
        },
        "shoreGId":{
            "$ref":"#/definitions/shoreGId"
        },
        "queueId":{
            "$ref":"#/definitions/queueId"
        },
        "onboardEmail":{
            "$ref":"#/definitions/onboardEmail"
        },
        "numberOfCruiseDays":{
            "$ref":"#/definitions/numberOfCruiseDays"
        },
        "numberOfCruises":{
            "$ref":"#/definitions/numberOfCruises"
        },
        "discountTemplate":{
            "$ref":"#/definitions/grDiscountTemplate"
        },
        "shoreResId":{
            "$ref":"#/definitions/shoreResId"
        },
        "otherParameter":{
            "$ref":"#/definitions/otherParameter"
        },
        "isNoticeAndConsent":{
            "$ref":"#/definitions/isNoticeAndConsent"
        },
        "profileInformation":{
            "$ref":"#/definitions/profileInformation"
        },
        "diningDetails":{
            "$ref":"#/definitions/diningDetails"
        },
        "agentDetails":{
            "$ref":"#/definitions/agentDetails"
        }
    }
}

Nested Schema : agentDetails

Type: object

Agent Details

Show Source

agentBookingId: string

Minimum Length: 0

Maximum Length: 20

Agent Booking Id

Example: A123
agentId: string

Minimum Length: 0

Maximum Length: 20

Agent Id

Example: A123
agentReferenceId: string

Minimum Length: 0

Maximum Length: 20

Agent Reference Id

Example: A123

{
    "description":"Agent Details",
    "type":"object",
    "properties":{
        "agentId":{
            "$ref":"#/definitions/agentId"
        },
        "agentReferenceId":{
            "$ref":"#/definitions/agentReferenceId"
        },
        "agentBookingId":{
            "$ref":"#/definitions/agentBookingId"
        }
    }
}

Nested Schema : diningDetails

Type: object

Dining Details

Show Source

otherSeating: string

Minimum Length: 0

Maximum Length: 50

Other Seating

Example: A123
referenceTableId: number

Minimum Value: 0

Reference Table Id

Example: 123
restaurantSeating: string

Minimum Length: 0

Maximum Length: 10

Restaurant Seating

Example: A123
tableAssignment: string

Minimum Length: 0

Maximum Length: 3

Table Assignment

Example: A123

{
    "description":"Dining Details",
    "type":"object",
    "properties":{
        "referenceTableId":{
            "$ref":"#/definitions/referenceTableId"
        },
        "restaurantSeating":{
            "$ref":"#/definitions/restaurantSeating"
        },
        "otherSeating":{
            "$ref":"#/definitions/otherSeating"
        },
        "tableAssignment":{
            "$ref":"#/definitions/tableAssignment"
        }
    }
}

Nested Schema : grDiscountTemplate

Type: object

Discount Template

Show Source

code: string

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Discount Template Code

Example: A1
description: string

Discount Template Description

Example: Loyal Guest

{
    "description":"Discount Template",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/grDiscountTemplateCode"
        },
        "description":{
            "$ref":"#/definitions/grDiscountTemplateDescription"
        }
    }
}

Nested Schema : grDisembarkationHarbor

Type: object

Disembarkation Harbor

Show Source

code: string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Disembarkation Harbor Code

Example: D1
description: string

Disembarkation Harbor Code Description

Example: To Land

{
    "description":"Disembarkation Harbor",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/disembarkationHarborCode"
        },
        "description":{
            "$ref":"#/definitions/disembarkationHarborCodeDescription"
        }
    }
}

Nested Schema : document

Type: object

Document

Show Source

isDocumentChecked: boolean

Document Is Checked

Example: false
isDocumentCollected: boolean

Document Is Collect

Example: false

{
    "description":"Document",
    "type":"object",
    "properties":{
        "isDocumentChecked":{
            "$ref":"#/definitions/isDocumentChecked"
        },
        "isDocumentCollected":{
            "$ref":"#/definitions/isDocumentCollected"
        }
    }
}

Nested Schema : embarkationHarbor

Type: object

Embarkation Harbor

Show Source

code: string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Embarkation Harbor Code

Example: E1
description: string

Embarkation Harbor Code Description

Example: To Sea

{
    "description":"Embarkation Harbor",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/embarkationHarborCode"
        },
        "description":{
            "$ref":"#/definitions/embarkationHarborDescription"
        }
    }
}

Nested Schema : lifeBoat

Type: object

Life Boat

Show Source

code: string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Lifeboat Code

Example: L1
description: string

Lifeboat Code Description

Example: Guest Boat A

{
    "description":"Life Boat",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/lifeBoatCode"
        },
        "description":{
            "$ref":"#/definitions/lifeBoatCodeDescription"
        }
    }
}

Nested Schema : grMusterStation

Type: object

musterStation

Show Source

code: string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Musterstation Code

Example: M1
description: string

Musterstation Code Description

Example: Guest Deck 1

{
    "description":"musterStation",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/musterStationCode"
        },
        "description":{
            "$ref":"#/definitions/musterStationCodeDescription"
        }
    }
}

Nested Schema : otherParameter

Type: object

Other Parameters

Show Source

isAirSeaOperator: boolean

Is Air Sea Operator

Example: false
isChargeCheckedOutCalls: boolean

Is Charge For Checked Out Calls

Example: false
isCompleteOnlineForm: boolean

Is Complete Online Form

Example: false
isExpressCheckOut: boolean

Is Express Checkout

Example: false
isGroupLeader: boolean

Is Group Leader

Example: false
isKioskCheckInAllowed: boolean

Is Kiosk Check In Allowed

Example: false
isNonInclusiveGuestType: boolean

Is Non Inclusive Guest Type

Example: false
isResident: boolean

Is Resident

Example: false
isStayOvernightTour: boolean

Is Stay Overnight Tour

Example: false
isSwitchToCrewManifest: boolean

Is Switch To Crew Manifest

Example: false

{
    "description":"Other Parameters",
    "type":"object",
    "properties":{
        "isResident":{
            "$ref":"#/definitions/isResident"
        },
        "isAirSeaOperator":{
            "$ref":"#/definitions/isAirSeaOperator"
        },
        "isExpressCheckOut":{
            "$ref":"#/definitions/isExpressCheckOut"
        },
        "isGroupLeader":{
            "$ref":"#/definitions/isGroupLeader"
        },
        "isCompleteOnlineForm":{
            "$ref":"#/definitions/isCompleteOnlineForm"
        },
        "isNonInclusiveGuestType":{
            "$ref":"#/definitions/isNonInclusiveGuestType"
        },
        "isChargeCheckedOutCalls":{
            "$ref":"#/definitions/isChargeCheckedOutCalls"
        },
        "isSwitchToCrewManifest":{
            "$ref":"#/definitions/isSwitchToCrewManifest"
        },
        "isStayOvernightTour":{
            "$ref":"#/definitions/isStayOvernightTour"
        },
        "isKioskCheckInAllowed":{
            "$ref":"#/definitions/isKioskCheckInAllowed"
        }
    }
}

Nested Schema : profileInformation

Type: object

Profile Information

Show Source

birthPlace: string

Maximum Length: 50

Birth Place

Example: Kajang
dateOfBirth: string(ISO 8601 (YYYY-MM-DD))

Date Of Birth

Example: 1999-02-15
firstName: string

Minimum Length: 1

Maximum Length: 40

First Name

Example: Fabiana
gender: object grGender

Gender
guestCategories: array guestCategory
lastName: string

Minimum Length: 1

Maximum Length: 40

Last Name

Example: Carleo
maritalStatus: object maritalStatus

Marital Status
middleName: string

Minimum Length: 1

Maximum Length: 20

Middle Name * `null` if empty

Example: Alberto
nationalId: string

Minimum Length: 1

Maximum Length: 20

National Id

Example: 22A
nationality: object grNationalityStruct

Nationality
otherFirstName: string

Minimum Length: 1

Maximum Length: 80

Other First Name * `null` if empty

Example: Frost
otherLastName: string

Minimum Length: 1

Maximum Length: 100

Other Last Name * `null` if empty

Example: Francis
passportIssuedCountry: object grPassportIssuedCountry

Passport Issued Country
passportIssuedDate: string(ISO 8601)

Passport Issued Date

Example: 2009-10-31
passportIssuedExpiryDate: string(date)

Passport Issued Expiry Date

Example: 2018-11-11
passportIssuedPlace: string

Maximum Length: 50

Passport Issued Place

Example: Shah Alam
passportNumber: string

Minimum Length: 1

Maximum Length: 20

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Passport Number

Example: A145611
permanentResidentId: string

Maximum Length: 30

Permanent Resident

Example: P123
profileId: number

Minimum Length: 1

Pattern: ^[0-9]*$

Profile Id

Example: 12345
royaltyNumber: string

Maximum Length: 20

Royalty Number

Example: a1234
salutation: string

Minimum Length: 1

Maximum Length: 20

Salutation

Example: MR
title: string

Minimum Length: 1

Maximum Length: 20

Title

Example: MR
vip: object vip

VIP

{
    "description":"Profile Information",
    "type":"object",
    "properties":{
        "profileId":{
            "$ref":"#/definitions/grProfileId"
        },
        "lastName":{
            "$ref":"#/definitions/grLastName"
        },
        "firstName":{
            "$ref":"#/definitions/grFirstName"
        },
        "middleName":{
            "$ref":"#/definitions/grMiddleName"
        },
        "otherLastName":{
            "$ref":"#/definitions/grOtherLastName"
        },
        "otherFirstName":{
            "$ref":"#/definitions/grOtherFirstName"
        },
        "title":{
            "$ref":"#/definitions/grTitle"
        },
        "salutation":{
            "$ref":"#/definitions/grSalutation"
        },
        "gender":{
            "$ref":"#/definitions/grGender"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "nationality":{
            "$ref":"#/definitions/grNationalityStruct"
        },
        "nationalId":{
            "$ref":"#/definitions/grNationalId"
        },
        "birthPlace":{
            "$ref":"#/definitions/grBirthPlace"
        },
        "passportNumber":{
            "$ref":"#/definitions/grPassportNumber"
        },
        "passportIssuedDate":{
            "$ref":"#/definitions/passportIssuedDate"
        },
        "passportIssuedExpiryDate":{
            "$ref":"#/definitions/passportIssuedExpiryDate"
        },
        "passportIssuedCountry":{
            "$ref":"#/definitions/grPassportIssuedCountry"
        },
        "passportIssuedPlace":{
            "$ref":"#/definitions/passportIssuedPlace"
        },
        "vip":{
            "$ref":"#/definitions/vip"
        },
        "guestCategories":{
            "$ref":"#/definitions/guestCategory"
        },
        "permanentResidentId":{
            "$ref":"#/definitions/permanentResidentId"
        },
        "royaltyNumber":{
            "$ref":"#/definitions/grRoyaltyNumber"
        },
        "maritalStatus":{
            "$ref":"#/definitions/maritalStatus"
        }
    }
}

Nested Schema : grGender

Type: object

Gender

Show Source

code: string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Gender Code

Example: M
description: string

Gender Code Description

Example: Male

{
    "description":"Gender",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/grGenderCode"
        },
        "description":{
            "$ref":"#/definitions/genderCodeDescription"
        }
    }
}

Nested Schema : guestCategory

Type: array

Show Source

Array of: object guestCategoryGroup

Guest Category Group

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

Nested Schema : maritalStatus

Type: object

Marital Status

Show Source

code: string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Marital Status Code

Example: S
description: string

Marital Status Description

Example: Single

{
    "description":"Marital Status",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/maritalStatusCode"
        },
        "description":{
            "$ref":"#/definitions/maritalStatusDesc"
        }
    }
}

Nested Schema : grNationalityStruct

Type: object

Nationality

Show Source

code: string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Nationality Code

Example: MY
description: string

Nationality Code Description

Example: Malaysia

{
    "description":"Nationality",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/grNationalityCode"
        },
        "description":{
            "$ref":"#/definitions/nationalityCodeDescription"
        }
    }
}

Nested Schema : grPassportIssuedCountry

Type: object

Passport Issued Country

Show Source

code: string

Minimum Length: 1

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

Passport Issued Country Code

Example: MY
description: string

Passport Issued Country Code Description

Example: Malaysia

{
    "description":"Passport Issued Country",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/passportIssuedCountryCode"
        },
        "description":{
            "$ref":"#/definitions/passportIssuedCountryCodeDescription"
        }
    }
}

Nested Schema : vip

Type: object

VIP

Show Source

code: string

Maximum Length: 6

Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

VIP Code

Example: L1
description: string

VIP Code Description

Example: Minister

{
    "description":"VIP",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/grVipCode"
        },
        "description":{
            "$ref":"#/definitions/vipCodeDescription"
        }
    }
}

Nested Schema : guestCategoryGroup

Type: object

Guest Category Group

Show Source

code: string

Minimum Length: 1

Maximum Length: 6

Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

Guest Category Codes

Example: GC1
description: string

Guest Category Codes Description

Example: Couple

{
    "description":"Guest Category Group",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/guestCategoryCodes"
        },
        "description":{
            "$ref":"#/definitions/guestCategoryCodesDescription"
        }
    }
}

400 Response

Bad Request

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

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

Example:

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

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestReservationErrorResponse"
        }
    ],
    "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"
    }
}

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

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

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

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

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestReservationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Ship Id could not be found"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship Id could not be found"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestReservationErrorResponse"
        }
    ],
    "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"
    }
}

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

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestReservationErrorResponse"
        }
    ],
    "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"
    }
}

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

detail: string
title: string
type: string

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

409 Response

Conflict

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestReservationErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
        "title":"Conflict",
        "detail":"Update is not allowed for Guest that have checked out."
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
    "title":"Conflict",
    "detail":"Update is not allowed for Guest that have checked out."
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

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

415 Response

Unsupported Media Type

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestReservationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Invalid content",
        "detail":"Content type Not supported"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Invalid content",
    "detail":"Content type Not supported"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestReservationErrorResponse"
        }
    ],
    "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"
    }
}

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

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestReservationErrorResponse"
        }
    ],
    "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: string
title: string
type: string

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