1. Oracle Hospitality Cruise Property Management REST API 23.2.2
  2. Tasks
  3. Configurations
  4. OPI

Update OPI configurations in SPMS

put

/spms/v2/ships/{shipId}/configurations/OPI

This is to update the OPI configurations in SPMS

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : OPI Configuration Request
Type: object
Title: OPI Configuration Request
OPI Configuration Request
Show Source
  • Pattern: ^(?=.*[Dd]{2})(?=.*[Mm]{2})(?=.*[Yy]{4})[DdMmYy]{8}$
    Date Format
    Example: yyyyMMdd
  • EFT Timeout
    Example: 60
  • This is to indicate whether the OPI Configuration is enabled or not enabled
    Example: true
  • Maximum Length: 50
    Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    Key
    Example: ABCDEFGHIJKLMNOPQRSTUVWXYZ@#
  • Maximum Length: 50
    Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    Merchant ID
    Example: OHC|VM1234
  • Maximum Value: 65535
    Port Number
    Example: 14001
  • Default Value: hh:mm:ss tt
    Allowed Values: [ "h:mm:ss tt", "hh:mm:ss tt", "H:mm:ss", "HH:mm:ss" ]
    Long Time Format * hh:mm:ss tt - example: 08:20:33 AM * h:mm:ss tt - example: 8:20:33 AM * H:mm:ss - example: 8:20:33 * HH:mm:ss - example: 08:20:33
    Example: hh:mm:ss tt
Back to Top

Response

Supported Media Types

200 Response

Updated
Body ()
Root Schema : OPI Configuration Success Responses list
Type: object
Title: OPI Configuration Success Responses list
The wrapper object when returning successful values in Oracle standard
Show Source
  • Pattern: ^(?=.*[Dd]{2})(?=.*[Mm]{2})(?=.*[Yy]{4})[DdMmYy]{8}$
    Date Format
    Example: yyyyMMdd
  • EFT Timeout
    Example: 60
  • This is to indicate whether the OPI Configuration is enabled or not enabled
    Example: true
  • Maximum Length: 50
    Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    Key
    Example: ABCDEFGHIJKLMNOPQRSTUVWXYZ@#
  • Maximum Length: 50
    Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    Merchant ID
    Example: OHC|VM1234
  • Maximum Value: 65535
    Port Number
    Example: 14001
  • Default Value: hh:mm:ss tt
    Allowed Values: [ "h:mm:ss tt", "hh:mm:ss tt", "H:mm:ss", "HH:mm:ss" ]
    Long Time Format * hh:mm:ss tt - example: 08:20:33 AM * h:mm:ss tt - example: 8:20:33 AM * H:mm:ss - example: 8:20:33 * HH:mm:ss - example: 08:20:33
    Example: hh:mm:ss tt

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter shipId has incorrect format"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

401 Response

Unauthorized
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"HTTP://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

404 Response

Not Found
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship Id could not be found"
}
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":"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":"Invalid content",
    "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":"HTTP://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

503 Response

Service Unavailable
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service Unavailable. Try again later"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source
Back to Top