Jump to

• Request
• Response

Create new guardian by minor profile ID

post

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

This is to assign a guest as guardian to a minor profile

Request

Supported Media Types

• application/json

Path Parameters

• profileId: integer
  Profile ID
• shipId: number
  Ship Id

Body ()

Guardian Post Object

Root Schema : GuardianPOSTObject

Type: object

Guardian POST Object

Show Source

• guardianDetails(optional): array guardianDetails

{
    "description":"Guardian POST Object",
    "type":"object",
    "properties":{
        "guardianDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/profileId"
            },
            "example":[
                {
                    "profileId":550
                },
                {
                    "profileId":551
                }
            ]
        }
    }
}

Nested Schema : guardianDetails

Type: array

Show Source

• Array of: integer
  Profile ID

  Example: 1001

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/profileId"
    },
    "example":[
        {
            "profileId":550
        },
        {
            "profileId":551
        }
    ]
}

Example:

[
    {
        "profileId":550
    },
    {
        "profileId":551
    }
]

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created

Body ()

Root Schema : GuardianPOSTResponseObject

Type: object

Guardian POST Response Object

Show Source

• age(optional): integer(int32)
  Minimum Value: 1

  Maximum Value: 150

  Age

  Example: 25
• bookingNumber(optional): string
  Minimum Length: 1

  Pattern: ^[a-zA-Z0-9]+$

  Booking Number

  Example: 0123456789
• firstName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: ^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  First Name

  Example: Down
• guardianDetails(optional): array guardianDetails
• lastName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: ^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Last Name

  Example: Niel
• middleName(optional): string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Middle Name * `null` if empty

  Example: MB
• otherFirstName(optional): string
  Minimum Length: 1

  Maximum Length: 80

  Pattern: ^[ a-zA-Z0-9_.??-??????-???]*$

  Other First Name * `null` if empty

  Example: null
• otherLastName(optional): string
  Minimum Length: 1

  Maximum Length: 100

  Pattern: ^[ a-zA-Z0-9_.??-??????-???]*$

  Other Last Name * `null` if empty

  Example: null
• photo(optional): string
  Photo

  Example: /9j/4AAQSkZJRgABAQEASABIAAD==
• profileId(optional): integer
  Profile ID

  Example: 1001
• profileType(optional): string
  Allowed Values: [ "Guest", "Resident" ]

  Profile Type

  Example: Resident
• salutation(optional): string
  Pattern: ^[a-zA-Z0-9.]*$

  Salutation

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

  Pattern: ^[0-9]*$

  Stateroom Number

  Example: 1001

{
    "description":"Guardian POST Response Object",
    "type":"object",
    "properties":{
        "profileId":{
            "$ref":"#/definitions/profileId"
        },
        "profileType":{
            "$ref":"#/definitions/profileType"
        },
        "lastName":{
            "$ref":"#/definitions/lastName"
        },
        "firstName":{
            "$ref":"#/definitions/firstName"
        },
        "middleName":{
            "$ref":"#/definitions/middleName"
        },
        "otherFirstName":{
            "$ref":"#/definitions/otherFirstName"
        },
        "otherLastName":{
            "$ref":"#/definitions/otherLastName"
        },
        "salutation":{
            "$ref":"#/definitions/salutation"
        },
        "stateroomNumber":{
            "$ref":"#/definitions/stateroomNumber"
        },
        "bookingNumber":{
            "$ref":"#/definitions/bookingNumber"
        },
        "photo":{
            "$ref":"#/definitions/photo"
        },
        "age":{
            "$ref":"#/definitions/age"
        },
        "guardianDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/guardianDetails"
            },
            "example":[
                {
                    "profileId":550,
                    "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":551,
                    "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"
                }
            ]
        }
    }
}

Nested Schema : guardianDetails

Type: array

Show Source

• Array of: object guardianDetails
  Guardian Details

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/guardianDetails"
    },
    "example":[
        {
            "profileId":550,
            "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":551,
            "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"
        }
    ]
}

Example:

[
    {
        "profileId":550,
        "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":551,
        "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"
    }
]

Nested Schema : guardianDetails

Type: object

Guardian Details

Show Source

• bookingNumber(optional): string
  Minimum Length: 1

  Pattern: ^[a-zA-Z0-9]+$

  Booking Number

  Example: 0123456789
• firstName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: ^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  First Name

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

  Maximum Length: 40

  Pattern: ^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Last Name

  Example: Niel
• middleName(optional): string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Middle Name * `null` if empty

  Example: MB
• otherFirstName(optional): string
  Minimum Length: 1

  Maximum Length: 80

  Pattern: ^[ a-zA-Z0-9_.??-??????-???]*$

  Other First Name * `null` if empty

  Example: null
• otherLastName(optional): string
  Minimum Length: 1

  Maximum Length: 100

  Pattern: ^[ a-zA-Z0-9_.??-??????-???]*$

  Other Last Name * `null` if empty

  Example: null
• photo(optional): string
  Photo

  Example: /9j/4AAQSkZJRgABAQEASABIAAD==
• profileId(optional): integer
  Profile ID

  Example: 1001
• salutation(optional): string
  Pattern: ^[a-zA-Z0-9.]*$

  Salutation

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

  Pattern: ^[0-9]*$

  Stateroom Number

  Example: 1001

{
    "description":"Guardian Details",
    "type":"object",
    "properties":{
        "profileId":{
            "$ref":"#/definitions/profileId"
        },
        "lastName":{
            "$ref":"#/definitions/lastName"
        },
        "firstName":{
            "$ref":"#/definitions/firstName"
        },
        "middleName":{
            "$ref":"#/definitions/middleName"
        },
        "otherLastName":{
            "$ref":"#/definitions/otherLastName"
        },
        "otherFirstName":{
            "$ref":"#/definitions/otherFirstName"
        },
        "salutation":{
            "$ref":"#/definitions/salutation"
        },
        "stateroomNumber":{
            "$ref":"#/definitions/stateroomNumber"
        },
        "bookingNumber":{
            "$ref":"#/definitions/bookingNumber"
        },
        "photo":{
            "$ref":"#/definitions/photo"
        }
    }
}

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/guardianErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"Invalid parameter(s) passed in"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): 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

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guardianErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guardianErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guardianErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Ship Id was not be found"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): 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

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

Example:

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

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): 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

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guardianErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

409 Response

Conflict

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guardianErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
        "title":"Conflict",
        "detail":"Guardian profile already assigned to this profile id"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
    "title":"Conflict",
    "detail":"Guardian profile already assigned to this profile id"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

410 Response

Gone

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guardianErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
        "title":"Gone",
        "detail":"Requested Resource no longer exists"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): 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

Unsupported Media Type

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guardianErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Unsupported Media Type",
        "detail":"Content type not supported"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): 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

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

501 Response

Not Implemented

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

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

• detail(optional): string
• title(optional): string
• type(optional): 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 Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top