Oracle Hospitality Cruise REST API

NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Validate and display customized messages for a profile going ashore

post

/spms/v1/gatewaySecurity/gangway/validations/ashore

This is to validate gangway going ashore rules for a profile and to display list of all customized messages to allow or deny the profile for going ashore

Request

Supported Media Types

application/json

Root Schema : Gangway Ashore Validations Request

Type: object

Title: Gangway Ashore Validations Request

Gangway Ashore Validations Request

Show Source

accountId: integer

This value is the primary key for Gangway Ashore Validations

Example: 1
gateDirection(optional): integer

This is the value to indicate the gate entrance direction. 0 stands for Both Ways, 1 for Outwards and 2 for Inwards

Example: 0
gateType(optional): string

This value indicates which gate type.

Example: Gangway

{
    "title":"Gangway Ashore Validations Request",
    "description":"Gangway Ashore Validations Request",
    "type":"object",
    "properties":{
        "accountId":{
            "type":"integer",
            "example":1,
            "description":"This value is the primary key for Gangway Ashore Validations"
        },
        "gateType":{
            "type":"string",
            "example":"Gangway",
            "description":"This value indicates which gate type."
        },
        "gateDirection":{
            "type":"integer",
            "example":"0",
            "description":"This is the value to indicate the gate entrance direction. 0 stands for Both Ways, 1 for Outwards and 2 for Inwards"
        }
    },
    "required":[
        "accountId"
    ]
}

Response

Supported Media Types

application/json

200 Response

Returns the result of the gangway validations check if this person has a record in Ashore Denied List or if the visa requirement is not complied or if minor who must have guardian presented or people are going for any overnight tour based on the supplied resId, profileId, current timestamp, direction.

Root Schema : Gangway Ashore Validations

Type: object

Title: Gangway Ashore Validations

Gangway Ashore Validations

Show Source

accountId(optional): integer

Guest profile Id.

Example: 838014
gateMovement(optional): string

This is the value to show gate movement

Example: Double Outward
guardianDetails(optional): string

This list is to show the available guardian list for the minor.
guardiansErrorMessage(optional): string

This is the label error message to display on the guardian list for minor.
guardiansMessage(optional): string

This is the label message to display on the guardian list for minor.
hasOvernightTour(optional): integer

Guest has overnight tour or not. 1- has overnight tour, 0- no overnight tour

Example: 1
manifest(optional): boolean

This is to indicate whether got manifest printout

Example: false
movementDirection(optional): string

This is the value to show gate direction

Example: out
movementMessage(optional): string

This is the warning message from movement.

Example: Visitor is double outward entry!
movementTitle(optional): string

Example: Dual Movement Ashore Detected
offboardStatus(optional): boolean

This is to indicate the person is onboard or ashore. offboardStatus true means the person is ashore, false means the person is onboard

Example: true
overnightTourMessage(optional): string

This is the label message to display to indicate whether the person got overnight tour.

Example: <b>Bruno Eric Michael Jackson Raharison</b> is going for an overnight tour.
resultSoundUrl(optional): string

This is the value of result sound URL

Example: /configurations/gangwaySecuritySounds/1234/sound
warning(optional): boolean

This is the value indicate whether this is a warning message.

Example: true

{
    "title":"Gangway Ashore Validations",
    "description":"Gangway Ashore Validations",
    "type":"object",
    "properties":{
        "movementTitle":{
            "type":"string",
            "example":"Dual Movement Ashore Detected"
        },
        "gateMovement":{
            "type":"string",
            "example":"Double Outward",
            "description":"This is the value to show gate movement"
        },
        "movementDirection":{
            "type":"string",
            "example":"out",
            "description":"This is the value to show gate direction"
        },
        "movementMessage":{
            "type":"string",
            "example":"Visitor is double outward entry!",
            "description":"This is the warning message from movement."
        },
        "warning":{
            "type":"boolean",
            "example":true,
            "description":"This is the value indicate whether this is a warning message."
        },
        "accountId":{
            "type":"integer",
            "example":838014,
            "description":"Guest profile Id."
        },
        "hasOvernightTour":{
            "type":"integer",
            "example":"1",
            "description":"Guest has overnight tour or not. 1- has overnight tour, 0- no overnight tour"
        },
        "overnightTourMessage":{
            "type":"string",
            "example":"<b>Bruno Eric Michael Jackson Raharison</b> is going for an overnight tour.",
            "description":"This is the label message to display to indicate whether the person got overnight tour."
        },
        "manifest":{
            "type":"boolean",
            "example":false,
            "description":"This is to indicate whether got manifest printout"
        },
        "offboardStatus":{
            "type":"boolean",
            "example":true,
            "description":"This is to indicate the person is onboard or ashore. offboardStatus true means the person is ashore, false means the person is onboard"
        },
        "resultSoundUrl":{
            "type":"string",
            "example":"/configurations/gangwaySecuritySounds/1234/sound",
            "description":"This is the value of result sound URL"
        },
        "guardianDetails":{
            "type":"string",
            "description":"This list is to show the available guardian list for the minor."
        },
        "guardiansMessage":{
            "type":"string",
            "description":"This is the label message to display on the guardian list for minor."
        },
        "guardiansErrorMessage":{
            "type":"string",
            "description":"This is the label error message to display on the guardian list for minor."
        }
    }
}

400 Response

The supplied parameter(s) is not valid

Root Schema : Oracle Response returned in singular object

Type: object

Title: Oracle Response returned in singular object

The object returned in Oracle Standard when function is executed successfully

Show Source

item(optional): array item

A list of objects that contains error messages and fields grouped by category.

{
    "title":"Oracle Response returned in singular object",
    "description":"The object returned in Oracle Standard when function is executed successfully",
    "type":"object",
    "properties":{
        "item":{
            "type":"array",
            "description":"A list of objects that contains error messages and fields grouped by category."
        }
    }
}

Nested Schema : item

Type: array

A list of objects that contains error messages and fields grouped by category.

Example Response (application/json)

{
    "movementTitle":"ASHORE DENIED",
    "gateMovement":"Going Shore-side",
    "movementDirection":"ASHORE",
    "movementMessage":"Have fun in the City.",
    "warning":false,
    "accountId":838014,
    "hasOvernightTour":0,
    "overnightTourMessage":"Bruno Eric Michael Jackson Raharison is going for an overnight tour.",
    "manifest":false,
    "offboardStatus":true,
    "resultSoundUrl":"/configurations/gangwaySecuritySounds/1234/sound",
    "guardianDetails":[
        {
            "accountId":1234,
            "guardians":[
                {
                    "accountId":1122,
                    "salutation":"Mr.",
                    "firstName":"Kobe",
                    "middleName":"Bean",
                    "lastName":"James",
                    "stateRoom":601,
                    "photoUrl":"https://oracle.com/resources/james.jpg",
                    "accountType":"P",
                    "links":[
                    ]
                },
                {
                    "accountId":3322,
                    "salutation":"Mr.",
                    "firstName":"Giannis",
                    "middleName":"Bean",
                    "lastName":"Gigi",
                    "stateRoom":603,
                    "photoUrl":"https://oracle.com/resources/gigi.jpg",
                    "accountType":"P",
                    "links":[
                    ]
                }
            ]
        },
        {
            "accountId":5555,
            "guardians":[
                {
                    "accountId":2221,
                    "salutation":"Mr.",
                    "firstName":"Manu",
                    "middleName":"Yue",
                    "lastName":"Wade",
                    "stateRoom":777,
                    "photoUrl":"https://oracle.com/resources/wade.jpg",
                    "accountType":"P",
                    "links":[
                    ]
                }
            ]
        }
    ],
    "guardiansMessage":"Please verify the guardian present that will accompany kid middleName kid ashore",
    "guardiansErrorMessage":"A guardian should be physically present with kid middleName kid.",
    "details":[
        {
            "step":"SHORESIDE DENIED",
            "override":true,
            "error":{
                "errorPath":"shoreLeaveDenied",
                "message":"Please see the crew purser."
            },
            "soundUrl":"/configurations/gangwaySecuritySounds/4567/sound"
        },
        {
            "step":"VISA VALIDITY",
            "override":false,
            "error":{
                "errorPath":"visa",
                "message":"This person do not have valid visa"
            },
            "soundUrl":"/configurations/gangwaySecuritySounds/8568/sound"
        },
        {
            "step":"SAG",
            "override":true,
            "error":{
                "errorPath":"sag",
                "message":"Do not allow minor without guardian to go shoreside"
            },
            "soundUrl":"/configurations/gangwaySecuritySounds/1456/sound"
        },
        {
            "step":"GUARDIAN",
            "override":false,
            "error":{
                "errorPath":"guardian",
                "message":"Guest is minor, please assign a guardian!"
            },
            "soundUrl":"/configurations/gangwaySecuritySounds/9438/sound"
        }
    ]
}

401 Response

You are not authorized to use this API

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail(optional): string

Example: There are validation errors for the object......
title(optional): string

Example: validation fails for row with key={123}
type(optional): string

Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

403 Response

You are forbidden to use this API

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail(optional): string

Example: There are validation errors for the object......
title(optional): string

Example: validation fails for row with key={123}
type(optional): string

Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

404 Response

The Gangway Ashore Validations does not exist

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail(optional): string

Example: There are validation errors for the object......
title(optional): string

Example: validation fails for row with key={123}
type(optional): string

Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

405 Response

This method is not available

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail(optional): string

Example: There are validation errors for the object......
title(optional): string

Example: validation fails for row with key={123}
type(optional): string

Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

406 Response

Account Type not valid

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail(optional): string

Example: There are validation errors for the object......
title(optional): string

Example: validation fails for row with key={123}
type(optional): string

Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

415 Response

This media supplied is not supported

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail(optional): string

Example: There are validation errors for the object......
title(optional): string

Example: validation fails for row with key={123}
type(optional): string

Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

500 Response

Error occured while processing this request

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail(optional): string

Example: There are validation errors for the object......
title(optional): string

Example: validation fails for row with key={123}
type(optional): string

Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

502 Response

Bad Gateway

503 Response

Service not available