1. Oracle Hospitality Cruise Property Management Border Control REST API 23.1.0
  2. Tasks
  3. Authentication

Register Client Application

post

/spms/access/clients

To register client application to API

Request

Supported Media Types
Body ()
Root Schema : clientRegistrationRequest
Type: object
Show Source
  • Pattern: ^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\":;@`]*$
    Your password. Mandatory for password login.
  • Pattern: ^[A-Za-z0-9-_.]{2,20}$
    Your username. Mandatory for password login.
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : clientRegistrationResponse
Type: object
Show Source
  • Pattern: ^[A-Z0-9]+?$
    Randomly generated 16-bytes (32-characters) hex string value for client application registration
    Example: C24CCDE1FEE372A152956675B1D14E6C

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "error":"invalid_grant",
    "error_description":"Bad credentials"
}
Nested Schema : clientRegistrationErrorResponse
Type: object
Show Source
  • Pattern: ^[A-Za-z0-9-_.]+$
    Code representing the reason why the attempt to authenticate the user failed.
    Example: invalid_grant
  • Pattern: ^[A-Za-z0-9-_.]+$
    Short human readable description of why the attempt to authenticate failed.
    Example: Bad credentials

401 Response

Unauthorized
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "error":"unauthorized",
    "error_description":"Authentication Failed. Username or Password not valid."
}
Nested Schema : clientRegistrationErrorResponse
Type: object
Show Source
  • Pattern: ^[A-Za-z0-9-_.]+$
    Code representing the reason why the attempt to authenticate the user failed.
    Example: invalid_grant
  • Pattern: ^[A-Za-z0-9-_.]+$
    Short human readable description of why the attempt to authenticate failed.
    Example: Bad credentials

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":"http://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