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 configurationAmenityCode
configurationAmenityCode
Example:
[
{
"id":1,
"amenityCode":"EXTWL",
"description":"Extra Towel",
"comments":"Bath Towel with big logo",
"isEnabled":true
},
{
"id":2,
"amenityCode":"CHAMAN",
"description":"Champagne - Anniversary",
"comments":"Champage for Wedding Anniversary",
"isEnabled":true
},
{
"id":3,
"amenityCode":"EXPLW",
"description":"Extra Pillow",
"comments":"Additional Big Pillow",
"isEnabled":true
}
]
Nested Schema : configurationAmenityCode
Type:
object
configurationAmenityCode
Show Source
-
amenityCode(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Amenity CodeExample: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.
-
description(optional):
string
Minimum Value:
1
Maximum Value:1000
Pattern:^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\'\\\":;@`]*$
Account Category DescriptionExample:Profit and Loss Account
-
id(optional):
number
Minimum Length:
1
Pattern:^[0-9]*$
Amenity IdExample:1001
-
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
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