Oracle Hospitality Cruise REST API

All REST Endpoints

Authentication

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

Configurations

The operations from the Configurations category.

Retrieve the settings to enable auto-balance settlement validation: Method: get
Path: /spms/v2/ships/{shipId}/configurations/autoSettlementForActivePaymentCards
Retrieve the settings to enable balance check validation: Method: get
Path: /spms/v2/ships/{shipId}/configurations/folioBalanceChecking
Retrieve the settings to enable document returned validation: Method: get
Path: /spms/v2/ships/{shipId}/configurations/documentReturnedChecking

Configurations/Account Categories

Create a new Account Category record: Method: post
Path: /spms/v2/ships/{shipId}/configurations/profiles/accountCategories
Delete existing Account Category record: Method: delete
Path: /spms/v2/ships/{shipId}/configurations/profiles/accountCategories/{accountCategoryCode}
Retrieve configured Account Category records: Method: get
Path: /spms/v2/ships/{shipId}/configurations/profiles/accountCategories
Update existing Account Category record: Method: put
Path: /spms/v2/ships/{shipId}/configurations/profiles/accountCategories/{accountCategoryCode}

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/Guest Categories

Create a new guest category: Method: post
Path: /spms/v2/ships/{shipId}/configurations/profiles/guestCategories
Delete a guest category: Method: delete
Path: /spms/v2/ships/{shipId}/configurations/profiles/guestCategories/{guestCategoryCode}
Retrieve a list of guest categories: Method: get
Path: /spms/v2/ships/{shipId}/configurations/profiles/guestCategories
Update a guest category: Method: put
Path: /spms/v2/ships/{shipId}/configurations/profiles/guestCategories/{guestCategoryCode}

Configurations/Language Template

Create a new Language Template: Method: post
Path: /spms/v1/configurations/general/languages/templates
Delete a Language Template: Method: delete
Path: /spms/v1/configurations/general/languages/templates/{code}
Retrieve list of language templates: Method: get
Path: /spms/v1/configurations/general/languages/templates
Update Language Template: Method: put
Path: /spms/v1/configurations/general/languages/templates/{code}

Configurations/Lifeboats

Create a new Lifeboat record: Method: post
Path: /spms/v2/ships/{shipId}/configurations/safety/lifeBoats
Delete existing Lifeboat record: Method: delete
Path: /spms/v2/ships/{shipId}/configurations/safety/lifeBoats/{lifeBoatId}
Retrieve configured Lifeboats: Method: get
Path: /spms/v2/ships/{shipId}/configurations/safety/lifeBoats
Update existing Lifeboat code record: Method: put
Path: /spms/v2/ships/{shipId}/configurations/safety/lifeBoats/{lifeBoatId}

Configurations/Locations

The operations from the Configurations/Locations category.

Retrieve list of all public locations: Method: get
Path: /spms/v2/ships/{shipId}/configurations/locations

Configurations/Minimum age as adult

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

Configurations/Nationality Group

Create a new Nationality Group: Method: post
Path: /spms/v1/configurations/nationalityGroups
Delete Nationality Group: Method: delete
Path: /spms/v1/configurations/nationalityGroups/{code}
Retrieve list of enabled Nationality Groups: Method: get
Path: /spms/v1/configurations/nationalityGroups/enabled
Retrieve list of Nationality Groups: Method: get
Path: /spms/v1/configurations/nationalityGroups
Retrieve Nationality Groups by code: Method: get
Path: /spms/v1/configurations/nationalityGroups/{code}
Update Nationality Group: Method: put
Path: /spms/v1/configurations/nationalityGroups/{code}

Configurations/OPI WebAPI Service URL

Retrieve a value with URL in it: Method: get
Path: /spms/v2/ships/{shipId}/configurations/OPIWebAPIServiceURL

Configurations/Onboard status settings after checked-in

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

Configurations/Passport Reading access information

Retrieve Passport Reading access information and token: Method: get
Path: /spms/v2/ships/{shipId}/configurations/passportReadingAccessInformation

Configurations/Profile Search Templates

Retrieve list of predefined profile fields: Method: get
Path: /spms/v1/profiles

Configurations/Profile Types

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

Configurations/Ship information

Retrieve ship information for the current login user: Method: get
Path: /spms/v2/userDetails/me/shipProperties

Configurations/Ship name

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

Configurations/Staterooms

Retrieve list of all staterooms: Method: get
Path: /spms/v1/configurations/staterooms
Retrieve the stateroom configuration with criterias.: Method: get
Path: /spms/v2/ships/{shipId}/configurations/staterooms

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 a list of acknowledged contracts: Method: get
Path: /spms/v1/contractAcknowledgement
Retrieve an acknowledged contract for a profile and a contract: Method: get
Path: /spms/v1/contractAcknowledgement/{contractId}/guest/{accountId}
Retrieve the acknowledged contracts for a profile: Method: get
Path: /spms/v1/contractAcknowledgement/guest/{accountId}
Update an acknowledged contract to a profile: Method: put
Path: /spms/v1/contractAcknowledgement

Cruise/Itinerary

Retrieve Cruise Itineraries: Method: get
Path: /spms/v2/ships/{shipId}/cruiseItineraries

Cruise/Itinerary/Current Cruise

The operations from the Cruise/Itinerary/Current Cruise category.

Retrieve Current Cruise Itineraries: Method: get
Path: /spms/v2/ships/{shipId}/cruiseItineraries/currentCruise

Excursions/Bookable Tours

Create a new bookable tour: Method: post
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours
Delete a bookable tour group linking: Method: delete
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/groupLinkings/{groupLinkingId}
Delete a bookable tour package linking: Method: delete
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/packageLinkings/{packageLinkingId}
Delete a bookable tour that is not being used: Method: delete
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}
Delete a bookable tour variable cost: Method: delete
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/variableCosts/{variableCostId}
Delete a bookable tour VAT posting split: Method: delete
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/vatPostingSplit/{vatPostingSplitId}
Delete a fixed cost from a bookable tour: Method: delete
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/fixedCosts/{fixedCostId}
Delete a vendor from a bookable tour: Method: delete
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/vendors/{bookableTourVendorId}
Retrieve a list of bookable tours: Method: get
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours
Retrieve bookable tour general settings: Method: get
Path: /spms/v2/ships/{shipId}/configurations/excursions/general
Update a bookable tour details: Method: put
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/common
Update bookable tour general settings: Method: put
Path: /spms/v2/ships/{shipId}/configurations/excursions/general
Update bookable tour interfaces: Method: put
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/interfaces
Update customized field values for the bookable tour: Method: put
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/additionalInfo
Update fixed costs for the bookable tour: Method: put
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/costs/fixedCosts
Update group linkings for the bookable tour: Method: put
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/groupLinkings
Update package linkings for the bookable tour: Method: put
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/packageLinkings
Update sales for the bookable tour: Method: put
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/setup/sales
Update transfer tours for the bookable tour: Method: put
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/setup/transferTours
Update variable costs for the bookable tour: Method: put
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/costs/variableCosts
Update vendors for the bookable tour: Method: put
Path: /spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/vendors

Excursions/Void Bookings

Void excursion bookings by booking id: Method: delete
Path: /spms/v2/ships/{shipId}/excursions/bookings/{bookingId}

Gateway Security/Activities

Retrieve the gateway security activities with criterias.: Method: get
Path: /spms/v2/ships/{shipId}/gatewaySecurity/activities

Gateway Security/Configuration

The operations from the Gateway Security/Configuration category.

Retrieve check-in settings for the gangway only: Method: get
Path: /spms/v2/ships/{shipId}/configurations/checkIns/gangway
Retrieve the check-in settings at the gangway: Method: get
Path: /spms/v2/ships/{shipId}/configurations/checkIns
Retrieve the settings for required visa check at gangway: Method: get
Path: /spms/v1/configurations/visaChecks
Update check-in settings for the gangway only: Method: put
Path: /spms/v2/ships/{shipId}/configurations/checkIns/gangway
Update the check-in settings at the gangway: Method: put
Path: /spms/v2/ships/{shipId}/configurations/checkIns
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/{gateType}/gangwayMovements

Gateway Security/Configuration/Gate locations

Create/ Add new gate location.: Method: post
Path: /spms/v1/configurations/gangwayGateLocations
Delete the gate location details.: Method: delete
Path: /spms/v1/configurations/gangwayGateLocations/{code}
Retrieve a gate location by code: Method: get
Path: /spms/v1/configurations/gangwayGateLocations/{id}
Retrieve list of all gate locations: Method: get
Path: /spms/v1/configurations/gangwayGateLocations
Update a gate location details by code.: 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 by code: Method: put
Path: /spms/v1/configurations/general/specialNeeds/{code}

Gateway Security/Confiscated Temporary Returned Items

Edit a list of Confiscated Items details: Method: put
Path: /spms/v2/ships/{shipId}/trackItems/confiscatedItems
Retrieve a list of confiscated items: Method: get
Path: /spms/v2/ships/{shipId}/trackItems/confiscatedItems

Gateway Security/Gangway

Validate gangway coming onboard rules: Method: get
Path: /spms/v2/ships/{shipId}/gatewaySecurity/gangway/onboard/profiles/{profileId}/movementValidations/{gateDirection}
Validate gangway going ashore rules: Method: get
Path: /spms/v2/ships/{shipId}/gatewaySecurity/gangway/ashore/profiles/{profileId}/movementValidations/{gateDirection}

Gateway Security/Gangway Count

Get the count for 'Checked-In' reservation status for profile type: Method: get
Path: /spms/v1/profiles/{profileType}/checkedInTotal
Get the count for 'Disembarked' reservation status for profile type: Method: get
Path: /spms/v1/profiles/{profileType}/checkedOutTotal
Get the count for 'Disembarking' (leaving today) reservation status for profile type: Method: get
Path: /spms/v1/profiles/{profileType}/checkOutTodayTotal
Get the count for 'Expected Today' reservation status for profile type: Method: get
Path: /spms/v1/profiles/{profileType}/expectedToday
Get the count for staying overnight for tour based on profile type: Method: get
Path: /spms/v1/profiles/{profileType}/overnightTourTotal
Get the count of 'Expected' reservation status for profile type: Method: get
Path: /spms/v1/profiles/{profileType}/expectedTotal
Get the onboard count based on profile type: Method: get
Path: /spms/v1/profiles/{profileType}/onboardTotal
Gets the ashore count based on profile type: Method: get
Path: /spms/v1/profiles/{profileType}/ashoreTotal

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/Tender Boat

Create a tender boat details: Method: post
Path: /spms/v2/ships/{shipId}/configurations/tenderBoats
Create the opened tender boat gateway details: Method: post
Path: /spms/v2/ships/{shipId}/gatewaySecurity/tenderBoatGateway
Delete the tender boat details: Method: delete
Path: /spms/v2/ships/{shipId}/configurations/tenderBoats/{tenderBoatId}
Edit the tender boat details: Method: put
Path: /spms/v2/ships/{shipId}/configurations/tenderBoats/{tenderBoatId}
Remove an existing tenderboat gateway user: Method: delete
Path: /spms/v2/ships/{shipId}/gatewaySecurity/tenderBoatGateway/{tenderBoatGatewayId}
Retrieve a list of tender boat details: Method: get
Path: /spms/v2/ships/{shipId}/configurations/tenderBoats
Retrieve the active tender boat count at the tender boat gateway: Method: get
Path: /spms/v2/ships/{shipId}/gatewaySecurity/tenderBoatGateway/tenderBoats/{tenderBoatId}/count
Retrieve the opened tenderboat gateway details: Method: get
Path: /spms/v2/ships/{shipId}/gatewaySecurity/tenderBoatGateway
Save the tender boat movement and other related information: Method: post
Path: /spms/v2/ships/{shipId}/gatewaySecurity/movements/tenderBoatGateway
Update the opened tender boat gateway details: Method: put
Path: /spms/v2/ships/{shipId}/gatewaySecurity/tenderBoatGateway/{tenderBoatGatewayId}
Validate gangway tender boat coming onboard rules: Method: get
Path: /spms/v2/ships/{shipId}/gatewaySecurity/tenderBoatGateway/tenderBoat/{tenderBoatId}/onboard/profiles/{profileId}/movementValidations/{gateDirection}
Validate gangway tender boat going ashore rules: Method: get
Path: /spms/v2/ships/{shipId}/gatewaySecurity/tenderBoatGateway/tenderBoat/{tenderBoatId}/ashore/profiles/{profileId}/movementValidations/{gateDirection}

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

Validate gangway movement against configured security alerts: Method: post
Path: /spms/v1/reservations/gangwaySecurityValidations

Gateway Security/Validations/Shore leave denied

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

Interfaces/Credit Card Terminal

The operations from the Interfaces/Credit Card Terminal category.

Create/ Add credit card terminal record: Method: post
Path: /spms/v2/ships/{shipId}/interfaces/creditCardTerminals
Delete a credit card terminal record: Method: delete
Path: /spms/v2/ships/{shipId}/interfaces/creditCardTerminals/{terminalId}
Retrieve a credit card terminal record: Method: get
Path: /spms/v2/ships/{shipId}/interfaces/creditCardTerminals/{terminalId}
Retrieve a list of all credit card terminal records: Method: get
Path: /spms/v2/ships/{shipId}/interfaces/creditCardTerminals
Update a credit card terminal record: Method: put
Path: /spms/v2/ships/{shipId}/interfaces/creditCardTerminals/{terminalId}

List of values/Genders

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

List of values/Harbors

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

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/Travel Document Types

Create/ Add a new travel document type: Method: post
Path: /spms/v1/configurations/travelDocumentTypes
Retrieve a travel document type record by code: 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 by code: Method: put
Path: /spms/v1/configurations/travelDocumentTypes/{code}

Mobile Check-in wizard/Profile search template

Create/ Add a new profile search template: Method: post
Path: /spms/v1/profileSearchTemplate
Create/ Add new profile search configuration field: Method: post
Path: /spms/v1/profileSearchTemplateField
Delete the profile search template by ID: Method: delete
Path: /spms/v1/profileSearchTemplate/{id}
Retrieve a profile search fields excluded from search filter or results: Method: get
Path: /spms/v1/profileSearchTemplateField/type/{typeId}/searchOption/{templateId}
Retrieve a profile search template: Method: get
Path: /spms/v1/profileSearchTemplate/{id}
Retrieve a profile search template field by Id: Method: get
Path: /spms/v1/profileSearchTemplateField/{id}
Retrieve list of all profile search templates: Method: get
Path: /spms/v1/profileSearchTemplate
Retrieve list of profile search template fields: Method: get
Path: /spms/v1/profileSearchTemplateField/type/{typeId}
Retrieve list of profile search template reservation status: Method: get
Path: /spms/v1/profileSearchReservationStatus
Retrieve list of profile search template reservation status: Method: get
Path: /spms/v1/profileSearchReservationStatus/searchOption/{id}
Retrieve list of Profile Search template reservation status by ID: Method: get
Path: /spms/v1/profileSearchReservationStatus/{id}
Update a profile search template record: Method: put
Path: /spms/v1/profileSearchTemplate

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

Profiles/Addresses

The operations from the Profiles/Addresses category.

Create new guest home address by Profile ID: Method: post
Path: /spms/v2/ships/{shipId}/profile/{profileId}/addresses/home
Retrieve guest home address by profile ID: Method: get
Path: /spms/v2/ships/{shipId}/profile/{profileId}/addresses/home
Update guest home address by Profile ID: Method: put
Path: /spms/v2/ships/{shipId}/profile/{profileId}/addresses/home

Profiles/Analytics

Retrieve the count of sailing persons based on profile type: Method: get
Path: /spms/v1/analytics/profiles/{profileType}/count

Profiles/Analytics/Adults

The operations from the Profiles/Analytics/Adults category.

Retrieve the count for adults based on profile type and reservation status: Method: get
Path: /spms/v1/analytics/profiles/{profileType}/adult/{status}/count

Profiles/Analytics/Minors

The operations from the Profiles/Analytics/Minors category.

Retrieve the count for minors based on profile type and reservation status: Method: get
Path: /spms/v1/analytics/profiles/{profileType}/minor/{status}/count

Profiles/Analytics/Profile Type/Count

The operations from the Profiles/Analytics/Profile Type/Count category.

Retrieve the count based on profile type and reservation status: Method: get
Path: /spms/v1/analytics/profiles/{profileType}/{status}/count

Profiles/Analytics/Vip Guests

The operations from the Profiles/Analytics/Vip Guests category.

Retrieve the VIP guest count: Method: get
Path: /spms/v1/analytics/guest/vip/{status}/count

Profiles/Analytics/Visitors/Generic

The operations from the Profiles/Analytics/Visitors/Generic category.

Retrieve the counts for Generic Visitors: Method: get
Path: /spms/v1/analytics/profiles/visitor/generic/count

Profiles/Analytics/Visitors/named

The operations from the Profiles/Analytics/Visitors/named category.

Retrieve the counts for Named Visitors: Method: get
Path: /spms/v1/analytics/profiles/visitor/named/count

Profiles/Credit card information

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

Profiles/Other Travel Documents

Retrieve list of all other travel documents for a guest: Method: get
Path: /spms/v1/guest/{accountId}/otherTravelDocuments
Retrieves list of all other travel documents for a crew: Method: get
Path: /spms/v1/crew/{accountId}/otherTravelDocuments
Retrieves list of all other travel documents for a resident: Method: get
Path: /spms/v1/resident/{accountId}/otherTravelDocuments
Retrieves list of all other travel documents for a visitor: Method: get
Path: /spms/v1/visitor/{accountId}/otherTravelDocuments

Profiles/Profile information

Ability to search for a profile and retrieve information of a resident.

Create a profile photo: Method: post
Path: /spms/v1/guest/photo
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/{profileId}/photo
Retrieve a resident profile: Method: get
Path: /spms/v1/resident/{id}
Retrieve a visitor profile: Method: get
Path: /spms/v1/visitor/{id}
Retrieve crew profile with criteria search: Method: get
Path: /spms/v1/crew
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
Retrieve visitor profile with criteria search: Method: get
Path: /spms/v1/visitor
Update a profile photo: Method: put
Path: /spms/v1/guest/{profileId}/photo
Update guest profile details: Method: post
Path: /spms/v1/guest/infoUpdate

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

Questionnaire/Acknowledgement

Ability to create/update and retrieve information of Questionnaire Acknowledgement template by Reservation or Profile.

Retrieve Questionnaire Acknowledgement by Profile Id: Method: get
Path: /spms/v2/ships/{shipId}/profiles/{profileId}/questionnairesAcknowledgements
Retrieve Questionnaire Acknowledgement by Reservation Id: Method: get
Path: /spms/v2/ships/{shipId}/reservations/{reservationId}/questionnairesAcknowledgements
Retrieve Specified Questionnaire Acknowledgement by Profile Id and Template Id: Method: get
Path: /spms/v2/ships/{shipId}/profiles/{profileId}/questionnairesAcknowledgements/{questionnairesAcknowledgementId}
Save a Questionnaire Acknowledgement by Reservation Id and Template Id: Method: post
Path: /spms/v2/ships/{shipId}/reservations/{reservationId}/questionnairesAcknowledgements/{questionnairesAcknowledgementId}

Questionnaire/Authorization Reason

The operations from the Questionnaire/Authorization Reason category.

Create Questionnaire Authorization Reasons: Method: post
Path: /spms/v2/ships/{shipId}/reservations/{reservationId}/questionnaireAcknowledgements/{questionnairesAcknowledgementId}/authorizationReasons
Delete Questionnaire Authorization Reason by Id: Method: delete
Path: /spms/v2/ships/{shipId}/reservations/{reservationId}/questionnaireAcknowledgements/{questionnairesAcknowledgementId}/authorizationReasons/{authorizationReasonId}
Delete Questionnaire Authorization Reasons by reservation Id and template id: Method: delete
Path: /spms/v2/ships/{shipId}/reservations/{reservationId}/questionnaireAcknowledgements/{questionnairesAcknowledgementId}/authorizationReasons
Retrieve Questionnaire Authorization Reasons: Method: get
Path: /spms/v2/ships/{shipId}/reservations/{reservationId}/questionnaireAcknowledgements/{questionnairesAcknowledgementId}/authorizationReasons
Update Questionnaire Authorization Reason by Id: Method: put
Path: /spms/v2/ships/{shipId}/reservations/{reservationId}/questionnaireAcknowledgements/{questionnairesAcknowledgementId}/authorizationReasons/{authorizationReasonId}

Questionnaire/Authorize Reason Setup

The operations from the Questionnaire/Authorize Reason Setup category.

Create questionnaire authorize reason: Method: post
Path: /spms/v1/questionnaireAuthorizationReasons
Delete Questionnaire Authorize Reason: Method: delete
Path: /spms/v1/questionnaireAuthorizationReasons/{id}
Retrieve questionnaire authorize reason: Method: get
Path: /spms/v1/questionnaireAuthorizationReasons/{id}
Retrieve questionnaire authorize reasons: Method: get
Path: /spms/v1/questionnaireAuthorizationReasons
Update questionnaire authorize reason: Method: put
Path: /spms/v1/questionnaireAuthorizationReasons/{id}

Questionnaire/Questionnaire Acknowledgement

Create questionnaire acknowledgement by template id: Method: post
Path: /spms/v1/questionnaires/templates/{templateId}/acknowledgement
Delete Questionnaire Acknowledgement: Method: delete
Path: /spms/v1/questionnaires/templates/{templateId}/acknowledgement
Retrieve questionnaire acknowledgement by template id: Method: get
Path: /spms/v1/questionnaires/templates/{templateId}/acknowledgement
Update Questionnaire Acknowledgement: Method: put
Path: /spms/v1/questionnaires/templates/{templateId}/acknowledgement

Questionnaire/Questionnaire Category

Create new Questionnaire Category: Method: post
Path: /spms/v1/questionnaireCategories
Delete Questionnaire Category: Method: delete
Path: /spms/v1/questionnaireCategories/{id}
Retrieve a questionnaire category by ID: Method: get
Path: /spms/v1/questionnaireCategories/{id}
Retrieve the list of Questionnaire Categories: Method: get
Path: /spms/v1/questionnaireCategories
Update Questionnaire Category: Method: put
Path: /spms/v1/questionnaireCategories/{id}

Questionnaire/Questionnaire Groups

Create a new Question Group: Method: post
Path: /spms/v1/questionnaires/templates/{templateId}/questionGroups
Delete a Question Group: Method: delete
Path: /spms/v1/questionnaires/templates/{templateId}/questionGroups/{groupId}
Retrieve a Question Group based on Id: Method: get
Path: /spms/v1/questionnaires/templates/{templateId}/questionGroups/{groupId}
Retrieve list of Question Group based on Template Id: Method: get
Path: /spms/v1/questionnaires/templates/{templateId}/questionGroups
Update a Question group: Method: put
Path: /spms/v1/questionnaires/templates/{templateId}/questionGroups/{groupId}

Questionnaire/Questionnaire Questions

Create new questions by question group id: Method: post
Path: /spms/v1/questionnaires/templates/{templateId}/questionGroups/{questionGroupId}/questions
Delete a question by question id: Method: delete
Path: /spms/v1/questionnaires/templates/{templateId}/questionGroups/{questionGroupId}/questions/{questionId}
Retrieve questionnaire questions by question group id: Method: get
Path: /spms/v1/questionnaires/templates/{templateId}/questionGroups/{questionGroupId}/questions
Update a question by question id: Method: put
Path: /spms/v1/questionnaires/templates/{templateId}/questionGroups/{questionGroupId}/questions/{questionId}

Questionnaire/Template

Create Questionnaire Template: Method: post
Path: /spms/v1/questionnaires/templates
Delete Questionnaire Template: Method: delete
Path: /spms/v1/questionnaires/templates/{id}
Retrieve Questionnaire Template: Method: get
Path: /spms/v1/questionnaires/templates/{id}
Retrieve Questionnaire Templates: Method: get
Path: /spms/v1/questionnaires/templates
Update Questionnaire Template: Method: put
Path: /spms/v1/questionnaires/templates/{id}

Questionnaire/Title Setup

The operations from the Questionnaire/Title Setup category.

Create a Questionnaire Title and Description: Method: post
Path: /spms/v1/questionnaires/templates/{id}/titles
Delete a questionnaire title: Method: delete
Path: /spms/v1/questionnaires/templates/{id}/titles
Retrieve questionnaire title by template id: Method: get
Path: /spms/v1/questionnaires/templates/{id}/titles
Update a questionnaire title and description: Method: put
Path: /spms/v1/questionnaires/templates/{id}/titles

Reservations

Retrieve reservation and profile details based on criteria: Method: get
Path: /spms/v1/reservations

Reservations/Booked Excursion Details

Retrieve Excursion Bookings: Method: get
Path: /spms/v2/ships/{shipId}/reservations/{reservationId}/bookedExcursions

Reservations/Check-In

Update check-in reservation status and add additional validations.: Method: post
Path: /spms/v2/ships/{shipId}/reservations/checkIns

Reservations/Credit Card Registration

Registers credit card with OPI services: Method: post
Path: /spms/v2/ships/{shipId}/creditCards

Reservations/Event Ticketing Bookings

Retrieve event ticketing booking by reservation Id: Method: get
Path: /spms/v2/ships/{shipId}/reservations/{reservationId}/bookedEventTicketing

Reservations/Excursion

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

Reservations/Flight Booking Details

Retrieve Flight Booking Details: Method: get
Path: /spms/v2/ships/{shipId}/reservations/{reservationId}/flightAssignments

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 activities

Retrieve list of all event ticketing bookings for a reservation: Method: get
Path: /spms/v1/onboardActivities/{reservationId}/bookings/eventTicketings
Retrieve list of all Excursion bookings for a reservation: Method: get
Path: /spms/v1/onboardActivities/{reservationId}/bookings/excursions
Retrieve list of all onboard activities bookings for a reservation: Method: get
Path: /spms/v1/onboardActivities/{reservationId}/bookings
Retrieve list of all SPA bookings for a reservation: Method: get
Path: /spms/v1/onboardActivities/{reservationId}/bookings/spa

Reservations/Onboard status

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

Reservations/Payment method assignment

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

Reservations/Payments

Create new Payment Option Setup: Method: post
Path: /spms/v1/paymentOption
Delete an existing Payment Option and selected Payment Method: Method: delete
Path: /spms/v1/paymentOption/{id}
Get Payment Option with ID: Method: get
Path: /spms/v1/paymentOption/{id}
List all Payment Option with selected Payment Method: Method: get
Path: /spms/v1/paymentOption
Update an existing payment option: Method: put
Path: /spms/v1/paymentOption

Reservations/Print board card

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/{printerType}

Reservations/Routing Instruction

Reservations Routing Instructions Controller

Retrieve list of all payee details for a profile: Method: get
Path: /spms/v1/reservations/{profileId}/routingInstructions
Retrieve the Guest Payment Routing record list: Method: get
Path: /spms/v1/reservations/{profileId}/routingInstructions/profileSearchTemplate/{templateId}
Update payee details to a profile.: Method: put
Path: /spms/v1/reservations/{profileId}/routingInstructions/paysfor

Reservations/SPA Appointment Details

The operations from the Reservations/SPA Appointment Details category.

Retrieve SPA appointment: Method: get
Path: /spms/v2/ships/{shipId}/reservations/{reservationId}/bookedSpa

Reservations/Travelling with

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

Reservations/Validations/Check-In

Update Reservation Status: Method: post
Path: /spms/v1/reservations/checkIns

Reservations/Validations/Check-In validations

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