Jump to

• Request
• Response

Retrieve guests profile with criteria search

get

/spms/v1/guest

This is to retrieve guests profile with criteria search using keyword. When the keyword is not defined in the search criteria, all profile records will be return. Otherwise only specific profile records will be listed based on the defined search criteria.

Request

Supported Media Types

• application/json

Query Parameters

• limit: integer(int32)
  Paging limit
• offset: integer(int32)
  Paging offset
• orderBy: string
• profileSearchTemplate: integer(int32)
  profile search template id
• q: string
  keyword(first name, last name, cabin number, booking number, passport number)

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Profile Search List

Type: object

Title: Profile Search List

The object returned in Oracle Standard when function is executed successfully

Show Source

• count(optional): integer
  Example: 18
• hasMore(optional): boolean
  Example: true
• items(optional): array items
• limit(optional): integer
  Example: 2
• links(optional): array links
• offset(optional): integer
  Example: 0

{
    "title":"Profile Search List",
    "description":"The object returned in Oracle Standard when function is executed successfully",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "example":18
        },
        "hasMore":{
            "type":"boolean",
            "example":true
        },
        "limit":{
            "type":"integer",
            "example":2
        },
        "offset":{
            "type":"integer",
            "example":0
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReturnSearchData"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/linksProfile"
                    },
                    {
                        "properties":{
                            "href":{
                                "type":"string",
                                "example":"http://[HOSTNAME]/spms/v1/guest?q=john&offset=0&limit=2&orderBy=passportNumber"
                            },
                            "operationId":{
                                "type":"string",
                                "example":"search"
                            }
                        }
                    }
                ]
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ReturnSearchData
  data return

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

Nested Schema : links

Type: array

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/linksProfile"
            },
            {
                "properties":{
                    "href":{
                        "type":"string",
                        "example":"http://[HOSTNAME]/spms/v1/guest?q=john&offset=0&limit=2&orderBy=passportNumber"
                    },
                    "operationId":{
                        "type":"string",
                        "example":"search"
                    }
                }
            }
        ]
    }
}

Nested Schema : ReturnSearchData

Type: object

data return

Show Source

• item(optional): object ProfileDetails
  Profile Details
• links(optional): links

{
    "description":"data return",
    "type":"object",
    "properties":{
        "item":{
            "$ref":"#/definitions/ProfileDetails"
        },
        "links":{
            "allOf":[
                {
                    "$ref":"#/definitions/linksProfile"
                },
                {
                    "properties":{
                        "href":{
                            "type":"string",
                            "example":"http://[HOSTNAME]/spms/v1/guest/1000001"
                        },
                        "operationId":{
                            "type":"string",
                            "example":"findByID"
                        }
                    }
                }
            ]
        }
    }
}

Nested Schema : ProfileDetails

Type: object

Profile Details

Show Source

• accountCategory(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^SYS|GRP|CRW|PAX|VTO$

  Example: PAX
• accountType(optional): string
  Allowed Values: [ "A", "P", "C", "G", "V", "O" ]

  Pattern: ^A|P|C|G|V|O$

  Example: System Account, Passenger, Crew, Group, Visitor
• age(optional): integer(int32)
  Minimum Value: 1

  Maximum Value: 150

  Example: 57
• alternativeContactNum(optional): string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^\+?(?:[0-9] ?){6,14}[0-9]$

  Example: +0123456789
• classification(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: [a-z0-9]

  Example: [VIP]
• contactNum(optional): string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^\+?(?:[0-9] ?){6,14}[0-9]$

  Example: +0123456789
• countryOfBirth(optional): string
  Minimum Length: 1

  Maximum Length: 3

  Pattern: ^[ A-Za-z0-9_@./#&+-]*$

  Example: US
• countryOfResidence(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9_@./#&+-]*$

  Example: US
• dateOfBirth(optional): string(date-time)
  Example: 1961-04-01T16:00:00.000+0000
• documentExpiryDate(optional): string(date-time)
  Example: 1961-04-01T16:00:00.000+0000
• documentIssuedCountry(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9_@./#&+-]*$

  Example: US
• documentIssuedDate(optional): string(date-time)
  Example: 1961-04-01T16:00:00.000+0000
• emailAddress(optional): string
  Minimum Length: 1

  Maximum Length: 50

  Pattern: '^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$'

  Example: EMAIL ADD
• emergencyContactName(optional): string
  Minimum Length: 1

  Maximum Length: 40

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

  Example: NAME or FIRST NAME / SURNAME
• emergencyContactNum(optional): string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^\+?(?:[0-9] ?){6,14}[0-9]$

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

  Maximum Length: 40

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

  Example: FIRST NAME
• gender(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: [A-Z]

  Example: M or F
• guestId(optional): integer
  Minimum Value: 0

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

  Maximum Length: 40

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

  Example: LAST NAME
• middleName(optional): string
  Minimum Length: 1

  Maximum Length: 20

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

  Example: MIDDLE NAME
• nationalIdNum(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: [a-z0-9]

  Example: A01234567
• nationality(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: [a-z0-9]

  Example: US
• passportNumber(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: [a-z0-9]

  Example: A012345678
• photo(optional): string
  Example: /Images/People/
• reservationDetails(optional): array reservationDetails
• salutation(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: [a-z]

  Example: MR
• title(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: [a-z0-9]

  Example: Mr
• unicodeName(optional): string
  Minimum Length: 1

  Maximum Length: 100

  Example:

{
    "description":"Profile Details",
    "type":"object",
    "properties":{
        "guestId":{
            "type":"integer",
            "minimum":0,
            "example":1000001
        },
        "nationalIdNum":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":20,
            "example":"A01234567"
        },
        "emergencyContactNum":{
            "type":"string",
            "pattern":"^\\+?(?:[0-9] ?){6,14}[0-9]$",
            "minLength":1,
            "maxLength":30,
            "example":"+0123456789"
        },
        "contactNum":{
            "type":"string",
            "pattern":"^\\+?(?:[0-9] ?){6,14}[0-9]$",
            "minLength":1,
            "maxLength":30,
            "example":"+0123456789"
        },
        "emergencyContactName":{
            "type":"string",
            "pattern":"^[a-zA-Z??-????-????-??0-9 _,?/.\\-+*n~!@#$%&{}[]()=<>|^'\":;@`]*$",
            "minLength":1,
            "maxLength":40,
            "example":"NAME or FIRST NAME / SURNAME"
        },
        "emailAddress":{
            "type":"string",
            "pattern":"'^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$'",
            "minLength":1,
            "maxLength":50,
            "example":"EMAIL ADD"
        },
        "alternativeContactNum":{
            "type":"string",
            "pattern":"^\\+?(?:[0-9] ?){6,14}[0-9]$",
            "minLength":1,
            "maxLength":30,
            "example":"+0123456789"
        },
        "countryOfResidence":{
            "type":"string",
            "pattern":"^[ A-Za-z0-9_@./#&+-]*$",
            "minLength":1,
            "maxLength":6,
            "example":"US"
        },
        "countryOfBirth":{
            "type":"string",
            "pattern":"^[ A-Za-z0-9_@./#&+-]*$",
            "minLength":1,
            "maxLength":3,
            "example":"US"
        },
        "documentIssuedCountry":{
            "type":"string",
            "pattern":"^[ A-Za-z0-9_@./#&+-]*$",
            "minLength":1,
            "maxLength":6,
            "example":"US"
        },
        "documentExpiryDate":{
            "type":"string",
            "format":"date-time",
            "example":"1961-04-01T16:00:00.000+0000"
        },
        "documentIssuedDate":{
            "type":"string",
            "format":"date-time",
            "example":"1961-04-01T16:00:00.000+0000"
        },
        "nationality":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":6,
            "example":"US"
        },
        "middleName":{
            "type":"string",
            "pattern":"^[a-zA-Z??-????-????-??0-9 _,?/.\\-+*n~!@#$%&{}[]()=<>|^'\":;@`]*$",
            "minLength":1,
            "maxLength":20,
            "example":"MIDDLE NAME"
        },
        "title":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":20,
            "example":"Mr"
        },
        "unicodeName":{
            "type":"string",
            "minLength":1,
            "maxLength":100,
            "example":""
        },
        "gender":{
            "type":"string",
            "minLength":1,
            "maxLength":6,
            "example":"M or F",
            "pattern":"[A-Z]"
        },
        "accountType":{
            "type":"string",
            "pattern":"^A|P|C|G|V|O$",
            "enum":[
                "A",
                "P",
                "C",
                "G",
                "V",
                "O"
            ],
            "example":"System Account, Passenger, Crew, Group, Visitor"
        },
        "dateOfBirth":{
            "type":"string",
            "format":"date-time",
            "example":"1961-04-01T16:00:00.000+0000"
        },
        "age":{
            "type":"integer",
            "format":"int32",
            "minimum":1,
            "maximum":150,
            "example":57
        },
        "salutation":{
            "type":"string",
            "pattern":"[a-z]",
            "minLength":1,
            "maxLength":40,
            "example":"MR"
        },
        "firstName":{
            "type":"string",
            "pattern":"^[a-zA-Z??-????-????-??0-9 _,?/.\\-+*n~!@#$%&{}[]()=<>|^'\":;@`]*$",
            "minLength":1,
            "maxLength":40,
            "example":"FIRST NAME"
        },
        "lastName":{
            "type":"string",
            "pattern":"^[a-zA-Z??-????-????-??0-9 _,?/.\\-+*n~!@#$%&{}[]()=<>|^'\":;@`]*$",
            "minLength":1,
            "maxLength":40,
            "example":"LAST NAME"
        },
        "passportNumber":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":20,
            "example":"A012345678"
        },
        "accountCategory":{
            "type":"string",
            "pattern":"^SYS|GRP|CRW|PAX|VTO$",
            "minLength":1,
            "maxLength":6,
            "example":"PAX"
        },
        "photo":{
            "type":"string",
            "example":"/Images/People/"
        },
        "classification":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":20,
            "example":"[VIP]"
        },
        "reservationDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReservationDetails"
            }
        }
    }
}

Nested Schema : links

Match All

Show Source

• object linksProfile
  links detail
• object links-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/linksProfile"
        },
        {
            "properties":{
                "href":{
                    "type":"string",
                    "example":"http://[HOSTNAME]/spms/v1/guest/1000001"
                },
                "operationId":{
                    "type":"string",
                    "example":"findByID"
                }
            }
        }
    ]
}

Nested Schema : reservationDetails

Type: array

Show Source

• Array of: object ReservationDetails
  Reservation Details

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

Nested Schema : ReservationDetails

Type: object

Reservation Details

Show Source

• accountId(optional): integer
  Minimum Value: 1

  Example: 1000001
• actualDisembarkDate(optional): string(date-time)
  Example: null or 2015-09-09T16:00:00.000+0000
• actualEmbarkDate(optional): string(date-time)
  Example: 2015-09-02T16:00:00.000+0000
• assemblyStationCode(optional): string
  Minimum Length: 0

  Maximum Length: 6

  Pattern: [a-z0-9]

  Example: 12345
• assemblyStationName(optional): string
  Minimum Length: 1

  Maximum Length: 50

  Pattern: [a-z0-9]

  Example: 12345
• boardCardNumber(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: [a-z0-9]

  Example: 123456789
• cabinNum(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: [a-z0-9]

  Example: 12345
• consentStatus(optional): boolean
  Example: false
• disembarkDate(optional): string(date-time)
  Example: 2015-09-09T16:00:00.000+0000
• disembarkPort(optional): integer
  Example: 123
• embarkCruiseId(optional): integer(int32)
  Example: 12345
• embarkDate(optional): string(date-time)
  Example: 2015-09-02T16:00:00.000+0000
• embarkPort(optional): integer
  Example: 123
• groupReferenceId(optional): integer(int32)
  Example: 12345
• onboardStatus(optional): boolean
  Example: true
• reservationAccountReferenceId(optional): integer(int32)
  Example: 12345
• reservationAccountType(optional): string
  Minimum Length: 1

  Maximum Length: 1

  Allowed Values: [ "P", "R", "C", "S", "V", "G", "A" ]

  Pattern: ^P|R|C|S|V|G|A$

  Example: P for Pax
• reservationBookingNumber(optional): string
  Minimum Length: 1

  Maximum Length: 100

  Pattern: [a-z0-9]

  Example: 0123456789
• reservationCancelStatus(optional): boolean
  Example: false
• reservationExternalId(optional): string
  Minimum Length: 1

  Maximum Length: 50

  Pattern: [a-z0-9]

  Example: 12345
• reservationId(optional): integer
  Minimum Value: 0

  Example: 12345
• reservationStatus(optional): string
  Minimum Length: 2

  Maximum Length: 2

  Allowed Values: [ "RR", "RX", "RE", "RN", "CC", "CL", "DD", "00" ]

  Example: CC
• routedAccountNumber(optional): integer(int32)
  Example: 12345
• setSailPass(optional): string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: [a-z0-9]

  Example: 12345

{
    "description":"Reservation Details",
    "type":"object",
    "properties":{
        "reservationId":{
            "type":"integer",
            "minimum":0,
            "example":12345
        },
        "reservationExternalId":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":50,
            "example":"12345"
        },
        "disembarkPort":{
            "type":"integer",
            "example":123
        },
        "embarkPort":{
            "type":"integer",
            "example":123
        },
        "accountId":{
            "type":"integer",
            "minimum":1,
            "example":1000001
        },
        "reservationCancelStatus":{
            "type":"boolean",
            "example":false
        },
        "reservationBookingNumber":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":100,
            "example":"0123456789"
        },
        "disembarkDate":{
            "type":"string",
            "format":"date-time",
            "example":"2015-09-09T16:00:00.000+0000"
        },
        "routedAccountNumber":{
            "type":"integer",
            "format":"int32",
            "example":12345
        },
        "actualDisembarkDate":{
            "type":"string",
            "format":"date-time",
            "example":"null or 2015-09-09T16:00:00.000+0000"
        },
        "groupReferenceId":{
            "type":"integer",
            "format":"int32",
            "example":12345
        },
        "cabinNum":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":20,
            "example":"12345"
        },
        "boardCardNumber":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":20,
            "example":"123456789"
        },
        "consentStatus":{
            "type":"boolean",
            "example":false
        },
        "actualEmbarkDate":{
            "type":"string",
            "format":"date-time",
            "example":"2015-09-02T16:00:00.000+0000"
        },
        "reservationAccountType":{
            "type":"string",
            "pattern":"^P|R|C|S|V|G|A$",
            "minLength":1,
            "maxLength":1,
            "enum":[
                "P",
                "R",
                "C",
                "S",
                "V",
                "G",
                "A"
            ],
            "example":"P for Pax"
        },
        "onboardStatus":{
            "type":"boolean",
            "example":true
        },
        "embarkCruiseId":{
            "type":"integer",
            "format":"int32",
            "example":12345
        },
        "reservationAccountReferenceId":{
            "type":"integer",
            "format":"int32",
            "example":12345
        },
        "reservationStatus":{
            "type":"string",
            "minLength":2,
            "maxLength":2,
            "enum":[
                "RR",
                "RX",
                "RE",
                "RN",
                "CC",
                "CL",
                "DD",
                "00"
            ],
            "example":"CC"
        },
        "embarkDate":{
            "type":"string",
            "format":"date-time",
            "example":"2015-09-02T16:00:00.000+0000"
        },
        "setSailPass":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":30,
            "example":"12345"
        },
        "assemblyStationCode":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":0,
            "maxLength":6,
            "example":"12345"
        },
        "assemblyStationName":{
            "type":"string",
            "pattern":"[a-z0-9]",
            "minLength":1,
            "maxLength":50,
            "example":"12345"
        }
    }
}

Nested Schema : linksProfile

Type: object

links detail

Show Source

• method(optional): string
  Example: get
• rel(optional): string
  Example: self

{
    "description":"links detail",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"self"
        },
        "method":{
            "type":"string",
            "example":"get"
        }
    }
}

Nested Schema : links-allOf[1]

Type: object

Show Source

• href(optional): string
  Example: http://[HOSTNAME]/spms/v1/guest/1000001
• operationId(optional): string
  Example: findByID

{
    "properties":{
        "href":{
            "type":"string",
            "example":"http://[HOSTNAME]/spms/v1/guest/1000001"
        },
        "operationId":{
            "type":"string",
            "example":"findByID"
        }
    }
}

Nested Schema : items

Match All

Show Source

• object linksProfile
  links detail
• object items-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/linksProfile"
        },
        {
            "properties":{
                "href":{
                    "type":"string",
                    "example":"http://[HOSTNAME]/spms/v1/guest?q=john&offset=0&limit=2&orderBy=passportNumber"
                },
                "operationId":{
                    "type":"string",
                    "example":"search"
                }
            }
        }
    ]
}

Nested Schema : items-allOf[1]

Type: object

Show Source

• href(optional): string
  Example: http://[HOSTNAME]/spms/v1/guest?q=john&offset=0&limit=2&orderBy=passportNumber
• operationId(optional): string
  Example: search

{
    "properties":{
        "href":{
            "type":"string",
            "example":"http://[HOSTNAME]/spms/v1/guest?q=john&offset=0&limit=2&orderBy=passportNumber"
        },
        "operationId":{
            "type":"string",
            "example":"search"
        }
    }
}

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/GuestProfileErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Bad Request",
        "detail":"Empty request body."
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Bad Request",
    "detail":"Empty request body."
}

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

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/GuestProfileErrorResponse"
        }
    ],
    "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

You are forbidden 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/GuestProfileErrorResponse"
        }
    ],
    "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/GuestProfileErrorResponse"
        }
    ],
    "example":{
        "title":"Not Found",
        "detail":"Profile configuration does not exist",
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
    }
}

Example:

{
    "title":"Not Found",
    "detail":"Profile configuration does not exist",
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
}

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

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/GuestProfileErrorResponse"
        }
    ],
    "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"
    }
}

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

• 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/GuestProfileErrorResponse"
        }
    ],
    "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"
        }
    }
}

415 Response

The media supplied is not supported

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GuestProfileErrorResponse"
        }
    ],
    "example":{
        "title":"Invalid content",
        "detail":"Content type not supported",
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16"
    }
}

Example:

{
    "title":"Invalid content",
    "detail":"Content type not supported",
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16"
}

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

Error occurred 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/GuestProfileErrorResponse"
        }
    ],
    "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"
    }
}

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

• 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 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/GuestProfileErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable. Try again later"
    }
}

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

• 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