NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Retrieve list of all security alert sounds

get

/spms/v1/configurations/gangwaySecuritySounds/all

This is to retrieve a list of all security alert sounds

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns list of Gangway Security Alert Sound records

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Oracle Response object containing list items
  Title: Oracle Response object containing list items

  The wrapper object when returning a list of objects in Oracle standard

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/securitySoundResponse"
    }
}

Nested Schema : Oracle Response object containing list items

Type: object

Title: Oracle Response object containing list items

The wrapper object when returning a list of objects in Oracle standard

Show Source

• items(optional): array items

{
    "title":"Oracle Response object containing list items",
    "description":"The wrapper object when returning a list of objects in Oracle standard",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/securitySoundList"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object securitySoundList
  securitySoundList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/securitySoundList"
    }
}

Nested Schema : securitySoundList

Type: object

securitySoundList

Show Source

• fileName(optional): string
  Example: Coming Onboard Sound File.wav
• soundId(optional): string
  Example: 1.60000005676E11
• soundUrl(optional): string
  Example: /configurations/gangwaySecuritySounds/160000005676/sound

{
    "description":"securitySoundList",
    "type":"object",
    "properties":{
        "soundUrl":{
            "type":"string",
            "example":"/configurations/gangwaySecuritySounds/160000005676/sound"
        },
        "fileName":{
            "type":"string",
            "example":"Coming Onboard Sound File.wav"
        },
        "soundId":{
            "type":"string",
            "example":1.60000005676E11
        }
    }
}

400 Response

Unknown request found

401 Response

You do not have valid authorization

403 Response

You are not authorized to use the service

404 Response

Record not found

415 Response

Content format not supported

500 Response

Internal server error occurred

Back to Top