Retrieve Configured Discount Template record
get
/spms/v2/ships/{shipId}/configurations/financials/discountTemplates
This is to retrieve the configured Discount Template
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: number
Ship Id
Query Parameters
-
discountTemplateName(optional): string
Discount Template Name
-
isEnabled: boolean
Activation status of the Discount Template record: * `true` - Discount Template record is enabled * `false` - Discount Template record is disabled
-
limit: integer(int32)
Minimum Value:
1
Paging limit -
offset: integer(int32)
Minimum Value:
0
Paging offset -
orderBy: string
order by discountTemplateName, isEnabled with format column1:asc/desc,column2:asc/desc
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Discount Template Responses list
Type:
object
Title:
Discount Template Responses list
The wrapper object when returning successful values in Oracle standard
Show Source
-
count(optional):
number
The total number of items in the list.Example:
3
-
hasMore(optional):
boolean
Flag which indicates whether or not there are more items.Example:
true
-
items(optional):
array items
-
limit(optional):
number
Paging limitExample:
5
-
offset(optional):
number
Paging offsetExample:
10
Nested Schema : items
Type:
Show Source
array
-
Array of:
object configurationDiscountTemplate
configurationDiscountTemplate
Example:
[
{
"discountTemplateId":1,
"discountTemplateName":"VIP Gold Discount Entitlement",
"departmentEntitlementCode":[
{
"departmentCode":2000,
"departmentDescription":"Ocean Bar",
"subDepartmentEntitlementCode":{
"subDepartmentCode":2001,
"subDepartmentDescription":"Ocean Bar - Alc Beverage",
"discountByPercentage":10,
"discountByAmount":0,
"numberOfCount":1,
"discountReason":"VIP Gold Entitlement",
"actualPosting":true,
"futurePosting":false
}
},
{
"departmentCode":2500,
"departmentDescription":"Jungle Bar",
"subDepartmentEntitlementCode1":{
"subDepartmentCode":2501,
"subDepartmentDescription":"Jungle Bar - Alc Beverage",
"discountByPercentage":10,
"discountByAmount":0,
"numberOfCount":1,
"discountReason":"VIP Gold Entitlement",
"actualPosting":true,
"futurePosting":false
}
}
],
"isEnabled":true
},
{
"discountTemplateId":2,
"discountTemplateName":"VIP Platinum Discount Entitlement",
"departmentEntitlementCode":{
"departmentCode":2000,
"departmentDescription":"Ocean Bar",
"subDepartmentEntitlementCode":[
{
"subDepartmentCode":2001,
"subDepartmentDescription":"Ocean Bar - Food",
"discountByPercentage":15,
"discountByAmount":0,
"numberOfCount":1,
"discountReason":"VIP Platinum Entitlement",
"actualPosting":true,
"futurePosting":false
},
{
"subDepartmentCode":2002,
"subDepartmentDescription":"Ocean Bar - Non Alc Beverage",
"discountByPercentage":15,
"discountByAmount":0,
"numberOfCount":1,
"discountReason":"VIP Platinum Entitlement",
"actualPosting":true,
"futurePosting":false
},
{
"subDepartmentCode":2003,
"subDepartmentDescription":"Ocean Bar - Alc Beverage",
"discountByPercentage":15,
"discountByAmount":0,
"numberOfCount":1,
"discountReason":"VIP Platinum Entitlement",
"actualPosting":true,
"futurePosting":false
}
]
},
"isEnabled":true
},
{
"discountTemplateId":3,
"discountTemplateName":"Crew Discount",
"departmentEntitlementCode":{
"departmentCode":7000,
"departmentDescription":"Crew Bar",
"subDepartmentEntitlementCode":{
"subDepartmentCode":7001,
"subDepartmentDescription":"Crew Bar - Food",
"discountByPercentage":10,
"discountByAmount":0,
"numberOfCount":1,
"discountReason":"Crew Discount Entitlement",
"actualPosting":true,
"futurePosting":false
}
},
"isEnabled":true
}
]
Nested Schema : configurationDiscountTemplate
Type:
object
configurationDiscountTemplate
Show Source
-
departmentEntitlementCode(optional):
object departmentEntitlementCode
Department Entitlement Code Group
-
discountTemplateId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Discount Template IdExample:1001
-
discountTemplateName(optional):
string
Minimum Length:
0
Maximum Length:50
Pattern:^[a-zA-Z0-9 ]+?$
Discount Template NameExample:VIP Gold Discount Entitlement
-
isEnabled(optional):
boolean
This is to indicate switch to enable / disable account category (default value: true) * `true` - Enable account category * `false` - Disable account categoryExample:
true
Nested Schema : departmentEntitlementCode
Type:
object
Department Entitlement Code Group
Show Source
-
departmentCode(optional):
string
Minimum Length:
1
Maximum Length:10
Pattern:^[a-zA-Z0-9]{1,10}$
Department CodeExample:X2000
-
departmentDescription(optional):
string
Minimum Length:
0
Maximum Length:50
Department DescriptionExample:Ocean Bar
-
subDepartmentEntitlementCode(optional):
object subDepartmentEntitlementCode
Sub Department Entitlement Code Group
-
Array of:
object departmentEntitlementCode
Department Entitlement Code Group
Nested Schema : subDepartmentEntitlementCode
Type:
object
Sub Department Entitlement Code Group
Show Source
-
actualPosting(optional):
boolean
Actual PostingExample:
true
-
discountByAmount(optional):
number
Minimum Value:
0
Pattern:^[0-9]*$
Discount by AmountExample:100
-
discountByPercentage(optional):
number
Minimum Value:
0
Maximum Value:100
Pattern:^[0-9]$|^[1-9][0-9]$|^(100)$
Discount by PercentageExample:10
-
discountReason(optional):
string
Minimum Length:
0
Maximum Length:50
Discount ReasonExample:VIP Gold Alc. Beverage Discount 10%
-
futurePosting(optional):
boolean
Future PostingExample:
true
-
numberOfCount(optional):
number
Pattern:
^-?[0-9]*$
Number of CountExample:1
-
subDepartmentCode(optional):
string
Minimum Length:
1
Maximum Length:10
Pattern:^[a-zA-Z0-9]{1,10}$
Sub Department CodeExample:X2001
-
subDepartmentDescription(optional):
string
Minimum Length:
0
Maximum Length:50
Sub Department DescriptionExample:Ocean Bar - Alc Beverage
-
Array of:
object subDepartmentEntitlementCode
Sub Department Entitlement Code Group
204 Response
No Content
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Forbidden",
"detail":"You are forbidden to use this API"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
404 Response
Not Found
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
"title":"Not Found",
"detail":"Ship Id could not be found"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
410 Response
Gone
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
"title":"Gone",
"detail":"Requested Resource no longer exists"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
415 Response
Unsupported Media Type
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
"title":"Unsupported Media Type",
"detail":"Content type not supported"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
501 Response
Not Implemented
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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