Create a special request by reservation ID
post
/spms/v2/ships/{shipId}/reservations/{reservationId}/specialRequests
This is to create a special request to a specific reservation ID
Request
Supported Media Types
- application/json
Path Parameters
-
reservationId: number
Reservation Id
-
shipId: number
Ship Id
Special Request Post Object
Root Schema : SpecialRequestPOSTObject
Type:
object
SpecialRequest POST Object
Show Source
-
deliveredDateTime(optional):
string(date-time)
Example:
2018-08-08T20:00:00
-
deliveryLocation(optional):
string
Minimum Length:
0
Maximum Length:30
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Delivery LocationExample:Stateroom 1001
-
deliveryStatus(optional):
string
Allowed Values:
[ "Pending", "Delivered" ]
Special Request Delivery StatusExample:Delivered
-
externalCode(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
External CodeExample:123
-
quantity(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
QuantityExample:3
-
requestedDateTime(optional):
string(date-time)
Example:
2015-09-09T16:00:00
-
specialRequestActionCode(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Special Request Action CodeExample:BIRTHC
-
specialRequestActionDepartmentCode(optional):
string
Minimum Length:
1
Maximum Length:10
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Special Request Action Department CodeExample:111
-
specialRequestActionDescription(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Special Request Action DescriptionExample:Birthday Cake Celebration
Response
Supported Media Types
- application/json
201 Response
Created
Root Schema : SpecialRequestGETObject
Type:
object
SpecialRequest GET Object
Show Source
-
completedDateTime(optional):
string(date)
Example:
2018-11-11T23:00:00
-
createdBy(optional):
string
Created ByExample:
Jessica Sue
-
createdDateTime(optional):
string(date)
Example:
2018-08-08T18:00:00
-
deliveredBy(optional):
string
Delivered ByExample:
Jason Tan
-
deliveredDateTime(optional):
string(date-time)
Example:
2018-08-08T20:00:00
-
deliveryLocation(optional):
string
Minimum Length:
0
Maximum Length:30
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Delivery LocationExample:Stateroom 1001
-
deliveryStatus(optional):
string
Allowed Values:
[ "Pending", "Delivered" ]
Special Request Delivery StatusExample:Delivered
-
externalCode(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
External CodeExample:123
-
lastModifiedDateTime(optional):
string(date-time)
Example:
2018-08-08T18:00:00
-
quantity(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
QuantityExample:3
-
requestedDateTime(optional):
string(date-time)
Example:
2015-09-09T16:00:00
-
reservationId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Reservation IdExample:1001
-
specialRequestActionCode(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Special Request Action CodeExample:BIRTHC
-
specialRequestActionDepartmentCode(optional):
string
Minimum Length:
1
Maximum Length:10
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Special Request Action Department CodeExample:111
-
specialRequestActionDepartmentDescription(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Special Request Action Department DescriptionExample:Bartender
-
specialRequestActionDescription(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Special Request Action DescriptionExample:Birthday Cake Celebration
-
specialRequestId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Special Request IdExample:123
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 is 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":"Reservation 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 Supported
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
Invalid content
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":"Invalid content",
"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