Send Requests

Use these guidelines when sending requests using the Oracle Hospitality Cruise Property Management Border Control REST API.

URL Structure

Here's the URL structure for the requests:

https://{host-name}:{port}/spms/{version}/{resource-path}
Where:
  • {host-name}:{port}: Host and port where Border Control is running.

  • spms : Context path for accessing REST API.

  • {version}: Version of the REST API exposed.

  • {resource-path}: Relative path that defines the resource.

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) on resource by using standard HTTP method requests, as summarized in the following table.

HTTP Method Description
GET Retrieve information about the resource.
POST Create the resource.
PUT Update the resource.
DELETE Delete the resource.

Media Types

The following media types are supported by the Oracle Hospitality Cruise Property Management Border Control REST API:

  • application/json

Supported Headers

The Oracle Hospitality Cruise Property Management Border Control REST API supports the following headers that may be passed in the header section of the HTTP request or response.

Header Description Example
Authorization Supply the bearer token to access OAuth 2.0 protected resources. Authorization: Bearer {access-token}
Accept Indicate the content type the client is able to understand. Accept: application/json
Content-Type Media type of the body of the request/response. Content-Type: application/json