1. Oracle Hospitality Cruise Property Management REST API 23.2.2
  2. Tasks
  3. Authentication

Retrieve an application key

get

/spms/access/key

This is to retrieve a application key.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : App key response
Type: object
Title: App key response
The wrapper object when returning successful values in Oracle standard
Show Source
  • Application Key
    Example: 0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF

401 Response

Unauthorized
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

403 Response

Forbidden
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource is forbidden"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

405 Response

Method Not Allowed
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Supported",
    "detail":"HTTP method not supported for this resource"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

406 Response

Not Acceptable
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
    "title":"Not Acceptable",
    "detail":"Request a Mime type that is supported for this Resource"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

415 Response

Unsupported Media Type
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Unsupported Media Type",
    "detail":"Content type not supported"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Internal Server Error",
    "detail":"Issue fulfilling request. Please retry or contact support"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source
Back to Top