NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
All REST Endpoints
Authentication
OAuth based security
- Generate OAuth token
- Method: postPath:
/spms/access/token
- Retrieve login user details
- Method: getPath:
/spms/v1/userDetails
Configurations/Check minor going ashore authorization
- Retrieve the settings for minor going ashore authorization
- Method: getPath:
/spms/v1/configurations/minorAuthorizationCheck
- Update the settings for minor going ashore authorization
- Method: putPath:
/spms/v1/configurations/minorAuthorizationCheck
Configurations/Check travel document returned
- Retrieve the setting for check travel document returned
- Method: getPath:
/spms/v1/configurations/checkTravelDocumentReturned
Configurations/Database server current date and time
- Retrieve the Database server current date and time
- Method: getPath:
/spms/v1/configurations/currentDate
Configurations/Excluded harbors for minor going ashore authorization
- Retrieve the settings for excluded harbors for minor going ashore authorization
- Method: getPath:
/spms/v1/configurations/portNotRequireMinorAuthorizationCheck
- Update the settings for excluded harbors for minor going ashore authorization
- Method: putPath:
/spms/v1/configurations/portNotRequireMinorAuthorizationCheck
Configurations/Gangway auto check out
- Retrieve the settings for gangway auto check out for a reservation
- Method: getPath:
/spms/v1/configurations/gangwayAutoCheckOut
Configurations/Minimum age as adult
- Retrieve the settings for minimum age as adult
- Method: getPath:
/spms/v1/configurations/minimumAdultAge
Configurations/Onboard status settings after checked-in
- Retrieve the settings for onboard status after checked-in
- Method: getPath:
/spms/v1/configurations/onboardStatusAfterCheckIn
Configurations/Ship name
- Retrieve the Ship name
- Method: getPath:
/spms/v1/configurations/shipProperty
Contract/Configuration/Contract
- Create/ Add a new contract
- Method: postPath:
/spms/v1/contracts
- Remove/ Delete a Contract
- Method: deletePath:
/spms/v1/contracts/{id}
- Retrieve a contract
- Method: getPath:
/spms/v1/contracts/{id}
- Retrieve all available contracts with enabled status
- Method: getPath:
/spms/v1/contracts/enabled
- Retrieve list of contracts
- Method: getPath:
/spms/v1/contracts
- Update a contract
- Method: putPath:
/spms/v1/contracts
Contract/Configuration/Contract Category
- Create/ Add a new contract category
- Method: postPath:
/spms/v1/contractCategories
- Remove/ Delete a contract category
- Method: deletePath:
/spms/v1/contractCategories/{id}
- Retrieve a contract category
- Method: getPath:
/spms/v1/contractCategories/{id}
- Retrieve list of contract categories
- Method: getPath:
/spms/v1/contractCategories
- Update a contract category
- Method: putPath:
/spms/v1/contractCategories
Contract/Contract Acknowledgement
- Create/ Add an acknowledged contract to a profile
- Method: postPath:
/spms/v1/contractAcknowledgement
- Retrieve an acknowledged contract for a profile and a contract
- Method: getPath:
/spms/v1/contractAcknowledgement/{contractId}/{profileType}/{accountId}
- Retrieve the acknowledged contracts for a profile
- Method: getPath:
/spms/v1/contractAcknowledgement/{profileType}/{accountId}
- Retrieves a list of acknowledged contracts
- Method: getPath:
/spms/v1/contractAcknowledgement
- Update an acknowledged contract to a profile
- Method: putPath:
/spms/v1/contractAcknowledgement
Gateway Security/Configuration
The operations from the Gateway Security/Configuration category.
- Retrieve the settings for required visa check at gangway
- Method: getPath:
/spms/v1/configurations/visaChecks
- Update the settings for required visa check at gangway
- Method: putPath:
/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: getPath:
/spms/v1/configurations/messages
Gateway Security/Configuration/Gangway movements
- Retrieve list of all gangway movements
- Method: getPath:
/spms/v1/configurations/gangwayMovements
- Retrieve list of all gangway movements by gateway type
- Method: getPath:
/spms/v1/configurations/{gateTypeId}/gangwayMovements
Gateway Security/Configuration/Gate locations
- Create/ Add new gate location.
- Method: postPath:
/spms/v1/configurations/gangwayGateLocations
- Retrieve a gate location by ID
- Method: getPath:
/spms/v1/configurations/gangwayGateLocations/{id}
- Retrieve list of all enabled gate locations
- Method: getPath:
/spms/v1/configurations/gangwayGateLocations/enabled
- Retrieve list of all gate locations
- Method: getPath:
/spms/v1/configurations/gangwayGateLocations
- Update a gate location details by ID.
- Method: putPath:
/spms/v1/configurations/gangwayGateLocations/{id}
Gateway Security/Configuration/Gateway traffic direction
- Retrieve list of gateway traffic directions
- Method: getPath:
/spms/v1/configurations/trafficDirections
Gateway Security/Configuration/Gateway types
- Retrieve list of all gateway types
- Method: getPath:
/spms/v1/configurations/gangwayTypes
Gateway Security/Configuration/Security Alerts
- Retrieve a gangway security alert by ID
- Method: getPath:
/spms/v1/configurations/gangwaySecurityAlerts/{id}
- Retrieve list of all gangway security alerts
- Method: getPath:
/spms/v1/configurations/gangwaySecurityAlerts
- Update a gangway security alert
- Method: putPath:
/spms/v1/configurations/gangwaySecurityAlerts
Gateway Security/Configuration/Security alert sounds
- Create/ Add a security alert sound
- Method: postPath:
/spms/v1/configurations/gangwaySecuritySounds
- Remove/ Delete a security alert sound by ID
- Method: deletePath:
/spms/v1/configurations/gangwaySecuritySounds/{id}
- Retrieve a security alert sound by ID
- Method: getPath:
/spms/v1/configurations/gangwaySecuritySounds/{id}
- Retrieve and playback a security alert sound by ID
- Method: getPath:
/spms/v1/configurations/gangwaySecuritySounds/{id}/sound
- Retrieve list of all security alert sounds
- Method: getPath:
/spms/v1/configurations/gangwaySecuritySounds/all
- Update details for a security alert sound by ID
- Method: putPath:
/spms/v1/configurations/gangwaySecuritySounds/{id}
Gateway Security/Configuration/Special needs
- Create/ add a new special needs
- Method: postPath:
/spms/v1/configurations/general/specialNeeds
- Remove/ Delete a special needs by code
- Method: deletePath:
/spms/v1/configurations/general/specialNeeds/{code}
- Retrieve a list of all special needs
- Method: getPath:
/spms/v1/configurations/general/specialNeeds
- Retrieve a special needs by code
- Method: getPath:
/spms/v1/configurations/general/specialNeeds/{code}
- Retrieve list of all enabled special needs
- Method: getPath:
/spms/v1/configurations/general/specialNeeds/enabled
- Update a special needs record
- Method: putPath:
/spms/v1/configurations/general/specialNeeds
Gateway Security/Gangway/Activities
- Create/ Add gangway activities for a profile
- Method: postPath:
/spms/v1/gangwayActivities
- Retrieve list of gangway activities by parameters
- Method: getPath:
/spms/v1/gangwayActivities
- Retrieve list of gangway activities for a profile
- Method: getPath:
/spms/v1/gangwayActivities/{accountId}
- Retrieve list of recent gangway activities
- Method: getPath:
/spms/v1/gangwayActivities/recent/{userId}/{gateLocation}/{startDateTime}
Gateway Security/Gangway/Movements
- Create/ Add gangway activities with movement
- Method: postPath:
/spms/v1/gatewaySecurity/movements/gangway
Gateway Security/Validations/Gangway
- Validate and display customized messages for a profile coming onboard
- Method: postPath:
/spms/v1/gatewaySecurity/gangway/validations/onboard
- Validate and display customized messages for a profile going ashore
- Method: postPath:
/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: postPath:
/spms/v1/reservations/gangwaySecurityValidations
- Validate shore leave denied status for a profile
- Method: postPath:
/spms/v1/gangway/ashoreDenied
Gateway Security/Validations/Visa check
- Retrieve list of all visa requirements
- Method: getPath:
/spms/v1/configurations/visaRequired
List of values/Genders
- Retrieve list of genders
- Method: getPath:
/spms/v1/configurations/genders
List of values/Nations
- Create/ Add a new nation
- Method: postPath:
/spms/v1/configurations/nations
- Retrieve list of all active nations
- Method: getPath:
/spms/v1/configurations/nations/enabled
- Retrieve nation record by using code
- Method: getPath:
/spms/v1/configurations/nations/{code}
- Retrieves list of nations
- Method: getPath:
/spms/v1/configurations/nations
- Update a nation record
- Method: putPath:
/spms/v1/configurations/nations/{code}
List of values/Profile Types
- Retrieve list of profile types
- Method: getPath:
/spms/v1/configurations/profileTypes
List of values/Travel Document Types
- Create/ Add a new travel document type
- Method: postPath:
/spms/v1/configurations/travelDocumentTypes
- Retrieve a travel document type record
- Method: getPath:
/spms/v1/configurations/travelDocumentTypes/{code}
- Retrieve list of all enabled travel document types
- Method: getPath:
/spms/v1/configurations/travelDocumentTypes/enabled
- Retrieve list of all travel document types
- Method: getPath:
/spms/v1/configurations/travelDocumentTypes
- Update a travel document type record
- Method: putPath:
/spms/v1/configurations/travelDocumentTypes/{code}
Mobile Check-in wizard/Profile template
- Create/ Add a new profile template
- Method: postPath:
/spms/v1/profileConfigurations
- Create/ Add a new profile template header
- Method: postPath:
/spms/v1/profileConfigurationHeaders
- Remove/ Delete a profile template
- Method: deletePath:
/spms/v1/profileConfigurations/{id}
- Remove/ Delete a profile template header
- Method: deletePath:
/spms/v1/profileConfigurationHeaders/{id}
- Retrieve a profile template
- Method: getPath:
/spms/v1/profileConfigurations/{id}
- Retrieve a profile template header
- Method: getPath:
/spms/v1/profileConfigurationHeaders/{id}
- Retrieves list of all profile template headers
- Method: getPath:
/spms/v1/profileConfigurationHeaders
- Retrieves list of profile templates
- Method: getPath:
/spms/v1/profileConfigurations
- Update a profile template
- Method: putPath:
/spms/v1/profileConfigurations/list
- Update a profile template header
- Method: putPath:
/spms/v1/profileConfigurationHeaders
- Update a profile template record
- Method: putPath:
/spms/v1/profileConfigurations
Mobile Check-in wizard/Wizard templates
- Create/ Add a new step for wizard template
- Method: postPath:
/spms/v1/stepTemplates
- Create/ Add a new wizard template
- Method: postPath:
/spms/v1/wizardTemplates
- Remove/ Delete a step for a wizard template
- Method: deletePath:
/spms/v1/stepTemplates/{id}
- Remove/ Delete a wizard template
- Method: deletePath:
/spms/v1/wizardTemplates/{id}
- Retrieve a step for a wizard template
- Method: getPath:
/spms/v1/stepTemplates/{id}
- Retrieve a wizard template
- Method: getPath:
/spms/v1/wizardTemplates/{id}
- Retrieve list of all steps for wizard template
- Method: getPath:
/spms/v1/stepTemplates
- Retrieve lists of all enabled wizard templates
- Method: getPath:
/spms/v1/wizardTemplates/enabled
- Retrieve lists of all wizard templates
- Method: getPath:
/spms/v1/wizardTemplates
- Update a step for a wizard template
- Method: putPath:
/spms/v1/stepTemplates
- Update a wizard template record
- Method: putPath:
/spms/v1/wizardTemplates
- Update print board card option
- Method: putPath:
/spms/v1/configuration/checkIn/boardCardPrinting/{enable}
Profiles/Credit card information
- Retrieve list of active credit cards for a profile
- Method: getPath:
/spms/v1/financials/payments/cards/{profileid}
Profiles/Profile information
- Retrieve a crew profile
- Method: getPath:
/spms/v1/crew/{id}
- Retrieve a guest profile
- Method: getPath:
/spms/v1/guest/{id}
- Retrieve a profile photo
- Method: getPath:
/spms/v1/guest/{accountId}/photo
- Retrieve a resident profile
- Method: getPath:
/spms/v1/resident/{id}
- Retrieve a visitor profile
- Method: getPath:
/spms/v1/visitor/{id}
- Retrieve guests profile with criteria search
- Method: getPath:
/spms/v1/guest
- Retrieve list of adult from search results
- Method: getPath:
/spms/v1/guest/adults
- Retrieve profile details for a guardian associated to a minor
- Method: getPath:
/spms/v1/profiles/{id}/guardians
- Update guest profile details
- Method: postPath:
/spms/v1/guest/infoUpdate
- Upload a profile photo
- Method: postPath:
/spms/v1/guest/photo
Profiles/Special needs assignment
- Retrieve list of special needs assignments for a profile
- Method: getPath:
/spms/v1/profiles/{accountId}/specialNeeds
- Retrieve list of special needs assignments for a profile by profile type
- Method: getPath:
/spms/v1/profiles/{profileType}/{accountId}/specialNeeds
- Update special needs assignments for a profile
- Method: putPath:
/spms/v1/profiles/{accountId}/specialNeeds
- Update special needs assignments for a profile by profile type
- Method: putPath:
/spms/v1/profiles/{profileType}/{accountId}/specialNeeds
Reservations/Excursion
- Retrieve excursion booking details
- Method: getPath:
/spms/v1/excursions/bookings/{reservationId}
Reservations/Folio
- Retrieve folio outstanding balance for a reservation
- Method: getPath:
/spms/v1/folio/{reservationId}
Reservations/Guardian assignment
Guardian information associated with a Profile
- Associate a guardian to a minor.
- Method: postPath:
/spms/v1/guardians/child/{childId}
- Remove/ Delete a guardian associated to a minor
- Method: deletePath:
/spms/v1/guardians/{guardianId}/child/{childId}
- Retrieve list of guardians associated to a minor
- Method: getPath:
/spms/v1/guardians/child/{childId}
- Retrieves a list of all guardians that are associated with minors
- Method: getPath:
/spms/v1/guardians/{guardianId}
Reservations/Onboard status
- Retrieve the onboard status for a profile
- Method: getPath:
/spms/v1/reservations/{reservationId}/onboardStatus
- Update the onboard status for a profile
- Method: putPath:
/spms/v1/reservations/{reservationId}/onboardStatus
Reservations/Payment method assignment
- Retrieve payment method for a reservation
- Method: getPath:
/spms/v1/reservations/{reservationid}/paymentMethod
- Update Payment Method for a reservation
- Method: putPath:
/spms/v1/reservations/{reservationid}/paymentMethod
Reservations/Print board card
Print Jobs
- Create/ Add a print job
- Method: postPath:
/spms/v1/configuration/printerJobs
- Retrieve list of all configured board card printers
- Method: getPath:
/spms/v1/configuration/printers/boardCard
Reservations/Routing instruction
Reservations Routing Instructions Controller
- Retrieve list of all payee details for a profile
- Method: getPath:
/spms/v1/reservations/{profileId}/routingInstructions
- Update payee details to a profile.
- Method: putPath:
/spms/v1/reservations/{profileId}/routingInstructions/paysfor
Reservations/Travelling with
- retrieve a list of guardians that are travelling with
- Method: getPath:
/spms/v1/reservations/{reservationId}/travellingWith/profileSearchTemplate/{templateId}/adults
- Retrieve list of guests that are travelling with the selected guest
- Method: getPath:
/spms/v1/reservations/{reservationId}/travellingWith/profileSearchTemplate/{templateId}
Reservations/Validations/Check-In validations
- Validate required information for checking in a reservation
- Method: postPath:
/spms/v1/reservations/validation/checkIns
Staterooms/Configuration
- Retrieve list of all staterooms
- Method: getPath:
/spms/v1/configurations/staterooms