Oracle Hospitality Cruise REST API

NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

All REST Endpoints

Authentication

OAuth based security

Generate OAuth token: Method: post
Path: /spms/access/token
Retrieve login user details: Method: get
Path: /spms/v1/userDetails

Configurations/Check minor going ashore authorization

Retrieve the settings for minor going ashore authorization: Method: get
Path: /spms/v1/configurations/minorAuthorizationCheck
Update the settings for minor going ashore authorization: Method: put
Path: /spms/v1/configurations/minorAuthorizationCheck

Configurations/Check travel document returned

Retrieve the setting for check travel document returned: Method: get
Path: /spms/v1/configurations/checkTravelDocumentReturned

Configurations/Database server current date and time

Retrieve the Database server current date and time: Method: get
Path: /spms/v1/configurations/currentDate

Configurations/Excluded harbors for minor going ashore authorization

Retrieve the settings for excluded harbors for minor going ashore authorization: Method: get
Path: /spms/v1/configurations/portNotRequireMinorAuthorizationCheck
Update the settings for excluded harbors for minor going ashore authorization: Method: put
Path: /spms/v1/configurations/portNotRequireMinorAuthorizationCheck

Configurations/Gangway auto check out

Retrieve the settings for gangway auto check out for a reservation: Method: get
Path: /spms/v1/configurations/gangwayAutoCheckOut

Configurations/Minimum age as adult

Retrieve the settings for minimum age as adult: Method: get
Path: /spms/v1/configurations/minimumAdultAge

Configurations/Onboard status settings after checked-in

Retrieve the settings for onboard status after checked-in: Method: get
Path: /spms/v1/configurations/onboardStatusAfterCheckIn

Configurations/Ship name

Retrieve the Ship name: Method: get
Path: /spms/v1/configurations/shipProperty

Contract/Configuration/Contract

Create/ Add a new contract: Method: post
Path: /spms/v1/contracts
Remove/ Delete a Contract: Method: delete
Path: /spms/v1/contracts/{id}
Retrieve a contract: Method: get
Path: /spms/v1/contracts/{id}
Retrieve all available contracts with enabled status: Method: get
Path: /spms/v1/contracts/enabled
Retrieve list of contracts: Method: get
Path: /spms/v1/contracts
Update a contract: Method: put
Path: /spms/v1/contracts

Contract/Configuration/Contract Category

Create/ Add a new contract category: Method: post
Path: /spms/v1/contractCategories
Remove/ Delete a contract category: Method: delete
Path: /spms/v1/contractCategories/{id}
Retrieve a contract category: Method: get
Path: /spms/v1/contractCategories/{id}
Retrieve list of contract categories: Method: get
Path: /spms/v1/contractCategories
Update a contract category: Method: put
Path: /spms/v1/contractCategories

Contract/Contract Acknowledgement

Create/ Add an acknowledged contract to a profile: Method: post
Path: /spms/v1/contractAcknowledgement
Retrieve an acknowledged contract for a profile and a contract: Method: get
Path: /spms/v1/contractAcknowledgement/{contractId}/{profileType}/{accountId}
Retrieve the acknowledged contracts for a profile: Method: get
Path: /spms/v1/contractAcknowledgement/{profileType}/{accountId}
Retrieves a list of acknowledged contracts: Method: get
Path: /spms/v1/contractAcknowledgement
Update an acknowledged contract to a profile: Method: put
Path: /spms/v1/contractAcknowledgement

Gateway Security/Configuration

The operations from the Gateway Security/Configuration category.

Retrieve the settings for required visa check at gangway: Method: get
Path: /spms/v1/configurations/visaChecks
Update the settings for required visa check at gangway: Method: put
Path: /spms/v1/configurations/visaChecks

Gateway Security/Configuration/Gangway customized messages

The operations from the Gateway Security/Configuration/Gangway customized messages category.

Retrieve list of all gangway customized messages: Method: get
Path: /spms/v1/configurations/messages

Gateway Security/Configuration/Gangway movements

Retrieve list of all gangway movements: Method: get
Path: /spms/v1/configurations/gangwayMovements
Retrieve list of all gangway movements by gateway type: Method: get
Path: /spms/v1/configurations/{gateTypeId}/gangwayMovements

Gateway Security/Configuration/Gate locations

Create/ Add new gate location.: Method: post
Path: /spms/v1/configurations/gangwayGateLocations
Retrieve a gate location by ID: Method: get
Path: /spms/v1/configurations/gangwayGateLocations/{id}
Retrieve list of all enabled gate locations: Method: get
Path: /spms/v1/configurations/gangwayGateLocations/enabled
Retrieve list of all gate locations: Method: get
Path: /spms/v1/configurations/gangwayGateLocations
Update a gate location details by ID.: Method: put
Path: /spms/v1/configurations/gangwayGateLocations/{id}

Gateway Security/Configuration/Gateway traffic direction

Retrieve list of gateway traffic directions: Method: get
Path: /spms/v1/configurations/trafficDirections

Gateway Security/Configuration/Gateway types

Retrieve list of all gateway types: Method: get
Path: /spms/v1/configurations/gangwayTypes

Gateway Security/Configuration/Security Alerts

Retrieve a gangway security alert by ID: Method: get
Path: /spms/v1/configurations/gangwaySecurityAlerts/{id}
Retrieve list of all gangway security alerts: Method: get
Path: /spms/v1/configurations/gangwaySecurityAlerts
Update a gangway security alert: Method: put
Path: /spms/v1/configurations/gangwaySecurityAlerts

Gateway Security/Configuration/Security alert sounds

Create/ Add a security alert sound: Method: post
Path: /spms/v1/configurations/gangwaySecuritySounds
Remove/ Delete a security alert sound by ID: Method: delete
Path: /spms/v1/configurations/gangwaySecuritySounds/{id}
Retrieve a security alert sound by ID: Method: get
Path: /spms/v1/configurations/gangwaySecuritySounds/{id}
Retrieve and playback a security alert sound by ID: Method: get
Path: /spms/v1/configurations/gangwaySecuritySounds/{id}/sound
Retrieve list of all security alert sounds: Method: get
Path: /spms/v1/configurations/gangwaySecuritySounds/all
Update details for a security alert sound by ID: Method: put
Path: /spms/v1/configurations/gangwaySecuritySounds/{id}

Gateway Security/Configuration/Special needs

Create/ add a new special needs: Method: post
Path: /spms/v1/configurations/general/specialNeeds
Remove/ Delete a special needs by code: Method: delete
Path: /spms/v1/configurations/general/specialNeeds/{code}
Retrieve a list of all special needs: Method: get
Path: /spms/v1/configurations/general/specialNeeds
Retrieve a special needs by code: Method: get
Path: /spms/v1/configurations/general/specialNeeds/{code}
Retrieve list of all enabled special needs: Method: get
Path: /spms/v1/configurations/general/specialNeeds/enabled
Update a special needs record: Method: put
Path: /spms/v1/configurations/general/specialNeeds

Gateway Security/Gangway/Activities

Create/ Add gangway activities for a profile: Method: post
Path: /spms/v1/gangwayActivities
Retrieve list of gangway activities by parameters: Method: get
Path: /spms/v1/gangwayActivities
Retrieve list of gangway activities for a profile: Method: get
Path: /spms/v1/gangwayActivities/{accountId}
Retrieve list of recent gangway activities: Method: get
Path: /spms/v1/gangwayActivities/recent/{userId}/{gateLocation}/{startDateTime}

Gateway Security/Gangway/Movements

Create/ Add gangway activities with movement: Method: post
Path: /spms/v1/gatewaySecurity/movements/gangway

Gateway Security/Validations/Gangway

Validate and display customized messages for a profile coming onboard: Method: post
Path: /spms/v1/gatewaySecurity/gangway/validations/onboard
Validate and display customized messages for a profile going ashore: Method: post
Path: /spms/v1/gatewaySecurity/gangway/validations/ashore

Gateway Security/Validations/Gangway security alerts

The operations from the Gateway Security/Validations/Gangway security alerts category.

Validate gangway movement against configured security alerts: Method: post
Path: /spms/v1/reservations/gangwaySecurityValidations
Validate shore leave denied status for a profile: Method: post
Path: /spms/v1/gangway/ashoreDenied

Gateway Security/Validations/Visa check

Retrieve list of all visa requirements: Method: get
Path: /spms/v1/configurations/visaRequired

List of values/Genders

Retrieve list of genders: Method: get
Path: /spms/v1/configurations/genders

List of values/Nations

Create/ Add a new nation: Method: post
Path: /spms/v1/configurations/nations
Retrieve list of all active nations: Method: get
Path: /spms/v1/configurations/nations/enabled
Retrieve nation record by using code: Method: get
Path: /spms/v1/configurations/nations/{code}
Retrieves list of nations: Method: get
Path: /spms/v1/configurations/nations
Update a nation record: Method: put
Path: /spms/v1/configurations/nations/{code}

List of values/Profile Types

Retrieve list of profile types: Method: get
Path: /spms/v1/configurations/profileTypes

List of values/Travel Document Types

Create/ Add a new travel document type: Method: post
Path: /spms/v1/configurations/travelDocumentTypes
Retrieve a travel document type record: Method: get
Path: /spms/v1/configurations/travelDocumentTypes/{code}
Retrieve list of all enabled travel document types: Method: get
Path: /spms/v1/configurations/travelDocumentTypes/enabled
Retrieve list of all travel document types: Method: get
Path: /spms/v1/configurations/travelDocumentTypes
Update a travel document type record: Method: put
Path: /spms/v1/configurations/travelDocumentTypes/{code}

Mobile Check-in wizard/Profile template

Create/ Add a new profile template: Method: post
Path: /spms/v1/profileConfigurations
Create/ Add a new profile template header: Method: post
Path: /spms/v1/profileConfigurationHeaders
Remove/ Delete a profile template: Method: delete
Path: /spms/v1/profileConfigurations/{id}
Remove/ Delete a profile template header: Method: delete
Path: /spms/v1/profileConfigurationHeaders/{id}
Retrieve a profile template: Method: get
Path: /spms/v1/profileConfigurations/{id}
Retrieve a profile template header: Method: get
Path: /spms/v1/profileConfigurationHeaders/{id}
Retrieves list of all profile template headers: Method: get
Path: /spms/v1/profileConfigurationHeaders
Retrieves list of profile templates: Method: get
Path: /spms/v1/profileConfigurations
Update a profile template: Method: put
Path: /spms/v1/profileConfigurations/list
Update a profile template header: Method: put
Path: /spms/v1/profileConfigurationHeaders
Update a profile template record: Method: put
Path: /spms/v1/profileConfigurations

Mobile Check-in wizard/Wizard templates

Create/ Add a new step for wizard template: Method: post
Path: /spms/v1/stepTemplates
Create/ Add a new wizard template: Method: post
Path: /spms/v1/wizardTemplates
Remove/ Delete a step for a wizard template: Method: delete
Path: /spms/v1/stepTemplates/{id}
Remove/ Delete a wizard template: Method: delete
Path: /spms/v1/wizardTemplates/{id}
Retrieve a step for a wizard template: Method: get
Path: /spms/v1/stepTemplates/{id}
Retrieve a wizard template: Method: get
Path: /spms/v1/wizardTemplates/{id}
Retrieve list of all steps for wizard template: Method: get
Path: /spms/v1/stepTemplates
Retrieve lists of all enabled wizard templates: Method: get
Path: /spms/v1/wizardTemplates/enabled
Retrieve lists of all wizard templates: Method: get
Path: /spms/v1/wizardTemplates
Update a step for a wizard template: Method: put
Path: /spms/v1/stepTemplates
Update a wizard template record: Method: put
Path: /spms/v1/wizardTemplates
Update print board card option: Method: put
Path: /spms/v1/configuration/checkIn/boardCardPrinting/{enable}

Profiles/Credit card information

Retrieve list of active credit cards for a profile: Method: get
Path: /spms/v1/financials/payments/cards/{profileid}

Profiles/Profile information

Retrieve a crew profile: Method: get
Path: /spms/v1/crew/{id}
Retrieve a guest profile: Method: get
Path: /spms/v1/guest/{id}
Retrieve a profile photo: Method: get
Path: /spms/v1/guest/{accountId}/photo
Retrieve a resident profile: Method: get
Path: /spms/v1/resident/{id}
Retrieve a visitor profile: Method: get
Path: /spms/v1/visitor/{id}
Retrieve guests profile with criteria search: Method: get
Path: /spms/v1/guest
Retrieve list of adult from search results: Method: get
Path: /spms/v1/guest/adults
Retrieve profile details for a guardian associated to a minor: Method: get
Path: /spms/v1/profiles/{id}/guardians
Update guest profile details: Method: post
Path: /spms/v1/guest/infoUpdate
Upload a profile photo: Method: post
Path: /spms/v1/guest/photo

Profiles/Special needs assignment

Retrieve list of special needs assignments for a profile: Method: get
Path: /spms/v1/profiles/{accountId}/specialNeeds
Retrieve list of special needs assignments for a profile by profile type: Method: get
Path: /spms/v1/profiles/{profileType}/{accountId}/specialNeeds
Update special needs assignments for a profile: Method: put
Path: /spms/v1/profiles/{accountId}/specialNeeds
Update special needs assignments for a profile by profile type: Method: put
Path: /spms/v1/profiles/{profileType}/{accountId}/specialNeeds

Reservations/Excursion

Retrieve excursion booking details: Method: get
Path: /spms/v1/excursions/bookings/{reservationId}

Reservations/Folio

Retrieve folio outstanding balance for a reservation: Method: get
Path: /spms/v1/folio/{reservationId}

Reservations/Guardian assignment

Guardian information associated with a Profile

Associate a guardian to a minor.: Method: post
Path: /spms/v1/guardians/child/{childId}
Remove/ Delete a guardian associated to a minor: Method: delete
Path: /spms/v1/guardians/{guardianId}/child/{childId}
Retrieve list of guardians associated to a minor: Method: get
Path: /spms/v1/guardians/child/{childId}
Retrieves a list of all guardians that are associated with minors: Method: get
Path: /spms/v1/guardians/{guardianId}

Reservations/Onboard status

Retrieve the onboard status for a profile: Method: get
Path: /spms/v1/reservations/{reservationId}/onboardStatus
Update the onboard status for a profile: Method: put
Path: /spms/v1/reservations/{reservationId}/onboardStatus

Reservations/Payment method assignment

Retrieve payment method for a reservation: Method: get
Path: /spms/v1/reservations/{reservationid}/paymentMethod
Update Payment Method for a reservation: Method: put
Path: /spms/v1/reservations/{reservationid}/paymentMethod

Reservations/Print board card

Print Jobs

Create/ Add a print job: Method: post
Path: /spms/v1/configuration/printerJobs
Retrieve list of all configured board card printers: Method: get
Path: /spms/v1/configuration/printers/boardCard

Reservations/Routing instruction

Reservations Routing Instructions Controller

Retrieve list of all payee details for a profile: Method: get
Path: /spms/v1/reservations/{profileId}/routingInstructions
Update payee details to a profile.: Method: put
Path: /spms/v1/reservations/{profileId}/routingInstructions/paysfor

Reservations/Travelling with

retrieve a list of guardians that are travelling with: Method: get
Path: /spms/v1/reservations/{reservationId}/travellingWith/profileSearchTemplate/{templateId}/adults
Retrieve list of guests that are travelling with the selected guest: Method: get
Path: /spms/v1/reservations/{reservationId}/travellingWith/profileSearchTemplate/{templateId}

Reservations/Validations/Check-In validations

Validate required information for checking in a reservation: Method: post
Path: /spms/v1/reservations/validation/checkIns

Staterooms/Configuration

Retrieve list of all staterooms: Method: get
Path: /spms/v1/configurations/staterooms