Oracle Hospitality Cruise Property Management REST API 23.2.2

Retrieve guests profile with criteria search

get

/spms/v1/guest

This is to retrieve guests profile with criteria search using keyword. When the keyword is not defined in the search criteria, all profile records will be return. Otherwise only specific profile records will be listed based on the defined search criteria.

Request

Supported Media Types

application/json

Query Parameters

limit: integer(int32)

Paging limit
offset: integer(int32)

Paging offset
orderBy: string
profileSearchTemplate(required): integer(int32)

profile search template id
q: string

keyword(first name, last name, cabin number, booking number, passport number)

Response

Supported Media Types

application/json

200 Response

Root Schema : Profile Search List

Type: object

Title: Profile Search List

Profile Search List

Show Source

count: integer

Example: 18
hasMore: boolean

Example: true
items: array items
limit: integer

Example: 2
links: array links
offset: integer

Example: 0

{
    "title":"Profile Search List",
    "description":"Profile Search List",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "example":"18"
        },
        "hasMore":{
            "type":"boolean",
            "example":true
        },
        "limit":{
            "type":"integer",
            "example":"2"
        },
        "offset":{
            "type":"integer",
            "example":"0"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GuestReturnSearchData"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/gpLinksProfile"
                    },
                    {
                        "properties":{
                            "href":{
                                "type":"string",
                                "example":"http://[HOSTNAME]/spms/v1/guest?q=john&offset=0&limit=2&orderBy=passportNumber"
                            },
                            "operationId":{
                                "type":"string",
                                "example":"search"
                            }
                        }
                    }
                ]
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object GuestReturnSearchData

data return

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

Nested Schema : links

Type: array

Show Source

Array of: items

{
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/gpLinksProfile"
            },
            {
                "properties":{
                    "href":{
                        "type":"string",
                        "example":"http://[HOSTNAME]/spms/v1/guest?q=john&offset=0&limit=2&orderBy=passportNumber"
                    },
                    "operationId":{
                        "type":"string",
                        "example":"search"
                    }
                }
            }
        ]
    }
}

Nested Schema : GuestReturnSearchData

Type: object

data return

Show Source

item: object ProfileDetails

Profile Details
links: links

{
    "description":"data return",
    "type":"object",
    "properties":{
        "item":{
            "$ref":"#/definitions/ProfileDetails"
        },
        "links":{
            "allOf":[
                {
                    "$ref":"#/definitions/gpLinksProfile"
                },
                {
                    "properties":{
                        "href":{
                            "type":"string",
                            "example":"http://[HOSTNAME]/spms/v1/guest/1000001"
                        },
                        "operationId":{
                            "type":"string",
                            "example":"findByID"
                        }
                    }
                }
            ]
        }
    }
}

Nested Schema : ProfileDetails

Type: object

Profile Details

Show Source

age: integer(int32)

Minimum Value: 1

Maximum Value: 150

Example: 57
contactNum: string

Minimum Length: 1

Maximum Length: 30

Pattern: ^[0-9 \+\-]*$

Example: +0123456789
countryOfBirth: string

Minimum Length: 1

Maximum Length: 3

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

Example: US
countryOfResidence: string

Minimum Length: 1

Maximum Length: 6

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

Example: US
dateOfBirth: string(date-time)

Example: 1961-04-01T16:00:00.000+0000
documentExpiryDate: string(date-time)

Example: 1961-04-01T16:00:00.000+0000
documentIssuedCountry: string

Minimum Length: 1

Maximum Length: 6

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

Example: US
emailAddress: string

Minimum Length: 1

Maximum Length: 50

Pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

Primary Email Address * `null` if empty

Example: email@example.com
emergencyContactName: string

Minimum Length: 1

Maximum Length: 40

Example: NAME or FIRST NAME / SURNAME
emergencyContactNum: string

Minimum Length: 1

Maximum Length: 30

Pattern: ^[0-9 \+\-]*$

Example: +(60) 123456789
firstName: string

Minimum Length: 1

Maximum Length: 40

Example: FIRST NAME
gender: string

Minimum Length: 1

Maximum Length: 6

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

Example: M or F
guestId(required): integer

Minimum Value: 0

Example: 1000001
lastName: string

Minimum Length: 1

Maximum Length: 40

Example: LAST NAME
middleName: string

Minimum Length: 1

Maximum Length: 20

Example: MIDDLE NAME
nationality: string

Minimum Length: 1

Maximum Length: 6

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

Example: US
passportNum: string

Minimum Length: 1

Maximum Length: 20

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

Example: A012345678
photo: string

Example: /Images/People/
reservationDetails: object GuestReservationDetails

Reservation Details
title: string

Minimum Length: 1

Maximum Length: 20

Example: Mr

{
    "description":"Profile Details",
    "type":"object",
    "properties":{
        "guestId":{
            "type":"integer",
            "minimum":"0",
            "example":"1000001"
        },
        "photo":{
            "type":"string",
            "example":"/Images/People/"
        },
        "title":{
            "type":"string",
            "minLength":"1",
            "maxLength":"20",
            "example":"Mr"
        },
        "firstName":{
            "type":"string",
            "minLength":"1",
            "maxLength":"40",
            "example":"FIRST NAME"
        },
        "middleName":{
            "type":"string",
            "minLength":"1",
            "maxLength":"20",
            "example":"MIDDLE NAME"
        },
        "lastName":{
            "type":"string",
            "minLength":"1",
            "maxLength":"40",
            "example":"LAST NAME"
        },
        "gender":{
            "type":"string",
            "minLength":"1",
            "maxLength":"6",
            "example":"M or F",
            "pattern":"^[ A-Za-z0-9,'_@./#&+-]*$"
        },
        "dateOfBirth":{
            "type":"string",
            "format":"date-time",
            "example":"1961-04-01T16:00:00.000+0000"
        },
        "age":{
            "type":"integer",
            "format":"int32",
            "minimum":"1",
            "maximum":"150",
            "example":"57"
        },
        "nationality":{
            "type":"string",
            "pattern":"^[ A-Za-z0-9,'_@./#&+-]*$",
            "minLength":"1",
            "maxLength":"6",
            "example":"US"
        },
        "passportNum":{
            "type":"string",
            "pattern":"^[ A-Za-z0-9,'_@./#&+-]*$",
            "minLength":"1",
            "maxLength":"20",
            "example":"A012345678"
        },
        "documentExpiryDate":{
            "type":"string",
            "format":"date-time",
            "example":"1961-04-01T16:00:00.000+0000"
        },
        "documentIssuedCountry":{
            "type":"string",
            "pattern":"^[ A-Za-z0-9,'_@./#&+-]*$",
            "minLength":"1",
            "maxLength":"6",
            "example":"US"
        },
        "countryOfBirth":{
            "type":"string",
            "pattern":"^[ A-Za-z0-9_@./#&+-]*$",
            "minLength":"1",
            "maxLength":"3",
            "example":"US"
        },
        "countryOfResidence":{
            "type":"string",
            "pattern":"^[ A-Za-z0-9_@./#&+-]*$",
            "minLength":"1",
            "maxLength":"6",
            "example":"US"
        },
        "contactNum":{
            "type":"string",
            "pattern":"^[0-9 \\+\\-\\(\\)]*$",
            "minLength":"1",
            "maxLength":"30",
            "example":"+0123456789"
        },
        "emailAddress":{
            "description":"Primary Email Address\n  * `null` if empty\n",
            "type":"string",
            "minLength":"1",
            "maxLength":"50",
            "pattern":"^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$",
            "example":"email@example.com"
        },
        "emergencyContactName":{
            "type":"string",
            "minLength":"1",
            "maxLength":"40",
            "example":"NAME or FIRST NAME / SURNAME"
        },
        "emergencyContactNum":{
            "type":"string",
            "pattern":"^[0-9 \\+\\-\\(\\)]*$",
            "minLength":"1",
            "maxLength":"30",
            "example":"+(60) 123456789"
        },
        "reservationDetails":{
            "type":"object",
            "$ref":"#/definitions/GuestReservationDetails"
        }
    },
    "required":[
        "guestId"
    ]
}

Nested Schema : links

Match All

Show Source

object gpLinksProfile

links detail
object links-allOf[1]

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

Nested Schema : GuestReservationDetails

Type: object

Reservation Details

Show Source

accountId: integer

Minimum Value: 1

Example: 1000001
cabinNum: string

Minimum Length: 1

Maximum Length: 20

Example: 12345
disembarkDate: string(date-time)

Example: 2015-09-09T16:00:00.000+0000
embarkDate: string(date-time)

Example: 2015-09-02T16:00:00.000+0000
reservationStatus: string

Minimum Length: 2

Maximum Length: 2

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

Example: CC

{
    "description":"Reservation Details",
    "type":"object",
    "properties":{
        "embarkDate":{
            "type":"string",
            "format":"date-time",
            "example":"2015-09-02T16:00:00.000+0000"
        },
        "disembarkDate":{
            "type":"string",
            "format":"date-time",
            "example":"2015-09-09T16:00:00.000+0000"
        },
        "cabinNum":{
            "type":"string",
            "minLength":"1",
            "maxLength":"20",
            "example":"12345"
        },
        "accountId":{
            "type":"integer",
            "minimum":"1",
            "example":"1000001"
        },
        "reservationStatus":{
            "type":"string",
            "minLength":"2",
            "maxLength":"2",
            "enum":[
                "RR",
                "RX",
                "RE",
                "RN",
                "CC",
                "CL",
                "DD",
                "00"
            ],
            "example":"CC"
        }
    }
}

Nested Schema : gpLinksProfile

Type: object

links detail

Show Source

method: string

Example: get
rel: 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: string

Example: http://[HOSTNAME]/spms/v1/guest/1000001
operationId: string

Example: findByID

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

Nested Schema : items

Match All

Show Source

object gpLinksProfile

links detail
object items-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/gpLinksProfile"
        },
        {
            "properties":{
                "href":{
                    "type":"string",
                    "example":"http://[HOSTNAME]/spms/v1/guest?q=john&offset=0&limit=2&orderBy=passportNumber"
                },
                "operationId":{
                    "type":"string",
                    "example":"search"
                }
            }
        }
    ]
}

Nested Schema : items-allOf[1]

Type: object

Show Source

href: string

Example: http://[HOSTNAME]/spms/v1/guest?q=john&offset=0&limit=2&orderBy=passportNumber
operationId: string

Example: search

{
    "properties":{
        "href":{
            "type":"string",
            "example":"http://[HOSTNAME]/spms/v1/guest?q=john&offset=0&limit=2&orderBy=passportNumber"
        },
        "operationId":{
            "type":"string",
            "example":"search"
        }
    }
}

400 Response

Bad Request

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/gpGuestProfileErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Bad Request",
        "detail":"Empty request body."
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Bad Request",
    "detail":"Empty request body."
}

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

You are not authorized to use this API

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

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

You are forbidden to use this API

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/gpGuestProfileErrorResponse"
        }
    ],
    "example":{
        "title":"Not Found",
        "detail":"Profile configuration does not exist",
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
    }
}

Example:

{
    "title":"Not Found",
    "detail":"Profile configuration does not exist",
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
}

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

This method is not available

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

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

415 Response

The media supplied is not supported

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

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

Example:

{
    "title":"Invalid content",
    "detail":"Content type not supported",
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16"
}

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

Error occurred while processing this request

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/gpGuestProfileErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable. Try again later"
    }
}

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

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"
        }
    }
}