Jump to

• Request
• Response

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: number
  Reservation Id
• shipId: integer
  ship Id

Body ()

Guest Reservation PUT Object

Root Schema : guestReservationPUTObject

Type: object

Guest Reservation PUT Object

Show Source

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

  Board Card Number

  Example: 100500333
• bookingNumber(optional): string
  Minimum Length: 1

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

  Booking Number

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

  Discount Template Code

  Example: A1
• disembarkationDate(optional): string(date)
  Disembarkation Date

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

  Disembarkation Harbor Code

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

  comments

  Example: Going to the land
• document(optional): object document
  Document
• embarkationDate(optional): string(date)
  Embarkation Date

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

  Embarkation Harbor Code

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

  comments

  Example: Going to the sea
• isNoticeAndConsent(optional): boolean
  Acknowledge Notice and Consent

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

  Lifeboat Code

  Example: L1
• manifestPrintOut(optional): boolean
  Manifest Printout

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

  Musterstation Code

  Example: M1
• numberOfCruiseDays(optional): number
  Pattern: ^[0-9]*$

  Total Number Of Cruise Days

  Example: 1
• numberOfCruises(optional): number
  Pattern: ^[0-9]*$

  Number Of Cruises

  Example: 1
• onboardEmail(optional): string
  Minimum Length: 1

  Maximum Length: 49

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

  Onboard Email Address * `null` if empty

  Example: [e-mail]
• onboardStatus(optional): boolean
  onboardStatus

  Example: false
• otherParameters(optional): object otherParameters
  Other Parameters
• profileInformation(optional): object profileInformationPOST
  Profile Information for Post
• queueId(optional): number
  Pattern: ^[0-9]*$

  Queue Id

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

  Set Sail Pass Number

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

  Shore G Id

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

  Shore Reservation Id

  Example: S1
• stateroomNumber(optional): string
  Minimum Length: 1

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

  stateroomNumber

  Example: 1001

{
    "description":"Guest Reservation PUT Object",
    "type":"object",
    "properties":{
        "embarkationDate":{
            "$ref":"#/definitions/embarkationDate"
        },
        "embarkationHarborCode":{
            "$ref":"#/definitions/embarkationHarborCode"
        },
        "embarkationHarborComments":{
            "$ref":"#/definitions/embarkationHarborComments"
        },
        "disembarkationDate":{
            "$ref":"#/definitions/disembarkationDate"
        },
        "disembarkationHarborCode":{
            "$ref":"#/definitions/disembarkationHarborCode"
        },
        "disembarkationHarborComments":{
            "$ref":"#/definitions/disembarkationHarborComments"
        },
        "bookingNumber":{
            "$ref":"#/definitions/bookingNumber"
        },
        "stateroomNumber":{
            "$ref":"#/definitions/stateroomNumber"
        },
        "boardCardNumber":{
            "$ref":"#/definitions/boardCardNumber"
        },
        "setSailPassNumber":{
            "$ref":"#/definitions/setSailPassNumber"
        },
        "musterStationCode":{
            "$ref":"#/definitions/musterStationCode"
        },
        "onboardStatus":{
            "$ref":"#/definitions/onboardStatus"
        },
        "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/discountTemplateCode"
        },
        "shoreResId":{
            "$ref":"#/definitions/shoreResId"
        },
        "otherParameters":{
            "$ref":"#/definitions/otherParameters"
        },
        "isNoticeAndConsent":{
            "$ref":"#/definitions/isNoticeAndConsent"
        },
        "profileInformation":{
            "$ref":"#/definitions/profileInformationPOST"
        }
    }
}

Nested Schema : document

Type: object

Document

Show Source

• isDocumentChecked(optional): boolean
  Document Is Checked

  Example: false
• isDocumentCollected(optional): boolean
  Document Is Collect

  Example: false

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

Nested Schema : otherParameters

Type: object

Other Parameters

Show Source

• isAirSeaOperator(optional): boolean
  Is Air Sea Operator

  Example: false
• isChargeCheckedOutCalls(optional): boolean
  Is Charge For Checked Out Calls

  Example: false
• isCompleteOnlineForm(optional): boolean
  Is Complete Online Form

  Example: false
• isExpressCheckOut(optional): boolean
  Is Express Checkout

  Example: false
• isGroupLeader(optional): boolean
  Is Group Leader

  Example: false
• isKioskCheckInAllowed(optional): boolean
  Is Kiosk Check In Allowed

  Example: false
• isNonInclusiveGuestType(optional): boolean
  Is Non Inclusive Guest Type

  Example: false
• isResident(optional): boolean
  Is Resident

  Example: false
• isStayOvernightTour(optional): boolean
  Is Stay Overnight Tour

  Example: false
• isSwitchToCrewManifest(optional): 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(optional): string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Birth Place

  Example: Kajang
• dateOfBirth(optional): string(date)
  Birth Date

  Example: 2018-11-11
• firstName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: [a-z]

  First Name

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

  Gender Code

  Example: M
• guestCategoryCodes(optional): array guestCategoryPOST
• lastName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: [a-z]

  Last Name

  Example: Carleo
• middleName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: [a-z]

  Middle Name

  Example: Alberto
• nationalId(optional): string
  Minimum Length: 1

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

  National Id

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

  Nationality Code

  Example: MY
• otherFirstName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: [a-z]

  Other First Name

  Example: Frost
• otherLastName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: [a-z]

  Other Last Name

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

  Passport Issued Country Code

  Example: MY
• passportIssuedDate(optional): string(date)
  Passport Issued Date

  Example: 2018-11-11
• passportIssuedExpiryDate(optional): string(date)
  Passport Issued Expiry Date

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

  Passport Issued Place

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

  Passport Number

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

  Permanent Resident

  Example: P123
• salutation(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: [a-z]

  Salutation

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

  VIP Code

  Example: V1

{
    "description":"Profile Information for Post",
    "type":"object",
    "properties":{
        "lastName":{
            "$ref":"#/definitions/lastName"
        },
        "firstName":{
            "$ref":"#/definitions/firstName"
        },
        "middleName":{
            "$ref":"#/definitions/middleName"
        },
        "otherLastName":{
            "$ref":"#/definitions/otherLastName"
        },
        "otherFirstName":{
            "$ref":"#/definitions/otherFirstName"
        },
        "salutation":{
            "$ref":"#/definitions/salutation"
        },
        "genderCode":{
            "$ref":"#/definitions/genderCode"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "nationalityCode":{
            "$ref":"#/definitions/nationalityCode"
        },
        "nationalId":{
            "$ref":"#/definitions/nationalId"
        },
        "birthPlace":{
            "$ref":"#/definitions/birthPlace"
        },
        "passportNumber":{
            "$ref":"#/definitions/passportNumber"
        },
        "passportIssuedDate":{
            "$ref":"#/definitions/passportIssuedDate"
        },
        "passportIssuedExpiryDate":{
            "$ref":"#/definitions/passportIssuedExpiryDate"
        },
        "passportIssuedCountryCode":{
            "$ref":"#/definitions/passportIssuedCountryCode"
        },
        "passportIssuedPlace":{
            "$ref":"#/definitions/passportIssuedPlace"
        },
        "vipCode":{
            "$ref":"#/definitions/vipCode"
        },
        "guestCategoryCodes":{
            "$ref":"#/definitions/guestCategoryPOST"
        },
        "permanentResidentId":{
            "$ref":"#/definitions/permanentResidentId"
        }
    }
}

Nested Schema : guestCategoryPOST

Type: array

Show Source

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

  Guest Category Codes

  Example: GC1

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Updated

Body ()

Root Schema : guestReservationGETObject

Type: object

Guest Reservation GET Object

Show Source

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

  Board Card Number

  Example: 100500333
• bookingNumber(optional): string
  Minimum Length: 1

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

  Booking Number

  Example: 123456789
• discountTemplate(optional): object discountTemplate
  Discount Template
• disembarkationDate(optional): string(date)
  Disembarkation Date

  Example: 2018-11-11
• disembarkationHarbor(optional): object disembarkationHarbor
  disembarkationHarbor
• disembarkationHarborComments(optional): string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  comments

  Example: Going to the land
• document(optional): object document
  Document
• embarkationDate(optional): string(date)
  Embarkation Date

  Example: 2018-11-11
• embarkationHarbor(optional): object embarkationHarbor
  Embarkation Harbor
• embarkationHarborComments(optional): string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  comments

  Example: Going to the sea
• isNoticeAndConsent(optional): boolean
  Acknowledge Notice and Consent

  Example: true
• lifeBoat(optional): object lifeBoat
  Life Boat
• manifestPrintOut(optional): boolean
  Manifest Printout

  Example: false
• musterStation(optional): object musterStation
  musterStation
• numberOfCruiseDays(optional): number
  Pattern: ^[0-9]*$

  Total Number Of Cruise Days

  Example: 1
• numberOfCruises(optional): number
  Pattern: ^[0-9]*$

  Number Of Cruises

  Example: 1
• onboardEmail(optional): string
  Minimum Length: 1

  Maximum Length: 49

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

  Onboard Email Address * `null` if empty

  Example: [e-mail]
• onboardStatus(optional): boolean
  onboardStatus

  Example: false
• otherParameters(optional): object otherParameters
  Other Parameters
• profileInformation(optional): object profileInformation
  Profile Information
• queueId(optional): number
  Pattern: ^[0-9]*$

  Queue Id

  Example: 11
• reservationId(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Reservation Id

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

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

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

  Set Sail Pass Number

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

  Shore G Id

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

  Shore Reservation Id

  Example: S1
• stateroomNumber(optional): string
  Minimum Length: 1

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

  stateroomNumber

  Example: 1001

{
    "description":"Guest Reservation GET Object",
    "type":"object",
    "properties":{
        "reservationId":{
            "$ref":"#/definitions/reservationId"
        },
        "reservationStatus":{
            "$ref":"#/definitions/reservationStatus"
        },
        "embarkationDate":{
            "$ref":"#/definitions/embarkationDate"
        },
        "embarkationHarbor":{
            "$ref":"#/definitions/embarkationHarbor"
        },
        "embarkationHarborComments":{
            "$ref":"#/definitions/embarkationHarborComments"
        },
        "disembarkationDate":{
            "$ref":"#/definitions/disembarkationDate"
        },
        "disembarkationHarbor":{
            "$ref":"#/definitions/disembarkationHarbor"
        },
        "disembarkationHarborComments":{
            "$ref":"#/definitions/disembarkationHarborComments"
        },
        "bookingNumber":{
            "$ref":"#/definitions/bookingNumber"
        },
        "stateroomNumber":{
            "$ref":"#/definitions/stateroomNumber"
        },
        "boardCardNumber":{
            "$ref":"#/definitions/boardCardNumber"
        },
        "setSailPassNumber":{
            "$ref":"#/definitions/setSailPassNumber"
        },
        "musterStation":{
            "$ref":"#/definitions/musterStation"
        },
        "onboardStatus":{
            "$ref":"#/definitions/onboardStatus"
        },
        "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/discountTemplate"
        },
        "shoreResId":{
            "$ref":"#/definitions/shoreResId"
        },
        "otherParameters":{
            "$ref":"#/definitions/otherParameters"
        },
        "isNoticeAndConsent":{
            "$ref":"#/definitions/isNoticeAndConsent"
        },
        "profileInformation":{
            "$ref":"#/definitions/profileInformation"
        }
    }
}

Nested Schema : discountTemplate

Type: object

Discount Template

Show Source

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

  Discount Template Code

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

  Discount Template Code Description

  Example: Loyal Guest

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

Nested Schema : disembarkationHarbor

Type: object

disembarkationHarbor

Show Source

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

  Disembarkation Harbor Code

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

  Disembarkation Harbor Code Description

  Example: To Land

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

Nested Schema : document

Type: object

Document

Show Source

• isDocumentChecked(optional): boolean
  Document Is Checked

  Example: false
• isDocumentCollected(optional): 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(optional): string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Embarkation Harbor Code

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

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

  Lifeboat Code

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

  Lifeboat Code Description

  Example: Guest Boat A

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

Nested Schema : musterStation

Type: object

musterStation

Show Source

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

  Musterstation Code

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

  Musterstation Code Description

  Example: Guest Deck 1

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

Nested Schema : otherParameters

Type: object

Other Parameters

Show Source

• isAirSeaOperator(optional): boolean
  Is Air Sea Operator

  Example: false
• isChargeCheckedOutCalls(optional): boolean
  Is Charge For Checked Out Calls

  Example: false
• isCompleteOnlineForm(optional): boolean
  Is Complete Online Form

  Example: false
• isExpressCheckOut(optional): boolean
  Is Express Checkout

  Example: false
• isGroupLeader(optional): boolean
  Is Group Leader

  Example: false
• isKioskCheckInAllowed(optional): boolean
  Is Kiosk Check In Allowed

  Example: false
• isNonInclusiveGuestType(optional): boolean
  Is Non Inclusive Guest Type

  Example: false
• isResident(optional): boolean
  Is Resident

  Example: false
• isStayOvernightTour(optional): boolean
  Is Stay Overnight Tour

  Example: false
• isSwitchToCrewManifest(optional): 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(optional): string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Birth Place

  Example: Kajang
• dateOfBirth(optional): string(date)
  Birth Date

  Example: 2018-11-11
• firstName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: [a-z]

  First Name

  Example: Fabiana
• gender(optional): object gender
  Gender
• guestCategories(optional): array guestCategory
• lastName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: [a-z]

  Last Name

  Example: Carleo
• middleName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: [a-z]

  Middle Name

  Example: Alberto
• nationalId(optional): string
  Minimum Length: 1

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

  National Id

  Example: 22
• nationality(optional): object nationality
  Nationality
• otherFirstName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: [a-z]

  Other First Name

  Example: Frost
• otherLastName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: [a-z]

  Other Last Name

  Example: Francis
• passportIssuedCountry(optional): object passportIssuedCountry
  Passport Issued Country
• passportIssuedDate(optional): string(date)
  Passport Issued Date

  Example: 2018-11-11
• passportIssuedExpiryDate(optional): string(date)
  Passport Issued Expiry Date

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

  Passport Issued Place

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

  Passport Number

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

  Permanent Resident

  Example: P123
• profileId(optional): integer
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Profile ID

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

  Maximum Length: 20

  Pattern: [a-z]

  Salutation

  Example: MR
• vip(optional): object vip
  VIP

{
    "description":"Profile Information",
    "type":"object",
    "properties":{
        "profileId":{
            "$ref":"#/definitions/profileId"
        },
        "lastName":{
            "$ref":"#/definitions/lastName"
        },
        "firstName":{
            "$ref":"#/definitions/firstName"
        },
        "middleName":{
            "$ref":"#/definitions/middleName"
        },
        "otherLastName":{
            "$ref":"#/definitions/otherLastName"
        },
        "otherFirstName":{
            "$ref":"#/definitions/otherFirstName"
        },
        "salutation":{
            "$ref":"#/definitions/salutation"
        },
        "gender":{
            "$ref":"#/definitions/gender"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "nationality":{
            "$ref":"#/definitions/nationality"
        },
        "nationalId":{
            "$ref":"#/definitions/nationalId"
        },
        "birthPlace":{
            "$ref":"#/definitions/birthPlace"
        },
        "passportNumber":{
            "$ref":"#/definitions/passportNumber"
        },
        "passportIssuedDate":{
            "$ref":"#/definitions/passportIssuedDate"
        },
        "passportIssuedExpiryDate":{
            "$ref":"#/definitions/passportIssuedExpiryDate"
        },
        "passportIssuedCountry":{
            "$ref":"#/definitions/passportIssuedCountry"
        },
        "passportIssuedPlace":{
            "$ref":"#/definitions/passportIssuedPlace"
        },
        "vip":{
            "$ref":"#/definitions/vip"
        },
        "guestCategories":{
            "$ref":"#/definitions/guestCategory"
        },
        "permanentResidentId":{
            "$ref":"#/definitions/permanentResidentId"
        }
    }
}

Nested Schema : gender

Type: object

Gender

Show Source

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

  Gender Code

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

  Gender Code Description

  Example: Male

{
    "description":"Gender",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/genderCode"
        },
        "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 : nationality

Type: object

Nationality

Show Source

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

  Nationality Code

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

  Nationality Code Description

  Example: Malaysia

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

Nested Schema : passportIssuedCountry

Type: object

Passport Issued Country

Show Source

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

  Passport Issued Country Code

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

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

  VIP Code

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

  VIP Code Description

  Example: Minister

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

Nested Schema : guestCategoryGroup

Type: object

Guest Category Group

Show Source

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

  Guest Category Codes

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

  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

Body ()

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

409 Response

Conflict

Body ()

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

415 Response

Unsupported Media Type

Body ()

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(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/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(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/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(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