Retrieve profile details for a guardian associated to a minor
get
/spms/v1/Profiles/{id}/Guardians
This is to retrieve profile details for a guardian associated to a minor
Request
Supported Media Types
- application/json
Path Parameters
-
id: number
Minor account id
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : guardianProfile
Type:
object
Guardian Profile
Show Source
-
accountId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Minor account idExample:1234
-
guardians(optional):
array guardians
Example:
{
"accountId":1234,
"guardians":[
{
"accountId":1122,
"salutation":"Mr.",
"firstName":"Kobe",
"middleName":"Bean",
"lastName":"James",
"stateRoom":601,
"photoUrl":"/guest/1122/photo",
"accountType":"P",
"links":[
{
"rel":"canonical",
"href":"http://localhost:8080/spms/v1/guest/1122"
}
]
},
{
"accountId":3322,
"salutation":"Mr.",
"firstName":"Giannis",
"middleName":"Bean",
"lastName":"Gigi",
"stateRoom":603,
"photoUrl":"/guest/3322/photo",
"accountType":"P",
"links":[
{
"rel":"canonical",
"href":"http://localhost:8080/spms/v1/guest/3322"
}
]
}
]
}
Nested Schema : guardian
Type:
object
Guardian
Show Source
-
accountId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Guardian account idExample:1234
-
accountType(optional):
string
The type of account (P = Guest, C = Crew, R = Resident, V = Visitor)Example:
P
-
firstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
First NameExample:Down
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
Last NameExample:Niel
-
links(optional):
array links
-
middleName(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
Middle Name * `null` if emptyExample:MB
-
photoUrl(optional):
string
The path of the guest photoExample:
https://oracle.com/resources/james.jpg
-
salutation(optional):
string
Pattern:
^[a-zA-Z0-9.]*$
SalutationExample:Mr.
-
stateRoom(optional):
string
Minimum Length:
1
Maximum Length:20
The stateRoom numberExample:601
Nested Schema : link
Type:
object
Hateoas link
Show Source
-
href(optional):
string
Property of a linkExample:
http://localhost:8080/spms/v1/guest/1029607
-
rel(optional):
string
Link to the current resourceExample:
canonical
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":"The parameter id has incorrect format"
}
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":"The specified account cannot 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 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
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
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":"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
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":"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