NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Table of Contents

• About the REST APIs
• All REST Endpoints

Tasks

• Authentication
  • Generate OAuth token
  • Retrieve login user details
• Configurations
  • 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
  • Database server current date and time
    • Retrieve the Database server current date and time
  • 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
  • Minimum age as adult
    • Retrieve the settings for minimum age as adult
  • Onboard status settings after checked-in
    • Retrieve the settings for onboard status after checked-in
  • Ship name
    • Retrieve the Ship name
• 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 an acknowledged contract for a profile and a contract
    • Retrieve the acknowledged contracts for a profile
    • Retrieves a list of acknowledged contracts
    • Update an acknowledged contract to a profile
• Gateway Security
  • Configuration
    • Retrieve the settings for required visa check at gangway
    • Update the settings for required visa check at gangway
    • 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.
      • Retrieve a gate location by ID
      • Retrieve list of all enabled gate locations
      • Retrieve list of all gate locations
      • Update a gate location details by ID.
    • 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
  • Gangway
    • 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
  • 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
      • Validate shore leave denied status for a profile
    • Visa check
      • Retrieve list of all visa requirements
• List of values
  • Genders
    • Retrieve list of genders
  • Nations
    • Create/ Add a new nation
    • Retrieve list of all active nations
    • Retrieve nation record by using code
    • Retrieves list of nations
    • Update a nation record
  • Profile Types
    • Retrieve list of profile types
  • Travel Document Types
    • Create/ Add a new travel document type
    • Retrieve a travel document type record
    • Retrieve list of all enabled travel document types
    • Retrieve list of all travel document types
    • Update a travel document type record
• Mobile Check-in wizard
  • 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
  • Wizard templates
    • Create/ Add a new step for wizard template
    • Create/ Add a new wizard template
    • Remove/ Delete a step for a wizard template
    • Remove/ Delete a wizard template
    • Retrieve a step for a wizard template
    • Retrieve a wizard template
    • Retrieve list of all steps for wizard template
    • Retrieve lists of all enabled wizard templates
    • Retrieve lists of all wizard templates
    • Update a step for a wizard template
    • Update a wizard template record
    • Update print board card option
• Profiles
  • Credit card information
    • Retrieve list of active credit cards for a profile
  • Profile information
    • Retrieve a crew profile
    • Retrieve a guest profile
    • Retrieve a profile photo
    • Retrieve a resident profile
    • Retrieve a visitor profile
    • Retrieve guests profile with criteria search
    • Retrieve list of adult from search results
    • Retrieve profile details for a guardian associated to a minor
    • Update guest profile details
    • Upload a profile photo
  • 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
• Reservations
  • Excursion
    • Retrieve excursion booking details
  • Folio
    • Retrieve folio outstanding balance for a reservation
  • 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
  • Onboard status
    • Retrieve the onboard status for a profile
    • Update the onboard status for a profile
  • Payment method assignment
    • Retrieve payment method for a reservation
    • Update Payment Method for 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
    • Update payee details to a profile.
  • Travelling with
    • retrieve a list of guardians that are travelling with
    • Retrieve list of guests that are travelling with the selected guest
  • Validations
    • Check-In validations
      • Validate required information for checking in a reservation
• Staterooms
  • Configuration
    • Retrieve list of all staterooms