1. Oracle Hospitality Cruise REST API
  2. Tasks
  3. Mobile Check-In Wizard
  4. Profile Search Template

Retrieve list of all profile search templates

get

/spms/v1/profileSearchTemplate

This is to retrieve list of all profile search templates

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : SearchConfigurationsList
Type: object
Show Source
Nested Schema : items
Match All
Show Source
Nested Schema : List of profile search configuration
Type: object
Title: List of profile search configuration
List of profile search configuration
Show Source
Nested Schema : item
Match All
Show Source
Nested Schema : templateHeader
Type: object
profile search configuration header
Show Source
Nested Schema : item-allOf[1]
Type: object
Show Source
Nested Schema : profileSearchFilter
Type: array
Show Source
Example:
[
    {
        "id":1,
        "parentId":1234,
        "templateFieldId":1,
        "type":1,
        "fieldDetails":{
            "id":1234,
            "tableName":"guest",
            "fieldName":"firstName",
            "type":1,
            "description":"First Name"
        }
    },
    {
        "id":2,
        "parentId":1234,
        "templateFieldId":2,
        "type":1,
        "fieldDetails":{
            "id":1002,
            "tableName":"Profile",
            "fieldName":"lastName",
            "type":1,
            "description":"Last Name"
        }
    },
    {
        "id":3,
        "parentId":1234,
        "templateFieldId":3,
        "type":1,
        "fieldDetails":{
            "id":1003,
            "tableName":"Profile",
            "fieldName":"passportNum",
            "type":1,
            "description":"Passport Number"
        }
    }
]
Nested Schema : profileSearchResult
Type: array
Show Source
Example:
[
    {
        "id":4,
        "parentId":1234,
        "templateFieldId":6,
        "type":2,
        "fieldDetails":{
            "id":1004,
            "tableName":"Profile",
            "fieldName":"photo",
            "type":2,
            "description":"Photo"
        }
    },
    {
        "id":5,
        "parentId":1234,
        "templateFieldId":7,
        "type":2,
        "fieldDetails":{
            "id":1005,
            "tableName":"Reservation",
            "fieldName":"cabinNum",
            "type":2,
            "description":"Cabin Number"
        }
    },
    {
        "id":6,
        "parentId":1001,
        "templateFieldId":8,
        "type":2,
        "fieldDetails":{
            "id":1006,
            "tableName":"Profile",
            "fieldName":"firstName",
            "type":2,
            "description":"First Name"
        }
    }
]
Nested Schema : profileSearchStatus
Type: array
Show Source
  • Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Reservation Status, RR=Reservation, RX=Cancelled, RE=Embark today, RN=No Show, CC=Checked In, CL=Leaving today, DD=Disembarked
    Example: CC
Example:
[
    {
        "id":1,
        "parentId":1234,
        "status":"RR"
    },
    {
        "id":2,
        "parentId":1234,
        "status":"CC"
    }
]
Nested Schema : templateFieldDetails
Type: object
Show Source
Nested Schema : fieldDetails
Type: object
Show Source
Nested Schema : searchFields
Type: object
search fields
Show Source
Nested Schema : linksHeader
Type: object
links detail
Show Source

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter typeId has incorrect format"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

401 Response

Unauthorized
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"https://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
Body ()
Root Schema : schema
Match All
Show Source
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

405 Response

Method Not Allowed
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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

415 Response

Unsupported Media Type
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "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
Body ()
Root Schema : schema
Match All
Show Source
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

503 Response

Service Unavailable
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service Unavailable.  Try again later"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source
Back to Top