NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Validate required information for checking in a reservation

post

/spms/v1/reservations/validation/checkIns

This is to validate required information for checking in a reservation

Request

Supported Media Types

• application/json

Body ()

Reservation ID

Root Schema : reservationId

Type: object

Reservation ID

Show Source

• reservationId(optional): integer(int64)
  Example: 989323

{
    "description":"Reservation ID",
    "type":"object",
    "properties":{
        "reservationId":{
            "type":"integer",
            "format":"int64",
            "example":989323
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Oracle Response returned in singular object

Type: object

Title: Oracle Response returned in singular object

The object returned in Oracle Standard when function is executed successfully

Show Source

• item(optional): array item
  Empty body with 200 HTTP response status code

{
    "title":"Oracle Response returned in singular object",
    "description":"The object returned in Oracle Standard when function is executed successfully",
    "type":"object",
    "properties":{
        "item":{
            "type":"array",
            "description":"Empty body with 200 HTTP response status code"
        }
    }
}

Nested Schema : item

Type: array

Empty body with 200 HTTP response status code

Example Response (application/json)

{
}

400 Response

Invalid parameter(s) passed in

Body ()

Root Schema : Oracle Response returned in singular object

Type: object

Title: Oracle Response returned in singular object

The object returned in Oracle Standard when function is executed successfully

Show Source

• item(optional): array item
  A list of objects that contains error messages and fields grouped by category.

{
    "title":"Oracle Response returned in singular object",
    "description":"The object returned in Oracle Standard when function is executed successfully",
    "type":"object",
    "properties":{
        "item":{
            "type":"array",
            "description":"A list of objects that contains error messages and fields grouped by category."
        }
    }
}

Nested Schema : item

Type: array

A list of objects that contains error messages and fields grouped by category.

Example Response (application/json)

{
    "detail":[
        {
            "step":"PROFILE",
            "error":[
                {
                    "errorPath":"firstName",
                    "message":"First Name is missing!"
                },
                {
                    "errorPath":"lastName",
                    "message":"Last Name is missing!"
                }
            ]
        },
        {
            "step":"GUARDIAN",
            "error":{
                "errorPath":"guardian",
                "message":"Guest is minor, please assign a guardian!"
            }
        }
    ]
}

403 Response

This API is not allowed for the current user

Body ()

Root 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

Method requested not available

Body ()

Root 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......"
        }
    }
}

409 Response

Check-In failed. Reservation is already checked in

Body ()

Root 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 occurred while processing this request

Body ()

Root 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