Jump to

• Request
• Response

Retrieve guest record that having reservation from current and future cruise.

get

/spms/v2/ships/{shipId}/reservations/backToBackReservations

This is to retrieve listing of same guest that have reservation from current and future cruise.

Request

Supported Media Types

• application/json

Path Parameters

• shipId: number
  Ship Id

Query Parameters

• fromCruiseId: number
  Cruise itinerary ID (reservation from source cruise itinerary)
• orderBy: string
  Order by First Name and Last Name with format column1:asc/desc,column2:asc/desc

  Default Value: firstName:asc
• toCruiseId: number
  Cruise itinerary ID (reservation from destination cruise itinerary)

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : guestReservationResponse

Type: object

Title: guestReservationResponse

Guest Reservation Response

Show Source

• guestRecordListings(optional): array guestRecordListings
• toCruiseDescription(optional): string
  Cruise Itinerary Description (destination Cruise Itinerary)

  Example: Fjord Itinerary
• toCruiseId(optional): number
  Cruise Itinerary ID (destination Cruise Itinerary)

  Example: 123
• toCruiseStartDate(optional): string(ISO 8601 (YYYY-MM-DD))
  Cruise Start Date (destination Cruise start date)

  Example: 2025-04-19

{
    "title":"guestReservationResponse",
    "description":"Guest Reservation Response",
    "type":"object",
    "properties":{
        "toCruiseId":{
            "$ref":"#/definitions/toCruiseId"
        },
        "toCruiseDescription":{
            "$ref":"#/definitions/toCruiseDescription"
        },
        "toCruiseStartDate":{
            "$ref":"#/definitions/toCruiseStartDate"
        },
        "guestRecordListings":{
            "$ref":"#/definitions/guestRecordListings"
        }
    }
}

Nested Schema : guestRecordListings

Type: array

Show Source

• Array of: object guestRecord
  Guest Record

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/guestRecord"
    }
}

Nested Schema : guestRecord

Type: object

Guest Record

Show Source

• accountCategory(optional): object accountCategory
  Account Category
• dateOfBirth(optional): string(ISO 8601 (YYYY-MM-DD))
  Date of Birth

  Example: 1970-02-15
• discountTemplate(optional): object discountTemplate
  Discount Template
• disembarkationDate(optional): string
  Reservation disembarkation date * `Optional` (Do not provide if not in use) * For all Profile Types

  Example: 2021-01-30
• email(optional): string
  Minimum Length: 1

  Maximum Length: 50

  Pattern: ^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$

  Email Address * `null` if empty

  Example: [e-mail]
• embarkationDate(optional): string
  Reservation embarkation date * `Optional` (Do not provide if not in use) * For all Profile Types

  Example: 2021-01-26
• firstName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?\/.\-+*~!@#$%&{}[\]\(\)=|^'":;@`\\]*$

  First name * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: Doe
• fromReservationId(optional): number
  Reservation ID (source reservation ID)

  Example: 12345
• gender(optional): object gender
  Gender
• lastName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?\/.\-+*~!@#$%&{}[\]\(\)=|^'":;@`\\]*$

  Last name * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: Jaden
• middleName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?\/.\-+*~!@#$%&{}[\]\(\)=|^'":;@`\\]*$

  Middle name * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: Jay
• mobileNumber(optional): string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[0-9]*$

  Mobile Number * `null` if empty

  Example: 4413563590
• nationality(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9_@./#&+-]*$

  Nationality code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: US
• otherFirstName(optional): string
  Other First Name

  Example: Mäya
• otherLastName(optional): string
  Other Last Name

  Example: Wälters
• passportExpiryDate(optional): string(ISO 8601 (YYYY-MM-DD))
  Passport Expiry Date

  Example: 2025-02-25
• passportNumber(optional): string
  Minimum Length: 1

  Maximum Length: 20

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

  Passport number * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: A123409982
• photo(optional): string
  Photo

  Example: https://[HOSTNAME]/resources/img_01.jpg
• reservationExternalId(optional): string
  Reservation External ID

  Example: 132789
• reservationExternalReferenceId(optional): string
  Reservation External Reference ID

  Example: D132789
• salutation(optional): string
  Salutation

  Example: Dr.
• stateroomNumber(optional): string
  Minimum Length: 1

  Maximum Length: 20

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

  Stateroom number / Cabin number * `Optional` (Do not provide if not in use) * `null` if searching `null` * For `P`, `R`, `C` Profile Types * Ignored if given only other Profile Types

  Example: B1001
• title(optional): string
  Title

  Example: Countess
• toReservationId(optional): number
  Reservation ID (destination reservation ID)

  Example: 54321

{
    "description":"Guest Record",
    "type":"object",
    "properties":{
        "fromReservationId":{
            "$ref":"#/definitions/fromReservationId"
        },
        "toReservationId":{
            "$ref":"#/definitions/toReservationId"
        },
        "photo":{
            "$ref":"#/definitions/photo"
        },
        "firstName":{
            "$ref":"#/definitions/firstName"
        },
        "lastName":{
            "$ref":"#/definitions/lastName"
        },
        "middleName":{
            "$ref":"#/definitions/middleName"
        },
        "otherFirstName":{
            "$ref":"#/definitions/otherFirstName"
        },
        "otherLastName":{
            "$ref":"#/definitions/otherLastName"
        },
        "salutation":{
            "$ref":"#/definitions/salutation"
        },
        "title":{
            "$ref":"#/definitions/title"
        },
        "gender":{
            "$ref":"#/definitions/gender"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "nationality":{
            "$ref":"#/definitions/nationality"
        },
        "email":{
            "$ref":"#/definitions/email"
        },
        "mobileNumber":{
            "$ref":"#/definitions/mobileNumber"
        },
        "accountCategory":{
            "$ref":"#/definitions/accountCategory"
        },
        "discountTemplate":{
            "$ref":"#/definitions/discountTemplate"
        },
        "passportNumber":{
            "$ref":"#/definitions/passportNumber"
        },
        "passportExpiryDate":{
            "$ref":"#/definitions/passportExpiryDate"
        },
        "stateroomNumber":{
            "$ref":"#/definitions/stateroomNumber"
        },
        "embarkationDate":{
            "$ref":"#/definitions/embarkationDate"
        },
        "disembarkationDate":{
            "$ref":"#/definitions/disembarkationDate"
        },
        "reservationExternalId":{
            "$ref":"#/definitions/reservationExternalId"
        },
        "reservationExternalReferenceId":{
            "$ref":"#/definitions/reservationExternalReferenceId"
        }
    }
}

Nested Schema : accountCategory

Type: object

Account Category

Show Source

• code(optional): string
  Minimum Value: 1

  Maximum Value: 6

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

  Account Category code

  Example: PROLOS
• description(optional): string
  Account Category Description

  Example: Regular Guest

{
    "description":"Account Category",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/accountCategoryCode"
        },
        "description":{
            "$ref":"#/definitions/accountCategoryDescription"
        }
    }
}

Nested Schema : discountTemplate

Type: object

Discount Template

Show Source

• code(optional): string
  Discount Template Code

  Example: LV2
• description(optional): string
  Discount Template Description

  Example: Disc Template 2

{
    "description":"Discount Template",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/discountTemplateCode"
        },
        "description":{
            "$ref":"#/definitions/discountTemplateDescription"
        }
    }
}

Nested Schema : gender

Type: object

Gender

Show Source

• code(optional): string
  Pattern: ^[FMX]$

  Gender Code

  Example: F
• description(optional): string
  Gender Name

  Example: Female

{
    "description":"Gender",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/genderCode"
        },
        "description":{
            "$ref":"#/definitions/genderDescription"
        }
    }
}

204 Response

No Content

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/guestReservationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter 'shipId' has incorrect format"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter 'shipId' has incorrect format"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): 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/guestReservationErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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/guestReservationErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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/guestReservationErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"HTTP 404 Not Found"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"HTTP 404 Not Found"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): 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 Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestReservationErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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/guestReservationErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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/guestReservationErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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

Unsupported Media Type

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestReservationErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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/guestReservationErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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/guestReservationErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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/guestReservationErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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