Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Authenticate
• Send Requests
• Test
• Use Cases
  • Find Guardian of a Minor
• Reference
  • Status Codes

Tasks

• Authentication
  • Generate OAuth token
  • Invalidate OAuth token
  • Register Client Application
  • Retrieve an application key
  • Retrieve login user details
• Configurations
  • Retrieve the settings to enable auto-balance settlement validation
  • Retrieve the settings to enable balance check validation
  • Retrieve the settings to enable document returned validation
  • Account Categories
    • Create a new Account Category record
    • Delete existing Account Category record
    • Retrieve configured Account Category records
    • Update existing Account Category record
  • Address State Code
    • Retrieve configured Address State code records
  • Amenity Code
    • Create a new amenity code record
    • Delete existing amenity code record
    • Retrieve configured amenity code records
    • Update existing amenity code record
  • Check minor going ashore authorization
    • Retrieve the settings for minor going ashore authorization
    • Update the settings for minor going ashore authorization
  • Check travel document returned
    • Retrieve the setting for check travel document returned
  • Crew Operational Divisions
    • Create Crew Operational Divisions Records
    • Delete Crew Operational Divisions Records
    • Retrieve configured Crew Operational Divisions Records
    • Update Crew Operational Divisions Records
  • Crew Privilege Level Codes
    • Retrieve configured Crew Privilege Level Code
  • Crew secondary Sign-Off Reason
    • Retrieve configured Crew Secondary Sign-Off Reason code records
  • Crew Sign-Off Reason
    • Retrieve configured Crew Sign Off reasons
  • Crew Sign-On Reason
    • Retrieve configured Crew Sign-On Reason code records
  • Currency Exchange
    • Retrieve configured currency exchange
  • Database server current date and time
    • Retrieve the Database server current date and time
  • Decks
    • Retrieve configured deck code records
  • Discount Template
    • Retrieve Configured Discount Template record
  • Excluded harbors for minor going ashore authorization
    • Retrieve the settings for excluded harbors for minor going ashore authorization
    • Update the settings for excluded harbors for minor going ashore authorization
  • Gangway auto check out
    • Retrieve the settings for gangway auto check out for a reservation
  • GatewaySecurityRules
    • Retrieve a list of all gateway security rules
  • Guest Categories
    • Create a new guest category
    • Delete a guest category
    • Retrieve a list of guest categories
    • Update a guest category
  • Guest Comment Assigned Department
    • Retrieve configured Guest Comment Assigned Department records
  • Guest Comment Category
    • Retrieve configured Guest Comment Category records
  • Guest Comment Report Type
    • Retrieve configured Guest Comment Report Type records
  • Guest Comment Resolution Type
    • Retrieve configured Guest Comment Resolution Type records
  • Guest Comment Types
    • Retrieve configured guest comment type records
  • Language Template
    • Create a new Language Template
    • Delete a Language Template
    • Retrieve list of language templates
    • Update Language Template
  • Lifeboats
    • Create a new Lifeboat record
    • Delete existing Lifeboat record
    • Retrieve configured Lifeboats
    • Update existing Lifeboat code record
  • Locations
    • Retrieve list of all public locations
  • Marital Status Code
    • Create a new Marital Status code record
    • Delete existing Marital Status code record
    • Retrieve configured Marital Status code records
    • Update existing Marital Status code record
  • Minimum age as adult
    • Retrieve the settings for minimum age as adult
  • MusterStations
    • Retrieve configured muster stations
  • Nationality Group
    • Create a new Nationality Group
    • Delete Nationality Group
    • Retrieve list of enabled Nationality Groups
    • Retrieve list of Nationality Groups
    • Retrieve Nationality Groups by code
    • Update Nationality Group
  • Notice and Consent by Nationality Code parameter
    • Retrieve the Notice and Consent by Nationality Code parameter
  • Onboard status settings after checked-in
    • Retrieve the settings for onboard status after checked-in
  • Operational Position
    • Retrieve configured Operational Position code records
  • OPI
    • Retrieve OPI configurations in SPMS
    • Update OPI configurations in SPMS
  • Passport Reading Access Information
    • Retrieve Passport Reading access information and token
  • Preferred Languages
    • Retrieve language records
  • Profile Types
    • Retrieve list of profile types
  • Safety Modes
    • Retrieve configured safety modes
  • Ship information
    • Retrieve ship information for the current login user
  • Ship name
    • Retrieve the Ship name
  • Ship Vertical Zones
    • Retrieve configured ship vertical zones
  • Special Request Action Code
    • Create a special requests action code record
    • Delete existing special requests action code
    • Retrieve special requests action code record
    • Update an existing special requests action code by action code
  • Stateroom Categories
    • Retrieve configured stateroom category records
  • Stateroom Status
    • Retrieve configured Stateroom Status records
  • Staterooms
    • Retrieve list of all staterooms
    • Retrieve the stateroom configuration with criterias.
  • System Date and Time Format
    • Retrieve the date and time display formats applicable for the system
    • Update the date and time display formats applicable for the system
  • System Date, Time and Time Zone Format
    • Retrieve configured system date, time and time zone format
  • Travel Document Scanner
    • Retrieve Travel Document Scanner configurations in SPMS
    • Update Travel Document Scanner configurations in SPMS
  • Travel Documents Rules
    • Create travel document rule
    • Delete Travel Document Rule By Id
    • Edit travel document rule by id
    • Retrieve list of travel document rules
    • Retrieve travel document rule by id
  • Use Resident Handling
    • Retrieve the settings of Use Resident handling
  • Vendor
    • Retrieve configured vendor record
  • VIP Code
    • Create a new reservation VIP code record
    • Delete an existing reservation VIP code record
    • Retrieve configured reservation VIP code records
    • Update an existing reservation VIP code record
• Contract
  • Configuration
    • Contract
      • Create/ Add a new contract
      • Remove/ Delete a Contract
      • Retrieve a contract
      • Retrieve all available contracts with enabled status
      • Retrieve list of contracts
      • Update a contract
    • Contract Category
      • Create/ Add a new contract category
      • Remove/ Delete a contract category
      • Retrieve a contract category
      • Retrieve list of contract categories
      • Update a contract category
  • Contract Acknowledgement
    • Create/ Add an acknowledged contract to a profile
    • Retrieve a list of acknowledged contracts
    • Retrieve an acknowledged contract for a profile and a contract
    • Retrieve the acknowledged contracts for a profile
    • Update an acknowledged contract to a profile
• Cruise
  • Itinerary
    • Retrieve Cruise Itineraries
    • Current Cruise
      • Retrieve Current Cruise Itineraries
• Excursions
  • Bookable Tours
    • Create a new bookable tour
    • Create a new fixed cost for the bookable tour
    • Create a new group linking for the bookable tour
    • Create a new package linking for the bookable tour
    • Create a new variable cost for the bookable tour
    • Create a new VAT posting split for the bookable tour
    • Create a new vendor for the bookable tour
    • Delete a bookable tour group linking
    • Delete a bookable tour package linking
    • Delete a bookable tour that is not being used
    • Delete a bookable tour variable cost
    • Delete a bookable tour VAT posting split
    • Delete a fixed cost from a bookable tour
    • Delete a vendor from a bookable tour
    • Retrieve a list of bookable tours
    • Retrieve bookable tour general settings
    • Update a bookable tour details
    • Update bookable tour general settings
    • Update bookable tour interfaces
    • Update customized field values for the bookable tour
    • Update fixed costs for the bookable tour
    • Update group linkings for the bookable tour
    • Update package linkings for the bookable tour
    • Update sales for the bookable tour
    • Update transfer tours for the bookable tour
    • Update variable costs for the bookable tour
    • Update vendors for the bookable tour
  • Void Bookings
    • Void excursion bookings by booking id
• Financials
  • Configuration
    • Main Department
      • Retrieve configured Main Department record.
    • Main Department Credits
      • Retrieve configured main department record.
    • Main Department Debits
      • Retrieve configured main department record.
    • Sub Department Credits
      • Retrieve configured sub department record.
    • Sub Department Debits
      • Retrieve configured sub department record.
    • Sub Departments
      • Retrieve configured Sub Department record.
  • Direct Sales
    • Create a new direct credit card sales payment
  • Invoice Add Posting
    • Create new posting transaction from Simphony/POS
  • Invoice Posting
    • Create new financial posting entry
  • Payment
    • Create new payment posting
• Gateway Security
  • Activities
    • Retrieve the gateway security activities with criterias.
  • Configuration
    • Retrieve check-in settings for the gangway only
    • Retrieve the check-in settings at the gangway
    • Retrieve the settings for required visa check at gangway
    • Update check-in settings for the gangway only
    • Update the check-in settings at the gangway
    • Update the settings for required visa check at gangway
    • Audios
      • Retrieve a list of gateway security audios
      • Update a gateway security sound
    • Gangway customized messages
      • Retrieve list of all gangway customized messages
    • Gangway movements
      • Retrieve list of all gangway movements
      • Retrieve list of all gangway movements by gateway type
    • Gate locations
      • Create/ Add new gate location.
      • Delete the gate location details.
      • Retrieve a gate location by code
      • Retrieve list of all gate locations
      • Update a gate location details by code.
    • Gateway traffic direction
      • Retrieve list of gateway traffic directions
    • Gateway types
      • Retrieve list of all gateway types
    • Security alert sounds
      • Create/ Add a security alert sound
      • Remove/ Delete a security alert sound by ID
      • Retrieve a security alert sound by ID
      • Retrieve and playback a security alert sound by ID
      • Retrieve list of all security alert sounds
      • Update details for a security alert sound by ID
    • Security Alerts
      • Retrieve a gangway security alert by ID
      • Retrieve list of all gangway security alerts
      • Update a gangway security alert
    • Special needs
      • Create/ add a new special needs
      • Remove/ Delete a special needs by code
      • Retrieve a list of all special needs
      • Retrieve a special needs by code
      • Retrieve list of all enabled special needs
      • Update a special needs record by code
  • Confiscated Temporary Returned Items
    • Edit a list of Confiscated Items details
    • Retrieve a list of confiscated items
  • Gangway
    • Create a new gangway activity movement
    • Validate gangway coming onboard rules
    • Validate gangway going ashore rules
    • Activities
      • Create/ Add gangway activities for a profile
      • Retrieve list of gangway activities by parameters
      • Retrieve list of gangway activities for a profile
      • Retrieve list of recent gangway activities
    • Movements
      • Create/ Add gangway activities with movement
  • Gangway Count
    • Get the count for 'Checked-In' reservation status for profile type
    • Get the count for 'Disembarked' reservation status for profile type
    • Get the count for 'Disembarking' (leaving today) reservation status for profile type
    • Get the count for 'Expected Today' reservation status for profile type
    • Get the count for staying overnight for tour based on profile type
    • Get the count of 'Expected' reservation status for profile type
    • Get the onboard count based on profile type
    • Gets the ashore count based on profile type
  • Gate
    • Create a location selection history
  • Internal Gate
    • Create a new internal gate activity movement
    • Delete a list of participants of the location
    • Validate internal location rules
  • Tender Boat
    • Create a new tender boat activity movement
    • Create a tender boat details
    • Create the opened tender boat gateway details
    • Delete the tender boat details
    • Edit the tender boat details
    • Remove an existing tenderboat gateway user
    • Retrieve a list of tender boat details
    • Retrieve the active tender boat count at the tender boat gateway
    • Retrieve the opened tenderboat gateway details
    • Update the opened tender boat gateway details
    • Validate gangway tender boat coming onboard rules
    • Validate gangway tender boat going ashore rules
  • Validations
    • Gangway
      • Validate and display customized messages for a profile coming onboard
      • Validate and display customized messages for a profile going ashore
    • Gangway security alerts
      • Validate gangway movement against configured security alerts
    • Shore leave denied
      • Validate shore leave denied status for a profile
    • Visa check
      • Retrieve list of all visa requirements
• Interfaces
  • Credit Card Terminal
    • Create/ Add credit card terminal record
    • Delete a credit card terminal record
    • Retrieve a credit card terminal record
    • Retrieve a list of all credit card terminal records
    • Update a credit card terminal record
• Mobile Check-In Wizard
  • Profile Search Template
    • Create/ Add a new profile search template
    • Create/ Add new profile search configuration field
    • Delete the profile search template by ID
    • Retrieve a profile search fields excluded from search filter or results
    • Retrieve a profile search template
    • Retrieve a profile search template field by Id
    • Retrieve list of all profile search templates
    • Retrieve list of profile search template fields
    • Retrieve list of profile search template reservation status
    • Retrieve list of profile search template reservation status
    • Retrieve list of Profile Search template reservation status by ID
    • Update a profile search template record
  • Profile Template
    • Create/ Add a new profile template
    • Create/ Add a new profile template header
    • Remove/ Delete a profile template
    • Remove/ Delete a profile template header
    • Retrieve a profile template
    • Retrieve a profile template header
    • Retrieves list of all profile template headers
    • Retrieves list of profile templates
    • Update a profile template
    • Update a profile template header
    • Update a profile template record
  • Step Templates
    • Create/ Add a new step for wizard template
    • Remove/ Delete a step for a wizard template
    • Retrieve a step for a wizard template
    • Retrieve list of all steps for wizard template
    • Update a step for a wizard template
  • Wizard Templates
    • Create/ Add a new wizard template
    • Remove/ Delete a wizard template
    • Retrieve a wizard template
    • Retrieve lists of all enabled wizard templates
    • Retrieve lists of all wizard templates
    • Update a wizard template record
• Mustering
  • Create an attendance
  • Delete a list of attendances based on lifeboat
  • Delete a list of attendances based on muster station
  • Delete a list of attendances based on safety mode
  • Delete an attendance
  • Retrieve a list of active mustering access rights for each active user group
  • Retrieve a list of active mustering user details
  • Retrieve all the active lifeboats count per safety mode
  • Retrieve all the active muster station count per safety mode
  • Retrieve attendances list
  • Retrieve the active lifeboat count
  • Retrieve the active muster station count
  • Retrieve the active ship vertical zone count
  • Retrieve the safety settings
  • Sync a register attendance record
  • Sync an unregister attendance record
  • Update the safety settings
• Profiles
  • Analytics
    • Retrieve list of the status count
    • Retrieve the count of sailing persons based on profile type
    • Adults
      • Retrieve the count for adults based on profile type and reservation status
    • Minors
      • Retrieve the count for minors based on profile type and reservation status
    • Profile Type
      • Count
        • Retrieve the count based on profile type and reservation status
    • Vip Guests
      • Retrieve the VIP guest count
    • Visitors
      • Generic
        • Retrieve the counts for Generic Visitors
      • named
        • Retrieve the counts for Named Visitors
  • Billing Addresses
    • Create new guest billing address by Profile ID
    • Delete guest billing address by Profile ID
    • Retrieve guest billing address by Profile ID
    • Update guest billing address by Profile ID
  • Credit card information
    • Retrieve list of active credit cards for a profile
  • Crew Profile
    • Retrieve a crew profile by profile Id
    • Update a crew profile by profile Id
  • Emergency Contact Addresses
    • Create new guest emergency contact address by Profile ID
    • Retrieve guest emergency contact address by profile ID
    • Update guest emergency contact address by Profile ID
  • Guest Profile
    • Retrieve a guest profile by guest Id
    • Update a guest or resident profile by guest Id
  • Home Addresses
    • Create new guest home address by Profile ID
    • Retrieve guest home address by profile ID
    • Update guest home address by Profile ID
  • Other Travel Documents
    • Delete profile other travel document details.
    • Insert profile other travel document details.
    • Retrieve list of all other travel documents for a guest
    • Retrieve profile other travel document details.
    • Retrieves list of all other travel documents for a crew
    • Retrieves list of all other travel documents for a resident
    • Retrieves list of all other travel documents for a visitor
    • Update profile other travel document details.
  • Profile Information
    • Create a profile photo
    • Retrieve a crew profile
    • Retrieve a guest profile
    • Retrieve a profile photo
    • Retrieve a resident profile
    • Retrieve a visitor profile
    • Retrieve crew profile with criteria search
    • Retrieve guests profile with criteria search
    • Retrieve list of adult from search results
    • Retrieve profile details for a guardian associated to a minor
    • Retrieve visitor profile with criteria search
    • Update a profile photo
    • Update guest profile details
  • Special needs assignment
    • Retrieve list of special needs assignments for a profile
    • Retrieve list of special needs assignments for a profile by profile type
    • Update special needs assignments for a profile
    • Update special needs assignments for a profile by profile type
  • Temporary Addresses
    • Create a new guest temporary address by profile ID
    • Retrieve guest temporary address by profile ID
    • Update guest temporary address by profile ID
• Questionnaire
  • Acknowledgement
    • Retrieve Questionnaire Acknowledgement by Profile Id
    • Retrieve Questionnaire Acknowledgement by Reservation Id
    • Retrieve Specified Questionnaire Acknowledgement by Profile Id and Template Id
    • Save a Questionnaire Acknowledgement by Reservation Id and Template Id
  • Authorization Reason
    • Create Questionnaire Authorization Reasons
    • Delete Questionnaire Authorization Reason by Id
    • Delete Questionnaire Authorization Reasons by reservation Id and template id
    • Retrieve Questionnaire Authorization Reasons
    • Update Questionnaire Authorization Reason by Id
  • Authorize Reason Setup
    • Create questionnaire authorize reason
    • Delete Questionnaire Authorize Reason
    • Retrieve questionnaire authorize reason
    • Retrieve questionnaire authorize reasons
    • Update questionnaire authorize reason
  • Questionnaire Acknowledgement
    • Create questionnaire acknowledgement by template id
    • Delete Questionnaire Acknowledgement
    • Retrieve questionnaire acknowledgement by template id
    • Update Questionnaire Acknowledgement
  • Questionnaire Category
    • Create new Questionnaire Category
    • Delete Questionnaire Category
    • Retrieve a questionnaire category by ID
    • Retrieve the list of Questionnaire Categories
    • Update Questionnaire Category
  • Questionnaire Groups
    • Create a new Question Group
    • Delete a Question Group
    • Retrieve a Question Group based on Id
    • Retrieve list of Question Group based on Template Id
    • Update a Question group
  • Questionnaire Questions
    • Create new questions by question group id
    • Delete a question by question id
    • Retrieve questionnaire questions by question group id
    • Update a question by question id
  • Template
    • Create Questionnaire Template
    • Delete Questionnaire Template
    • Retrieve Questionnaire Template
    • Retrieve Questionnaire Templates
    • Update Questionnaire Template
  • Title Setup
    • Create a Questionnaire Title and Description
    • Delete a questionnaire title
    • Retrieve questionnaire title by template id
    • Update a questionnaire title and description
• Reservations
  • Amenities
    • Create a new amenity record
    • Delete an existing amenity record
    • Retrieve Amenities Record by reservation Id
    • Update an existing amenity record
  • Back to Back Reservations
    • Retrieve guest record that having reservation from current and future cruise.
  • Booked Excursion Details
    • Retrieve Excursion Bookings
  • Check-In
    • Update check-in reservation status and add additional validations.
    • Travel Document Rules
      • Validate supplied travel documents against selected travel document rule for a profile
  • Credit Card Registration
    • Registers credit card with OPI services
  • Cruise Reservation V2
    • Retrieve reservation and profile details based on criteria
  • Cruise Reservations
    • Retrieve reservation and profile details based on criteria
  • Event Ticketing Bookings
    • Retrieve event ticketing booking by reservation Id
  • Excursion
    • Retrieve excursion booking details
  • Flight Booking Details
    • Retrieve Flight Booking Details
  • Folio
    • Retrieve folio outstanding balance for a reservation
  • Guardian
    • Create new guardian by minor profile ID
    • Create new minor by guardian profile ID
    • Delete the guardian profile
    • Delete the minor profile
    • Retrieve guardian details by minor profile ID
    • Retrieve minor details by guardian profile ID
  • Guardian assignment
    • Associate a guardian to a minor.
    • Remove/ Delete a guardian associated to a minor
    • Retrieve list of guardians associated to a minor
    • Retrieves a list of all guardians that are associated with minors
  • Guest Messages
    • Create guest message
    • Delete guest message with specified message id and reservation id
    • Retrieve guest message by reservation Id
    • Update guest message with specified message id and reservation id
  • Guest Messages Delivery
    • Guest message delivery
  • Guest Reservation
    • Create a guest cruise reservation
    • Retrieve a guest reservation by Reservation Id
    • Update a guest reservation by Id
  • Onboard activities
    • Retrieve list of all event ticketing bookings for a reservation
    • Retrieve list of all Excursion bookings for a reservation
    • Retrieve list of all onboard activities bookings for a reservation
    • Retrieve list of all SPA bookings for a reservation
  • Onboard status
    • Retrieve the onboard status for a profile
    • Update the onboard status for a profile
  • Package Plan
    • Retrieve Package Plan entitlements by reservation Id
  • Payment method assignment
    • Retrieve payment method for a reservation
    • Update Payment Method for a reservation
  • Posting Allowed Status
    • Retrieve posting allowed status of a reservation
  • Print board card
    • Create/ Add a print job
    • Retrieve list of all configured board card printers
  • Routing Instruction
    • Retrieve list of all payee details for a profile
    • Retrieve the Guest Payment Routing record list
    • Update payee details to a profile.
  • Services Request and Activities Reservation Counts
    • Services request and onboard activities reservation counts
  • SPA Appointment Details
    • Retrieve SPA appointment
  • Special Requests
    • Create a special request by reservation ID
    • Delete existing special request by special request ID
    • Retrieve special requests by reservation ID
    • Update existing special request by special request ID
  • Sync Guest Details
    • Create selected sync criteria record to guest next cruise reservation.
  • Travelling With
    • Retrieve a list of guardians that are travelling with
    • Retrieve guests profile by the selected reservation id
    • Retrieve list of guests that are travelling with the selected guest
  • Validations
    • Check-In
      • Update Reservation Status
    • Check-In validations
      • Validate required information for checking in a reservation
• Role Manager
  • Access Role Task
    • Retrieve configured access
  • User Group
    • Create new user group
    • Delete User Group record
    • Retrieve user group by user group id
    • Retrieve user groups
    • Update specific Main task accesses from a User Group to other User Groups
    • Update user group details.
  • User Group Access
    • Retrieve the user group access for the login user
• List of Values
  • Amenity Applicable
    • Retrieve configured Amenity Applicable list of value records.
  • BoatTypes
    • Retrieve a list of all boat types
  • Genders
    • Retrieve list of genders
  • Guest Message
    • Retrieve configured Guest Message list of value records.
  • Harbors
    • Create/ Add new harbor
    • Retrieve a harbor using code
    • Retrieve list of all active harbors
    • Retrieve list of harbors
    • Update harbor record
  • Nations
    • Create/ Add a new nation
    • Delete nation record by using code
    • Retrieve list of all active nations
    • Retrieve nation record by using code
    • Retrieves list of nations
    • Update a nation record
  • Travel Document Types
    • Create travel document types
    • Create/ Add a new travel document type
    • Delete travel document type by code
    • Edit travel document type details
    • Retrieve a travel document type record by code
    • Retrieve list of all enabled travel document types
    • Retrieve list of all travel document types
    • Retrieve list of travel document types
    • Retrieve travel document type by code
    • Update a travel document type record by code
  • Travel Documents Checklist
    • Retrieve list of predefined travel document fields