2 Naming Convention for SPMS REST API
The Oracle Hospitality Cruise Property Management REST API adheres to the Oracle REST Standard naming standards.
The API follows a consistent set of conventions to provide an easy, reliable learning environment and use of Oracle Hospitality Cruise Property Management REST APIs.
REST API URL Structure
Access REST resources using the following URL structure:
https://<host-name>/spms/<version>/<resource-path>
-
host-name: Define the host name where SPMS platform is deployed
-
spms: Context path for accessing REST API’s
-
version: Version of the REST API’s exposed
-
resource-path: The relative path that defines the resource.
A complete set of resources can be found on this website Oracle Help Center.
Naming Conventions
Each REST resource has
a unique ID. For example, the resource representing the wizard template
with 1 would be /spms/v1/wizardTemplates/1.
This appears in the API documentation as /spms/v1/wizardTemplates/{id}.
API version numbers appear as v1. Version numbers include a decimal point only when required (for example, for a subsequent minor release) and have a lower case v prefix. Every API access includes the version.