1. Oracle Hospitality Cruise Property Management REST API 23.3.0
  2. Tasks
  3. Gateway Security
  4. Configuration
  5. Audios

Retrieve a list of gateway security audios

get

/spms/v2/ships/{shipId}/configurations/gatewaySecurity/audios

This is to retrieve a list of gateway security audios.

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Gateway Security Audio Success Oracle Responses list
Type: object
Title: Gateway Security Audio Success Oracle Responses list
The wrapper object when returning successful values in Oracle standard
Show Source
Nested Schema : items
Type: array
Show Source
Example:
[
    {
        "audioId":100001,
        "audioTitle":"GangwayOnboardAllowed",
        "audioFileName":"Example Gangway Onboard Allowed.wav",
        "audioUrl":"/configurations/gangwaySecuritySounds/100001/sound"
    },
    {
        "audioId":100002,
        "audioTitle":"TenderOnboardAllowed",
        "audioFileName":"Example Tender Onboard Allowed.wav",
        "audioUrl":"/configurations/gangwaySecuritySounds/100002/sound"
    }
]
Nested Schema : GatewaySecurityAudioConfigurationItems
Type: object
Gateway Security Audio Items
Show Source
  • Minimum Length: 1
    Maximum Length: 300
    Pattern: ^[^\\\/\"\'`=:;<>@+|?*#%&{}$!]+\.[A-Za-z0-9]+$
    Audio File Name
    Example: Example Gangway Onboard Allowed.wav
  • Minimum Value: 1
    Pattern: ^[0-9]*$
    Audio Id
    Example: 100001
  • Minimum Length: 1
    Maximum Length: 500
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Audio Title
    Example: GangwayOnboardAllowed
  • Audio URL
    Example: /configurations/gangwaySecuritySounds/100001/sound

204 Response

No Content

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":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"You are forbidden to use this API"
}
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

501 Response

Not Implemented
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2",
    "title":"Not implemented",
    "detail":"Resource is not implemented in this version of the API"
}
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":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service not available"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source
Back to Top