Create a new amenity record
post
/spms/v2/ships/{shipId}/reservations/{reservationId}/amenities
This is to create a new amenity record
Request
Supported Media Types
- application/json
Path Parameters
-
reservationId: number
Reservation Id
-
shipId: number
Ship Id
Amenity Post Object
Root Schema : AmenityPOSTObject
Type:
object
Amenities POST 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
-
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.
-
cost(optional):
number
Pattern:
^[0-9]*$
CostExample:10
-
currencyCode(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Currency CodeExample:USD
-
deliveryDateTime(optional):
string(date-time)
Example:
2015-09-09T16:00:00.000+0000
-
deliveryDivisionCode(optional):
string
Minimum Length:
0
Maximum Length:10
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Example:REST
-
deliveryLocation(optional):
string
Minimum Length:
0
Maximum Length:30
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Delivery LocationExample:Restaurant Blue Ocean
-
flag(optional):
string
Minimum Length:
0
Maximum Length:1
Displayed as Flag in the Amenities section in guest billing screen -
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
-
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
-
senderMessage(optional):
string
Minimum Length:
0
Maximum Length:255
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Sender MessageExample:Happy Wedding Anniversary
Response
Supported Media Types
- application/json
201 Response
Created
Root 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
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":"Access to this resource was forbidden"
}
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 Allowed",
"detail":"The method is not available"
}
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