NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns a list of Guardian Profile

Body ()

Root Schema : guardianProfile

Type: object

Guardian Profile

Show Source

• accountId(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Minor account id

  Example: 1234
• guardians(optional): array guardians

{
    "description":"Guardian Profile",
    "type":"object",
    "properties":{
        "accountId":{
            "description":"Minor account id",
            "type":"number",
            "minimum":1,
            "pattern":"^[0-9]*$",
            "example":1234
        },
        "guardians":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/guardian"
            }
        }
    },
    "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"
                    }
                ]
            }
        ]
    }
}

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 : guardians

Type: array

Show Source

• Array of: object guardian
  Guardian

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

Nested Schema : guardian

Type: object

Guardian

Show Source

• accountId(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Guardian account id

  Example: 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

  The first name of the guest

  Example: Kobe
• lastName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  The last name of the guest

  Example: James
• links(optional): array links
• middleName(optional): string
  Minimum Length: 1

  Maximum Length: 20

  The middle name of the guest

  Example: Bean
• photoUrl(optional): string
  The path of the guest photo

  Example: https://oracle.com/resources/james.jpg
• salutation(optional): string
  Minimum Length: 1

  Maximum Length: 20

  The salutation of the guest

  Example: Mr.
• stateRoom(optional): string
  Minimum Length: 1

  Maximum Length: 20

  The stateRoom number

  Example: 601

{
    "description":"Guardian",
    "type":"object",
    "properties":{
        "accountId":{
            "$ref":"#/definitions/accountId"
        },
        "salutation":{
            "$ref":"#/definitions/salutation"
        },
        "firstName":{
            "$ref":"#/definitions/firstName"
        },
        "middleName":{
            "$ref":"#/definitions/middleName"
        },
        "lastName":{
            "$ref":"#/definitions/lastName"
        },
        "stateRoom":{
            "$ref":"#/definitions/stateRoom"
        },
        "photoUrl":{
            "$ref":"#/definitions/photoUrl"
        },
        "accountType":{
            "$ref":"#/definitions/accountType"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object link
  Hateoas link

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

Nested Schema : link

Type: object

Hateoas link

Show Source

• href(optional): string
  Property of a link

  Example: http://localhost:8080/spms/v1/guest/1029607
• rel(optional): string
  Link to the current resource

  Example: canonical

{
    "description":"Hateoas link",
    "type":"object",
    "properties":{
        "rel":{
            "$ref":"#/definitions/rel"
        },
        "href":{
            "$ref":"#/definitions/href"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"Invalid Account Id"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"Invalid Account Id"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

401 Response

You are not authorized to use this API

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorized",
        "detail":""
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorized",
    "detail":""
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"The specified account cannot be found."
    }
}

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

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

405 Response

This method is not available

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Allowed",
        "detail":""
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Allowed",
    "detail":""
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

500 Response

Error occured while processing this request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":""
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Internal Server Error",
    "detail":""
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

502 Response

Bad Gateway

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.3",
        "title":"Bad Gateway",
        "detail":""
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.3",
    "title":"Bad Gateway",
    "detail":""
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

503 Response

Service not available

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service not available",
        "detail":""
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service not available",
    "detail":""
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

Back to Top