Jump to

• Request
• Response

Services request and onboard activities reservation counts

get

/spms/v2/ships/{shipId}/reservations/{reservationId}/serviceActivitiesCounts

This is to retrieve the services request and onboard activities reservation counts.

Request

Supported Media Types

• application/json

Path Parameters

• reservationId(required): number
  Reservation Id
• shipId(required): number
  ship Id

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object serviceActivitiesCountsResponse
  Service activities counts response

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

Nested Schema : serviceActivitiesCountsResponse

Type: object

Service activities counts response

Show Source

• onboardActivityReservationCount: array onboardActivityReservationCount
  Onboard activity reservation count
• reservationId: number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Reservation Id

  Example: 123
• serviceRequestCount: array serviceRequestCount
  Service request count

{
    "description":"Service activities counts response",
    "type":"object",
    "properties":{
        "reservationId":{
            "description":"Reservation Id",
            "type":"number",
            "minimum":"1",
            "pattern":"^[0-9]*$",
            "example":"123"
        },
        "serviceRequestCount":{
            "description":"Service request count",
            "type":"array",
            "items":{
                "$ref":"#/definitions/serviceRequestCount"
            }
        },
        "onboardActivityReservationCount":{
            "description":"Onboard activity reservation count",
            "type":"array",
            "items":{
                "$ref":"#/definitions/onboardActivityReservationCount"
            }
        }
    }
}

Nested Schema : onboardActivityReservationCount

Type: array

Onboard activity reservation count

Show Source

• Array of: object onboardActivityReservationCount
  Onboard activity reservations count

{
    "description":"Onboard activity reservation count",
    "type":"array",
    "items":{
        "$ref":"#/definitions/onboardActivityReservationCount"
    }
}

Nested Schema : serviceRequestCount

Type: array

Service request count

Show Source

• Array of: object serviceRequestCount
  service request count

{
    "description":"Service request count",
    "type":"array",
    "items":{
        "$ref":"#/definitions/serviceRequestCount"
    }
}

Nested Schema : onboardActivityReservationCount

Type: object

Onboard activity reservations count

Show Source

• spaCount: number
  Spa count with appointment status Expected, In-House and Finished

  Example: 1
• ticketingCount: number
  Ticketing count with booking status Expected and Checked In

  Example: 2

{
    "description":"Onboard activity reservations count",
    "type":"object",
    "properties":{
        "ticketingCount":{
            "description":"Ticketing count with booking status Expected and Checked In",
            "type":"number",
            "example":"2"
        },
        "spaCount":{
            "description":"Spa count with appointment status Expected, In-House and Finished",
            "type":"number",
            "example":"1"
        }
    }
}

Nested Schema : serviceRequestCount

Type: object

service request count

Show Source

• amenitiesCount: number
  Amenities count

  Example: 1
• guestMessageCount: number
  guest message count

  Example: 1
• otherTravelDocumentCount: number
  other travel document count

  Example: 2
• specialNeedsCount: number
  Special needs count

  Example: 2
• specialRequestCount: number
  Special request count

  Example: 1

{
    "description":"service request count",
    "type":"object",
    "properties":{
        "specialNeedsCount":{
            "description":"Special needs count",
            "type":"number",
            "example":"2"
        },
        "specialRequestCount":{
            "description":"Special request count",
            "type":"number",
            "example":"1"
        },
        "amenitiesCount":{
            "description":"Amenities count",
            "type":"number",
            "example":"1"
        },
        "guestMessageCount":{
            "description":"guest message count",
            "type":"number",
            "example":"1"
        },
        "otherTravelDocumentCount":{
            "description":"other travel document count",
            "type":"number",
            "example":"2"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/serviceActivitiesCountErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"Invalid parameter(s) passed in"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"Invalid parameter(s) passed in"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/serviceActivitiesCountErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/serviceActivitiesCountErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource is forbidden"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/serviceActivitiesCountErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/serviceActivitiesCountErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/serviceActivitiesCountErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/serviceActivitiesCountErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable. Try again later"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top