1. Oracle Hospitality Cruise Property Management REST API 23.1.4
  2. Tasks
  3. Reservations
  4. Guardian

Retrieve guardian details by minor profile ID

get

/spms/v2/ships/{shipId}/profile/{profileId}/guardians

This is to retrieve the guardian listing from a minor profile Id

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Oracle Responses list
Type: object
Title: Oracle Responses list
The wrapper object when returning successful values in Oracle standard
Show Source
Nested Schema : guardianDetails
Type: array
Show Source
Example:
[
    {
        "profileId":"123",
        "profileType":"P",
        "lastName":"James",
        "firstName":"Bond",
        "middleName":"Big",
        "otherLastName":"Jennifer",
        "otherFirstName":"Crawl",
        "salutation":"Mr",
        "stateroomNumber":"1001",
        "bookingNumber":"0123",
        "photo":"https://oracle.com/resources/james.jpg"
    },
    {
        "profileId":"231",
        "profileType":"P",
        "lastName":"Jessica",
        "firstName":"Alba",
        "middleName":"Small",
        "otherLastName":"Nick",
        "otherFirstName":"Wild",
        "salutation":"Ms",
        "stateroomNumber":"1002",
        "bookingNumber":"0231",
        "photo":"https://oracle.com/resources/jessica.jpg"
    },
    {
        "profileId":"321",
        "profileType":"P",
        "lastName":"John",
        "firstName":"Dickson",
        "middleName":"Middle",
        "otherLastName":"Hunter",
        "otherFirstName":"Lily",
        "salutation":"Mr",
        "stateroomNumber":"1003",
        "bookingNumber":"0321",
        "photo":"https://oracle.com/resources/john.jpg"
    }
]
Nested Schema : GuardianGETObject
Type: object
Guardian GET Object
Show Source
  • Minimum Length: 1
    Pattern: ^[a-zA-Z0-9]+$
    Booking Number
    Example: 123456789
  • Minimum Length: 1
    Maximum Length: 40
    The first name of the guest
    Example: Kobe
  • Minimum Length: 1
    Maximum Length: 40
    The last name of the guest
    Example: James
  • Minimum Length: 1
    Maximum Length: 20
    The middle name of the guest
    Example: Bean
  • Minimum Length: 1
    Maximum Length: 80
    Pattern: ^[ a-zA-Z0-9_.À-῿Ⰰ-퟿]*$
    Other First Name * `null` if empty
    Example: Frost
  • Minimum Length: 1
    Maximum Length: 100
    Pattern: ^[ a-zA-Z0-9_.À-῿Ⰰ-퟿]*$
    Other Last Name * `null` if empty
    Example: Francis
  • Photo
    Example: /9j/4AAQSkZJRgABAQEASABIAAD==
  • Minimum Length: 1
    Pattern: ^[0-9]*$
    Profile Id
    Example: 12345
  • Profile Type
    Example: Crew
  • Minimum Length: 1
    Maximum Length: 20
    The salutation of the guest
    Example: Mr.
  • Minimum Length: 1
    Maximum Length: 20
    Pattern: ^[a-zA-Z0-9- ]*$
    stateroomNumber
    Example: 1001

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":"Invalid parameter(s) passed in"
}
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":"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

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":"Ship Id was not be found"
}
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

410 Response

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

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.16",
    "title":"Unsupported Media Type",
    "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

501 Response

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

503 Response

Service Unavailable
Body ()
Root Schema : schema
Match All
Show Source
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
Back to Top