1. Oracle Hospitality Cruise REST API
  2. Tasks
  3. Profiles
  4. Analytics

Retrieve list of the status count

get

/spms/v2/ships/{shipId}/analytics/profiles/count

This is to retrieve list of the status count of all people or the selected profile types

Request

Supported Media Types
Path Parameters
Query Parameters
  • Supported profile types values: guest, crew, resident, visitor and is supported multiple values with comma separator. 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.
  • Supported status values: onboard, ashore, checkingOutToday, checkedOut, expected, checkingInToday, checkedIn, cancelled, noShow, overnightTour and is supported multiple values with comma separator
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, totalCheckedOut, totalExpected, totalCheckingInToday, totalCheckedIn, totalCancelled, totalNoShow, totalOvernightTour.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Match All
Show Source
  • AllProfilesAnalytics
    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, totalCheckedOut, totalExpected, totalCheckingInToday, totalCheckedIn, totalCancelled, totalNoShow, totalOvernightTour.
Nested Schema : AllProfilesAnalytics
Type: object
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, totalCheckedOut, totalExpected, totalCheckingInToday, totalCheckedIn, totalCancelled, totalNoShow, totalOvernightTour.
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
    },
    {
        "profileType":"guest",
        "totalOnboard":721,
        "totalAshore":18,
        "totalCheckingOutToday":0,
        "totalCheckedOut":0,
        "totalExpected":0,
        "totalCheckingInToday":0,
        "totalCheckedIn":741,
        "totalCancelled":0,
        "totalNoShow":0,
        "totalOvernightTour":1
    },
    {
        "profileType":"visitor",
        "totalOnboard":3,
        "totalAshore":null,
        "totalCheckingOutToday":null,
        "totalCheckedOut":null,
        "totalExpected":null,
        "totalCheckingInToday":null,
        "totalCheckedIn":null,
        "totalCancelled":null,
        "totalNoShow":null,
        "totalOvernightTour":null
    },
    {
        "profileType":"resident",
        "totalOnboard":4,
        "totalAshore":2,
        "totalCheckingOutToday":0,
        "totalCheckedOut":0,
        "totalExpected":0,
        "totalCheckingInToday":0,
        "totalCheckedIn":6,
        "totalCancelled":0,
        "totalNoShow":0,
        "totalOvernightTour":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