Jump to

• Request
• Response

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(required): number
  Reservation Id
• shipId(required): number
  Ship Id

Body ()

Special Request Post Object

Root Schema : SpecialRequestPOSTObject

Type: object

SpecialRequest POST Object

Show Source

• deliveredDateTime: string(date-time)
  Example: 2018-08-08T20:00:00
• deliveryLocation: string
  Minimum Length: 0

  Maximum Length: 30

  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Delivery Location

  Example: Stateroom 1001
• deliveryStatus: string
  Allowed Values: [ "Pending", "Delivered" ]

  Special Request Delivery Status

  Example: Delivered
• externalCode: string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  External Code

  Example: 123
• quantity: number
  Pattern: ^[0-9]*$

  Quantity

  Example: 1
• requestedDateTime: string(date-time)
  Example: 2015-09-09T16:00:00
• specialRequestActionCode: string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Special Request Action Code

  Example: BIRTHC
• specialRequestActionDepartmentCode: string
  Minimum Length: 1

  Maximum Length: 10

  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Special Request Action Department Code

  Example: 111
• specialRequestActionDescription: string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Special Request Action Description

  Example: Birthday Cake Celebration

{
    "description":"SpecialRequest POST Object",
    "type":"object",
    "properties":{
        "specialRequestActionCode":{
            "$ref":"#/definitions/specialRequestActionCode"
        },
        "specialRequestActionDescription":{
            "$ref":"#/definitions/specialRequestActionDescription"
        },
        "externalCode":{
            "$ref":"#/definitions/externalCode"
        },
        "quantity":{
            "$ref":"#/definitions/quantity"
        },
        "requestedDateTime":{
            "$ref":"#/definitions/requestedDateTime"
        },
        "deliveryLocation":{
            "$ref":"#/definitions/deliveryLocation"
        },
        "deliveryStatus":{
            "$ref":"#/definitions/deliveryStatus"
        },
        "deliveredDateTime":{
            "$ref":"#/definitions/deliveredDateTime"
        },
        "specialRequestActionDepartmentCode":{
            "$ref":"#/definitions/specialRequestActionDepartmentCode"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created

Body ()

Root Schema : SpecialRequestGETObject

Type: object

SpecialRequest GET Object

Show Source

• completedDateTime: string(date)
  Example: 2018-11-11T23:00:00
• createdBy: string
  Created By

  Example: Jessica Sue
• createdDateTime: string(date)
  Example: 2018-08-08T18:00:00
• deliveredBy: string
  Delivered By

  Example: Jason Tan
• deliveredDateTime: string(date-time)
  Example: 2018-08-08T20:00:00
• deliveryLocation: string
  Minimum Length: 0

  Maximum Length: 30

  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Delivery Location

  Example: Stateroom 1001
• deliveryStatus: string
  Allowed Values: [ "Pending", "Delivered" ]

  Special Request Delivery Status

  Example: Delivered
• externalCode: string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  External Code

  Example: 123
• lastModifiedDateTime: string(date-time)
  Example: 2018-08-08T18:00:00
• quantity: number
  Pattern: ^[0-9]*$

  Quantity

  Example: 1
• requestedDateTime: string(date-time)
  Example: 2015-09-09T16:00:00
• reservationId: number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Reservation Id

  Example: 123
• specialRequestActionCode: string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Special Request Action Code

  Example: BIRTHC
• specialRequestActionDepartmentCode: string
  Minimum Length: 1

  Maximum Length: 10

  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Special Request Action Department Code

  Example: 111
• specialRequestActionDepartmentDescription: string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Special Request Action Department Description

  Example: Bartender
• specialRequestActionDescription: string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Special Request Action Description

  Example: Birthday Cake Celebration
• specialRequestId: number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Special Request Id

  Example: 123

{
    "description":"SpecialRequest GET Object",
    "type":"object",
    "properties":{
        "reservationId":{
            "$ref":"#/definitions/reservationId"
        },
        "specialRequestId":{
            "$ref":"#/definitions/specialRequestId"
        },
        "specialRequestActionCode":{
            "$ref":"#/definitions/specialRequestActionCode"
        },
        "specialRequestActionDescription":{
            "$ref":"#/definitions/specialRequestActionDescription"
        },
        "externalCode":{
            "$ref":"#/definitions/externalCode"
        },
        "quantity":{
            "$ref":"#/definitions/quantity"
        },
        "requestedDateTime":{
            "$ref":"#/definitions/requestedDateTime"
        },
        "deliveryLocation":{
            "$ref":"#/definitions/deliveryLocation"
        },
        "deliveryStatus":{
            "$ref":"#/definitions/deliveryStatus"
        },
        "deliveredDateTime":{
            "$ref":"#/definitions/deliveredDateTime"
        },
        "deliveredBy":{
            "$ref":"#/definitions/deliveredBy"
        },
        "createdDateTime":{
            "$ref":"#/definitions/createdDateTime"
        },
        "createdBy":{
            "$ref":"#/definitions/createdBy"
        },
        "lastModifiedDateTime":{
            "$ref":"#/definitions/lastModifiedDateTime"
        },
        "specialRequestActionDepartmentCode":{
            "$ref":"#/definitions/specialRequestActionDepartmentCode"
        },
        "specialRequestActionDepartmentDescription":{
            "$ref":"#/definitions/specialRequestActionDepartmentDescription"
        },
        "completedDateTime":{
            "$ref":"#/definitions/completedDateTime"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/specialRequestErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"Invalid parameter(s) passed in"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/specialRequestErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/specialRequestErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/specialRequestErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Reservation Id could not be found"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Supported

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/specialRequestErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/specialRequestErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

410 Response

Gone

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/specialRequestErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
        "title":"Gone",
        "detail":"Requested Resource no longer exists"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

415 Response

Invalid content

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/specialRequestErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Invalid content",
        "detail":"Content type not supported"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/specialRequestErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

501 Response

Not Implemented

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/specialRequestErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/specialRequestErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service not available"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top