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
- application/json
Path Parameters
-
profileId: integer
Profile ID
-
shipId: number
Ship Id
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Oracle Responses list
Type:
object
Title:
Oracle Responses list
The wrapper object when returning successful values in Oracle standard
Show Source
-
age(optional):
integer(int32)
Minimum Value:
1
Maximum Value:150
AgeExample:25
-
bookingNumber(optional):
string
Minimum Length:
1
Pattern:^[a-zA-Z0-9]+$
Booking NumberExample:123456789
-
firstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
First NameExample:Fabiana
-
guardianDetails(optional):
array guardianDetails
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Last NameExample:Carleo
-
middleName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Middle NameExample:Alberto
-
otherFirstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Other First NameExample:Frost
-
otherLastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Other Last NameExample:Francis
-
photo(optional):
string
PhotoExample:
/9j/4AAQSkZJRgABAQEASABIAAD==
-
profileId(optional):
integer
Minimum Value:
1
Pattern:^[0-9]*$
Profile IDExample:1001
-
profileType(optional):
object profileType
Profile Types
-
salutation(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z]
SalutationExample:MR
-
stateroomNumber(optional):
string
Minimum Length:
1
Pattern:^[a-zA-Z0-9]+$
stateroomNumberExample:1001
Nested Schema : guardianDetails
Type:
Show Source
array
-
Array of:
object GuardianGETObject
Guardian GET Object
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 : profileType
Type:
object
Profile Types
Show Source
-
code(optional):
string
Minimum Value:
1
Maximum Value:100
Pattern:^[a-zA-Z ]*$
Example:V
-
id(optional):
number
Example:
1.60000011301E11
-
name(optional):
string
Minimum Value:
1
Maximum Value:200
Pattern:^[a-zA-Z ]*$
Example:Visitor
Nested Schema : GuardianGETObject
Type:
object
Guardian GET Object
Show Source
-
bookingNumber(optional):
string
Minimum Length:
1
Pattern:^[a-zA-Z0-9]+$
Booking NumberExample:123456789
-
firstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
First NameExample:Fabiana
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Last NameExample:Carleo
-
middleName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Middle NameExample:Alberto
-
otherFirstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Other First NameExample:Frost
-
otherLastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Other Last NameExample:Francis
-
photo(optional):
string
PhotoExample:
/9j/4AAQSkZJRgABAQEASABIAAD==
-
profileId(optional):
integer
Minimum Value:
1
Pattern:^[0-9]*$
Profile IDExample:1001
-
profileType(optional):
object profileType
Profile Types
-
salutation(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z]
SalutationExample:MR
-
stateroomNumber(optional):
string
Minimum Length:
1
Pattern:^[a-zA-Z0-9]+$
stateroomNumberExample:1001
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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