Retrieve configured amenity code records
get
/spms/v2/ships/{shipId}/configurations/amenityCodes
This is to retrieve the configured amenity codes
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: number
Ship Id
Query Parameters
-
amenityCode(optional): string
Amenity Code
-
isEnabled: boolean
Activation status of the Amenity Code record: * `true` - Amenity Code record is enabled * `false` - Amenity Code record is disabled
-
limit: integer(int32)
Minimum Value:
1
Paging limit -
offset: integer(int32)
Minimum Value:
0
Paging offset -
orderBy: string
order by enabled, amenityCode with format column1:asc/desc,column2:asc/desc
Response
Supported Media Types
- application/json
200 Response
Ok
Root Schema : Oracle Responses list
Type:
object
Title:
Oracle 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:
false
-
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 AmenityGETObject
Amenities GET Object
Example:
[
{
"reservationId":123,
"amenityId":456,
"amenityCode":456,
"description":"Wedding Anniversay Cake",
"comments":"5th Wedding Anniversary Celebration",
"codeExtension":256,
"quantity":1,
"price":150,
"cost":75,
"currency":{
"departmentId":"USD",
"comment":"US Dollar"
},
"applicable":"P",
"flag":"N",
"amenityStatus":"Active",
"sender":{
"sender1":"Mr. Niel Down",
"sender2":"Ms. Anna Donimo"
},
"senderMessage":"Happy Wedding Anniversary",
"deliveryStatus":"Pending",
"deliveryDivision":{
"code":"789",
"description":"F&B Services"
},
"deliveryDateTime":"2015-09-09T16:00:00.000+0000",
"deliveryLocation":"Dinner",
"occurrence":"1",
"completedBy":"A",
"completedDateTime":"2015-09-09T16:00:00.000+0000",
"createdBy":"A",
"createdDateTime":"2015-09-09T16:00:00.000+0000",
"lastModifiedDateTime":"2015-09-09T16:00:00.000+0000",
"amenityCancelReason":null
},
{
"reservationId":123,
"amenityId":123,
"amenityCode":821,
"description":"Anniversary Flower Bouquet",
"comments":"5th Wedding Anniversary Celebration",
"codeExtension":256,
"quantity":1,
"price":50,
"cost":10,
"currency":{
"departmentId":"USD",
"comment":"US Dollar"
},
"applicable":"P",
"flag":"N",
"amenityStatus":"Active",
"sender":{
"sender1":"Mr. Niel Down",
"sender2":"Ms. Anna Donimo"
},
"senderMessage":"Happy 5th Wedding Anniversary",
"deliveryDivision":{
"code":"789",
"description":"Front Office Concierge"
},
"deliveryDateTime":"2015-09-09T16:00:00.000+0000",
"deliveryLocation":"Stateroom 19022",
"occurrence":"1",
"completedBy":"HKJackson A",
"completedDateTime":"2015-09-09T16:00:00.000+0000",
"createdBy":"FOPolly Pipe",
"createdDateTime":"2015-09-09T16:00:00.000+0000",
"lastModifiedDateTime":"2015-09-09T16:00:00.000+0000",
"amenityCancelReason":null
},
{
"reservationId":321,
"amenityId":567,
"amenityCode":456,
"description":"Extra Big Towel",
"comments":"Big Towel with logo",
"codeExtension":256,
"quantity":1,
"price":0,
"cost":0,
"currency":{
"departmentId":"",
"comment":""
},
"applicable":"P",
"flag":"N",
"amenityStatus":"Active",
"sender":{
"sender1":"",
"sender2":""
},
"senderMessage":"",
"deliveryStatus":"Delivered",
"deliveryDivision":{
"code":"789",
"description":"Houskeeping"
},
"deliveryDateTime":"2015-09-09T16:00:00.000+0000",
"deliveryLocation":"Stateroom 19022",
"occurrence":"1",
"completedBy":"HKJenny O",
"completedDateTime":"2015-09-09T16:00:00.000+0000",
"createdBy":"FOPolly Pipe",
"createdDateTime":"2015-09-09T16:00:00.000+0000",
"lastModifiedDateTime":"2015-09-09T16:00:00.000+0000",
"amenityCancelReason":null
}
]
Nested Schema : AmenityGETObject
Type:
object
Amenities GET Object
Show Source
-
amenityCancelReason(optional):
string
Minimum Length:
0
Maximum Length:100
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Example:Cancel by Guest
-
amenityCode(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Amenity CodeExample:821
-
amenityId(optional):
number
Minimum Length:
1
Pattern:^[0-9]*$
Amenity IdExample:1001
-
amenityStatus(optional):
string
Allowed Values:
[ "Active", "Cancelled" ]
Amenities StatusExample:Active
-
applicable(optional):
string
Allowed Values:
[ "Pax", "Cabin" ]
ApplicableExample:Pax
-
codeExtension(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Code ExtensionExample:821
-
comments(optional):
string
Maximum Value:
4000
Account Category CommentsExample:The term profit and loss (P&L) statement refers to a financial statement that summarizes the revenues, costs, and expenses incurred during a specified period, usually a quarter or fiscal year. These records provide information about a companys ability or inability to generate profit by increasing revenue, reducing costs, or both. These statements are often presented on a cash or accrual basis.
-
completedBy(optional):
string
Completed ByExample:
FBJohn Quil
-
completedDateTime(optional):
string(date-time)
Example:
2015-09-09T16:00:00.000+0000
-
cost(optional):
number
Pattern:
^[0-9]*$
CostExample:10
-
createdBy(optional):
string
Created ByExample:
FOPolly Pipe
-
createdDateTime(optional):
string(date-time)
Example:
2015-09-09T16:00:00.000+0000
-
currency(optional):
object currency
Currency Group
-
deliveryDateTime(optional):
string(date-time)
Example:
2015-09-09T16:00:00.000+0000
-
deliveryDivision(optional):
object deliveryDivision
Delivery Division Group
-
deliveryLocation(optional):
string
Minimum Length:
0
Maximum Length:30
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Delivery LocationExample:Restaurant Blue Ocean
-
deliveryStatus(optional):
string
Allowed Values:
[ "Pending", "Delivered" ]
Amenity Delivery StatusExample:Pending
-
description(optional):
string
Minimum Value:
1
Maximum Value:1000
Pattern:^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\'\\\":;@`]*$
Account Category DescriptionExample:Profit and Loss Account
-
flag(optional):
string
Minimum Length:
0
Maximum Length:1
Displayed as Flag in the Amenities section in guest billing screen -
lastModifiedDateTime(optional):
string(date-time)
Example:
2015-09-09T16:00:00.000+0000
-
occurrence(optional):
string
Minimum Length:
0
Maximum Length:10
Delivery OccurrenceExample:Once
-
price(optional):
number
Pattern:
^[0-9]*$
PriceExample:10
-
quantity(optional):
number
Pattern:
^[0-9]*$
QuantityExample:1
-
reservationId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Reservation IdExample:1001
-
sender(optional):
object sender
Sender group
-
senderMessage(optional):
string
Minimum Length:
0
Maximum Length:255
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Sender MessageExample:Happy Wedding Anniversary
Nested Schema : currency
Type:
object
Currency Group
Show Source
-
comment(optional):
string
Minimum Length:
0
Maximum Length:1000
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Currency DescriptionExample:US Dollar
-
departmentId(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Currency CodeExample:USD
Nested Schema : deliveryDivision
Type:
object
Delivery Division Group
Show Source
-
code(optional):
string
Minimum Length:
0
Maximum Length:10
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Example:REST
-
description(optional):
string
Minimum Length:
0
Maximum Length:1000
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Example:Restaurant
Nested Schema : sender
Type:
object
Sender group
Show Source
-
sender1(optional):
string
Minimum Length:
0
Maximum Length:255
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Sender 1Example:Mr. Niel Down
-
sender2(optional):
string
Minimum Length:
0
Maximum Length:40
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Sender 2Example:Anna Domino
204 Response
No Content
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