1. Oracle Hospitality Cruise Property Management REST API 23.3.3
  2. Tasks
  3. Gangway
  4. Analytics

Retrieve list of the gangway analytics count

get

/spms/v2/ships/{shipId}/gatewaySecurity/gangway/analytics/count

This is to retrieve gangway analytics count for all people or for the selected profile types.

Request

Supported Media Types
Path Parameters
Query Parameters
  • Supports multiple profile type values: guest, crew, resident, visitor and staff. If resident passing in profileType, based on Use Resident parameter. If true (Use Resident) results responded in list. Else (Do not Use Resident) return 400- Resident not supported.
    • Allowed Values: [ "guest", "crew", "resident", "visitor", "staff" ]
  • Supports multiple status values: onboard, ashore, checkingOutToday, checkedOut, expected, checkingInToday, checkedIn, cancelled, noShow and overnightTour.
    • Allowed Values: [ "onboard", "ashore", "checkingOutToday", "checkedOut", "expected", "checkingInToday", "checkedIn", "cancelled", "noShow", "overnightTour" ]
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Oracle Responses - All Profiles Analytics
Type: object
Title: Oracle Responses - All Profiles Analytics
Profile Analytics responses. For visitor profileTypes, based on RequireVisitorToCheckIn parameter. If false (Do not required check-in) totalAshore= -1 (not supported), same apply to totalCheckingOutToday, totalCheckingOutTodayAdult, totalCheckingOutTodayMinor, totalCheckedOut, totalCheckedOutAdult, totalCheckedOutMinor, totalExpected, totalExpectedAdult, totalExpectedMinor, totalCheckingInToday, totalCheckingInTodayAdult, totalCheckingInTodayMinor, totalCheckedIn, totalCheckedInAdult, totalCheckedInMinor, totalCancelled, totalNoShow, totalOvernightTour.
Show Source
Nested Schema : AllGangwayAnalytics
Type: object
Profile Analytics responses. For visitor profileTypes, based on RequireVisitorToCheckIn parameter.
Show Source
Example:
[
    {
        "profileType":"crew",
        "totalOnboard":764,
        "totalAshore":21,
        "totalCheckingOutToday":0,
        "totalCheckedOut":0,
        "totalExpected":0,
        "totalCheckingInToday":0,
        "totalCheckedIn":785,
        "totalCancelled":0,
        "totalNoShow":0,
        "totalOvernightTour":0,
        "totalCheckingInTodayVip":null,
        "totalCheckedInVip":null,
        "totalOnboardVisitorNamed":null,
        "totalOnboardVisitorGeneric":null,
        "totalOnboardAdult":700,
        "totalOnboardMinor":64,
        "totalAshoreAdult":20,
        "totalAshoreMinor":1,
        "totalCheckingOutTodayAdult":0,
        "totalCheckingOutTodayMinor":0,
        "totalCheckedOutAdult":0,
        "totalCheckedOutMinor":0,
        "totalExpectedAdult":0,
        "totalExpectedMinor":0,
        "totalCheckingInTodayAdult":0,
        "totalCheckingInTodayMinor":0,
        "totalCheckedInAdult":700,
        "totalCheckedInMinor":85
    },
    {
        "profileType":"guest",
        "totalOnboard":721,
        "totalAshore":18,
        "totalCheckingOutToday":0,
        "totalCheckedOut":0,
        "totalExpected":0,
        "totalCheckingInToday":0,
        "totalCheckedIn":741,
        "totalCancelled":0,
        "totalNoShow":0,
        "totalOvernightTour":1,
        "totalCheckingInTodayVip":10,
        "totalCheckedInVip":50,
        "totalOnboardVisitorNamed":null,
        "totalOnboardVisitorGeneric":null,
        "totalOnboardAdult":600,
        "totalOnboardMinor":121,
        "totalAshoreAdult":15,
        "totalAshoreMinor":3,
        "totalCheckingOutTodayAdult":0,
        "totalCheckingOutTodayMinor":0,
        "totalCheckedOutAdult":0,
        "totalCheckedOutMinor":0,
        "totalExpectedAdult":0,
        "totalExpectedMinor":0,
        "totalCheckingInTodayAdult":0,
        "totalCheckingInTodayMinor":0,
        "totalCheckedInAdult":700,
        "totalCheckedInMinor":41
    },
    {
        "profileType":"visitor",
        "totalOnboard":3,
        "totalAshore":0,
        "totalCheckingOutToday":null,
        "totalCheckedOut":null,
        "totalExpected":null,
        "totalCheckingInToday":null,
        "totalCheckedIn":null,
        "totalCancelled":null,
        "totalNoShow":null,
        "totalOvernightTour":null,
        "totalCheckingInTodayVip":0,
        "totalCheckedInVip":0,
        "totalOnboardVisitorNamed":2,
        "totalOnboardVisitorGeneric":1,
        "totalOnboardAdult":3,
        "totalOnboardMinor":0,
        "totalAshoreAdult":0,
        "totalAshoreMinor":0,
        "totalCheckingOutTodayAdult":null,
        "totalCheckingOutTodayMinor":null,
        "totalCheckedOutAdult":null,
        "totalCheckedOutMinor":null,
        "totalExpectedAdult":null,
        "totalExpectedMinor":null,
        "totalCheckingInTodayAdult":null,
        "totalCheckingInTodayMinor":null,
        "totalCheckedInAdult":null,
        "totalCheckedInMinor":null
    },
    {
        "profileType":"resident",
        "totalOnboard":4,
        "totalAshore":2,
        "totalCheckingOutToday":0,
        "totalCheckedOut":0,
        "totalExpected":0,
        "totalCheckingInToday":0,
        "totalCheckedIn":6,
        "totalCancelled":0,
        "totalNoShow":0,
        "totalOvernightTour":0,
        "totalCheckingInTodayVip":0,
        "totalCheckedInVip":20,
        "totalOnboardVisitorNamed":null,
        "totalOnboardVisitorGeneric":null,
        "totalOnboardAdult":4,
        "totalOnboardMinor":0,
        "totalAshoreAdult":2,
        "totalAshoreMinor":0,
        "totalCheckingOutTodayAdult":0,
        "totalCheckingOutTodayMinor":0,
        "totalCheckedOutAdult":0,
        "totalCheckedOutMinor":0,
        "totalExpectedAdult":0,
        "totalExpectedMinor":0,
        "totalCheckingInTodayAdult":0,
        "totalCheckingInTodayMinor":0,
        "totalCheckedInAdult":6,
        "totalCheckedInMinor":0
    },
    {
        "profileType":"staff",
        "totalOnboard":20,
        "totalAshore":5,
        "totalCheckingOutToday":0,
        "totalCheckedOut":0,
        "totalExpected":0,
        "totalCheckingInToday":0,
        "totalCheckedIn":6,
        "totalCancelled":0,
        "totalNoShow":0,
        "totalOvernightTour":0,
        "totalCheckingInTodayVip":null,
        "totalCheckedInVip":null,
        "totalOnboardVisitorNamed":null,
        "totalOnboardVisitorGeneric":null,
        "totalOnboardAdult":20,
        "totalOnboardMinor":0,
        "totalAshoreAdult":5,
        "totalAshoreMinor":0,
        "totalCheckingOutTodayAdult":0,
        "totalCheckingOutTodayMinor":0,
        "totalCheckedOutAdult":0,
        "totalCheckedOutMinor":0,
        "totalExpectedAdult":0,
        "totalExpectedMinor":0,
        "totalCheckingInTodayAdult":0,
        "totalCheckingInTodayMinor":0,
        "totalCheckedInAdult":6,
        "totalCheckedInMinor":0
    }
]

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":"Invalid profileType for status count of all people and the selected profile type"
}
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":"Unauthorised",
    "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":"Access to this resource was 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 123 was not 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":"https://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

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

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