Jump to

• Request
• Response

Retrieve the Guest Payment Routing record list

get

/spms/v1/reservations/{profileId}/routingInstructions/profileSearchTemplate/{templateId}

Request

Supported Media Types

• application/json

Path Parameters

• profileId: number
  profileId is payer reservation account Id
• templateId: number
  templateId is the profile search template id to decide the search result column list

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object GuestProfileList
  Title: GuestProfileList

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

Nested Schema : GuestProfileList

Type: object

Title: GuestProfileList

Show Source

• items(optional): array items

{
    "title":"GuestProfileList",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReturnGuestProfileSearchData"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ReturnGuestProfileSearchData
  Title: ReturnGuestProfileSearchData

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

Nested Schema : ReturnGuestProfileSearchData

Type: object

Title: ReturnGuestProfileSearchData

Show Source

• item(optional): object GuestProfileDetails
  Profile Details
• links(optional): links

{
    "title":"ReturnGuestProfileSearchData",
    "type":"object",
    "properties":{
        "item":{
            "$ref":"#/definitions/GuestProfileDetails"
        },
        "links":{
            "allOf":[
                {
                    "$ref":"#/definitions/linksProfile"
                },
                {
                    "properties":{
                        "href":{
                            "type":"string",
                            "example":"http://[HOSTNAME]/spms/v1/guest/1000001"
                        },
                        "operationId":{
                            "type":"string",
                            "example":"findByID"
                        }
                    }
                }
            ]
        }
    }
}

Nested Schema : GuestProfileDetails

Type: object

Profile Details

Show Source

• dateOfBirth(optional): string(date-time)
  Example: 1961-04-01
• firstName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: [a-z]

  Example: AQCI 01
• guestId(optional): integer
  Minimum Value: 0

  Example: 1047204
• lastName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: [a-z]

  Example: TESTCP
• passportNum(optional): string
  Pattern: [a-z0-9]
• photo(optional): string
  Example: /Images/People/
• reservationDetails(optional): array reservationDetails

{
    "description":"Profile Details",
    "type":"object",
    "properties":{
        "guestId":{
            "type":"integer",
            "minimum":0,
            "example":1047204
        },
        "dateOfBirth":{
            "type":"string",
            "format":"date-time",
            "example":"1961-04-01"
        },
        "firstName":{
            "type":"string",
            "pattern":"[a-z]",
            "minLength":1,
            "maxLength":40,
            "example":"AQCI 01"
        },
        "lastName":{
            "type":"string",
            "pattern":"[a-z]",
            "minLength":1,
            "maxLength":40,
            "example":"TESTCP"
        },
        "passportNum":{
            "type":"string",
            "pattern":"[a-z0-9]"
        },
        "photo":{
            "type":"string",
            "example":"/Images/People/"
        },
        "reservationDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReservationDetails"
            }
        }
    }
}

Nested Schema : links

Match All

Show Source

• object linksProfile
  links detail
• object links-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/linksProfile"
        },
        {
            "properties":{
                "href":{
                    "type":"string",
                    "example":"http://[HOSTNAME]/spms/v1/guest/1000001"
                },
                "operationId":{
                    "type":"string",
                    "example":"findByID"
                }
            }
        }
    ]
}

Nested Schema : reservationDetails

Type: array

Show Source

• Array of: object ReservationDetails
  Reservation Details

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

Nested Schema : ReservationDetails

Type: object

Reservation Details

Show Source

• accountId(optional): integer
  Minimum Value: 1

  Example: 1000001
• actualDisembarkDate(optional): string(date-time)
  Example: null or 2015-09-09T16:00:00.000+0000
• actualEmbarkDate(optional): string(date-time)
  Example: 2015-09-02T16:00:00.000+0000
• assemblyStationCode(optional): string
  Minimum Length: 0

  Maximum Length: 6

  Pattern: [a-z0-9]

  Example: 12345
• assemblyStationName(optional): string
  Minimum Length: 1

  Maximum Length: 50

  Pattern: [a-z0-9]

  Example: 12345
• boardCardNumber(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: [a-z0-9]

  Example: 123456789
• cabinNum(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: [a-z0-9]

  Example: 12345
• consentStatus(optional): boolean
  Example: false
• disembarkDate(optional): string(date-time)
  Example: 2015-09-09T16:00:00.000+0000
• disembarkPort(optional): integer
  Example: 123
• embarkCruiseId(optional): integer(int32)
  Example: 12345
• embarkDate(optional): string(date-time)
  Example: 2015-09-02T16:00:00.000+0000
• embarkPort(optional): integer
  Example: 123
• groupReferenceId(optional): integer(int32)
  Example: 12345
• onboardStatus(optional): boolean
  Example: true
• reservationAccountReferenceId(optional): integer(int32)
  Example: 12345
• reservationAccountType(optional): string
  Minimum Length: 1

  Maximum Length: 1

  Allowed Values: [ "P", "R", "C", "S", "V", "G", "A" ]

  Pattern: ^P|R|C|S|V|G|A$

  Example: P for Pax
• reservationBookingNumber(optional): string
  Minimum Length: 1

  Maximum Length: 100

  Pattern: [a-z0-9]

  Example: 0123456789
• reservationCancelStatus(optional): boolean
  Example: false
• reservationExternalId(optional): string
  Minimum Length: 1

  Maximum Length: 50

  Pattern: [a-z0-9]

  Example: 12345
• reservationId(optional): integer
  Minimum Value: 0

  Example: 12345
• reservationStatus(optional): string
  Minimum Length: 2

  Maximum Length: 2

  Allowed Values: [ "RR", "RX", "RE", "RN", "CC", "CL", "DD", "00" ]

  Example: CC
• routedAccountNumber(optional): integer(int32)
  Example: 12345
• setSailPass(optional): string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: [a-z0-9]

  Example: 12345

{
    "description":"Reservation Details",
    "type":"object",
    "properties":{
        "reservationId":{
            "type":"integer",
            "minimum":0,
            "example":12345
        },
        "reservationExternalId":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":50,
            "example":"12345"
        },
        "disembarkPort":{
            "type":"integer",
            "example":123
        },
        "embarkPort":{
            "type":"integer",
            "example":123
        },
        "accountId":{
            "type":"integer",
            "minimum":1,
            "example":1000001
        },
        "reservationCancelStatus":{
            "type":"boolean",
            "example":false
        },
        "reservationBookingNumber":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":100,
            "example":"0123456789"
        },
        "disembarkDate":{
            "type":"string",
            "format":"date-time",
            "example":"2015-09-09T16:00:00.000+0000"
        },
        "routedAccountNumber":{
            "type":"integer",
            "format":"int32",
            "example":12345
        },
        "actualDisembarkDate":{
            "type":"string",
            "format":"date-time",
            "example":"null or 2015-09-09T16:00:00.000+0000"
        },
        "groupReferenceId":{
            "type":"integer",
            "format":"int32",
            "example":12345
        },
        "cabinNum":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":20,
            "example":"12345"
        },
        "boardCardNumber":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":20,
            "example":"123456789"
        },
        "consentStatus":{
            "type":"boolean",
            "example":false
        },
        "actualEmbarkDate":{
            "type":"string",
            "format":"date-time",
            "example":"2015-09-02T16:00:00.000+0000"
        },
        "reservationAccountType":{
            "type":"string",
            "pattern":"^P|R|C|S|V|G|A$",
            "minLength":1,
            "maxLength":1,
            "enum":[
                "P",
                "R",
                "C",
                "S",
                "V",
                "G",
                "A"
            ],
            "example":"P for Pax"
        },
        "onboardStatus":{
            "type":"boolean",
            "example":true
        },
        "embarkCruiseId":{
            "type":"integer",
            "format":"int32",
            "example":12345
        },
        "reservationAccountReferenceId":{
            "type":"integer",
            "format":"int32",
            "example":12345
        },
        "reservationStatus":{
            "type":"string",
            "minLength":2,
            "maxLength":2,
            "enum":[
                "RR",
                "RX",
                "RE",
                "RN",
                "CC",
                "CL",
                "DD",
                "00"
            ],
            "example":"CC"
        },
        "embarkDate":{
            "type":"string",
            "format":"date-time",
            "example":"2015-09-02T16:00:00.000+0000"
        },
        "setSailPass":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":30,
            "example":"12345"
        },
        "assemblyStationCode":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":0,
            "maxLength":6,
            "example":"12345"
        },
        "assemblyStationName":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":50,
            "example":"12345"
        }
    }
}

Nested Schema : linksProfile

Type: object

links detail

Show Source

• method(optional): string
  Example: get
• rel(optional): string
  Example: self

{
    "description":"links detail",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"self"
        },
        "method":{
            "type":"string",
            "example":"get"
        }
    }
}

Nested Schema : links-allOf[1]

Type: object

Show Source

• href(optional): string
  Example: http://[HOSTNAME]/spms/v1/guest/1000001
• operationId(optional): string
  Example: findByID

{
    "properties":{
        "href":{
            "type":"string",
            "example":"http://[HOSTNAME]/spms/v1/guest/1000001"
        },
        "operationId":{
            "type":"string",
            "example":"findByID"
        }
    }
}

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

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter profileId 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/RoutingInstructionErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorised",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorised",
    "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/RoutingInstructionErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

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

• 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/RoutingInstructionErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"This resource path does not exist"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"This resource path does not exist"
}

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/RoutingInstructionErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Allowed",
        "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 Allowed",
    "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/RoutingInstructionErrorResponse"
        }
    ],
    "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"
        }
    }
}

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/RoutingInstructionErrorResponse"
        }
    ],
    "example":{
        "type":"https://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":"https://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"
        }
    }
}

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/RoutingInstructionErrorResponse"
        }
    ],
    "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