Jump to

• Request
• Response

Retrieve Package Plan entitlements by reservation Id

get

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

This is to retrieve all Package Plan entitlements by the reservation Id

Request

Supported Media Types

• application/json

Path Parameters

• reservationId: number
• shipId: number
  Ship Id

Query Parameters

• isEnabled: boolean
  Activation status of the Package Plan record: * `true` - Package Plan record is enabled * `false` - Package Plan record is disabled
• limit: integer(int32)
  Minimum Value: 1

  Paging limit
• offset: integer(int32)
  Minimum Value: 0

  Paging offset
• orderBy: string
  order by packagePlanName and packagePlanStatus with format column1:asc/desc,column2:asc/desc
• packagePlanId(optional): number
  Package Plan Id
• packagePlanName(optional): string
  Package Plan Name

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Oracle Response

Type: object

Title: Oracle Response

The wrapper object when returning successful values in Oracle standard

Show Source

• count(optional): number
  The total number of items in the list.

  Example: 20
• items(optional): array items
• limit(optional): number
  Paging limit

  Example: 1
• offset(optional): number
  Paging offset

  Example: 10

{
    "title":"Oracle Response",
    "description":"The wrapper object when returning successful values in Oracle standard",
    "type":"object",
    "properties":{
        "count":{
            "description":"The total number of items in the list.",
            "type":"number",
            "example":20
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/packagePlanDetails"
            },
            "example":[
                {
                    "reservationId":1254985696,
                    "packagePlanId":2223333,
                    "packagePlanName":"Food Only",
                    "totalValue":0,
                    "redeemedValue":0,
                    "availableValue":0,
                    "isEnabled":true,
                    "totalQuantity":10,
                    "redeemedQuantity":3,
                    "assignedDate":"2009-10-31"
                }
            ]
        },
        "limit":{
            "description":"Paging limit",
            "type":"number",
            "example":1
        },
        "offset":{
            "description":"Paging offset",
            "type":"number",
            "example":10
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: array packagePlanDetails
  Package Plan Details

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/packagePlanDetails"
    },
    "example":[
        {
            "reservationId":1254985696,
            "packagePlanId":2223333,
            "packagePlanName":"Food Only",
            "totalValue":0,
            "redeemedValue":0,
            "availableValue":0,
            "isEnabled":true,
            "totalQuantity":10,
            "redeemedQuantity":3,
            "assignedDate":"2009-10-31"
        }
    ]
}

Example:

[
    {
        "reservationId":1254985696,
        "packagePlanId":2223333,
        "packagePlanName":"Food Only",
        "totalValue":0,
        "redeemedValue":0,
        "availableValue":0,
        "isEnabled":true,
        "totalQuantity":10,
        "redeemedQuantity":3,
        "assignedDate":"2009-10-31"
    }
]

Nested Schema : packagePlanDetails

Type: array

Package Plan Details

Show Source

• Array of: object packagePlans
  Package Plan Details

{
    "description":"Package Plan Details",
    "type":"array",
    "items":{
        "$ref":"#/definitions/packagePlans"
    },
    "example":[
        {
            "packagePlanId":2223333,
            "packagePlanName":"Food Only",
            "totalValue":0,
            "redeemedValue":0,
            "availableValue":0,
            "isEnabled":true,
            "totalQuantity":10,
            "redeemedQuantity":3,
            "assignedDate":"2009-10-31"
        }
    ]
}

Example:

[
    {
        "packagePlanId":2223333,
        "packagePlanName":"Food Only",
        "totalValue":0,
        "redeemedValue":0,
        "availableValue":0,
        "isEnabled":true,
        "totalQuantity":10,
        "redeemedQuantity":3,
        "assignedDate":"2009-10-31"
    }
]

Nested Schema : packagePlans

Type: object

Package Plan Details

Show Source

• assignedDate(optional): string(ISO 8601)
  Assigned Date

  Example: 2009-10-31
• availableValue(optional): number
  Available Value

  Example: 0
• isEnabled(optional): boolean
  This is to indicate switch to enable / disable account category (default value: true) * `true` - Enable account category * `false` - Disable account category

  Example: true
• packagePlanId(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Package Plan Id

  Example: 2223333
• packagePlanName(optional): string
  Package Plan Name

  Example: Food Only
• redeemedQuantity(optional): number
  Total Redeem Quantity

  Example: 3
• redeemedValue(optional): number
  Redeemed Value

  Example: 0
• totalQuantity(optional): number
  Total Quantity

  Example: 10
• totalValue(optional): number
  Total Value

  Example: 0

{
    "description":"Package Plan Details",
    "type":"object",
    "properties":{
        "packagePlanId":{
            "$ref":"#/definitions/packagePlanId"
        },
        "packagePlanName":{
            "$ref":"#/definitions/packagePlanName"
        },
        "totalValue":{
            "$ref":"#/definitions/totalValue"
        },
        "redeemedValue":{
            "$ref":"#/definitions/redeemedValue"
        },
        "availableValue":{
            "$ref":"#/definitions/availableValue"
        },
        "isEnabled":{
            "$ref":"#/definitions/isEnabled"
        },
        "totalQuantity":{
            "$ref":"#/definitions/totalQuantity"
        },
        "redeemedQuantity":{
            "$ref":"#/definitions/redeemedQuantity"
        },
        "assignedDate":{
            "$ref":"#/definitions/assignedDate"
        }
    }
}

204 Response

No Content

401 Response

You are not authorized to use this API

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/PackagePlanDetailsErrorResponse"
        }
    ],
    "example":{
        "title":"Unauthorized",
        "detail":"Valid token is required to access this resource",
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2"
    }
}

Example:

{
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): 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

You are forbidden to use this API

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

Example:

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

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

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

404 Response

Not Found

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/PackagePlanDetailsErrorResponse"
        }
    ],
    "example":{
        "title":"Not Found",
        "detail":"Reservation not found",
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
    }
}

Example:

{
    "title":"Not Found",
    "detail":"Reservation not found",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): 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

This method is not available

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/PackagePlanDetailsErrorResponse"
        }
    ],
    "example":{
        "title":"Method Not Supported",
        "detail":"HTTP method not supported for this resource",
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6"
    }
}

Example:

{
    "title":"Method Not Supported",
    "detail":"HTTP method not supported for this resource",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): 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

Error occured while processing this request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/PackagePlanDetailsErrorResponse"
        }
    ],
    "example":{
        "title":"Internal Server Error",
        "details":"Issue fulfilling request. Please retry or contact support",
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1"
    }
}

Example:

{
    "title":"Internal Server Error",
    "details":"Issue fulfilling request. Please retry or contact support",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

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

501 Response

Not implemented

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/PackagePlanDetailsErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2",
        "title":"Not implemented",
        "detail":"Resource is not implemented in this version of the API"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2",
    "title":"Not implemented",
    "detail":"Resource is not implemented in this version of the API"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): 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/PackagePlanDetailsErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service not available"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service not available"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): 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