NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Retrieve the onboard status for a profile

get

/spms/v1/reservations/{reservationId}/onboardStatus

This is to retrieve the onboard status for a profile

Request

Supported Media Types

• application/json

Path Parameters

• reservationId: integer

Back to Top

Response

Supported Media Types

• application/json

200 Response

Get Status successfully

Body ()

Root Schema : Oracle Response object with singular object returned

Type: object

Title: Oracle Response object with singular object returned

The wrapper object when returning successful values in Oracle standard

Show Source

• item(optional): object item

{
    "title":"Oracle Response object with singular object returned",
    "description":"The wrapper object when returning successful values in Oracle standard",
    "type":"object",
    "properties":{
        "item":{
            "type":"object",
            "items":{
                "$ref":"#/definitions/staterooms"
            }
        }
    }
}

Nested Schema : item

Type: object

Show Source

• Array of: object staterooms
  Special Needs

{
    "type":"object",
    "items":{
        "$ref":"#/definitions/staterooms"
    }
}

Nested Schema : staterooms

Type: object

Special Needs

Show Source

• roomNumber(optional): string
  Minimum Value: 1

  Maximum Value: 100

  Pattern: ^[a-zA-Z ]*$

  Example: 1001
• roomProfileType(optional): string
  Minimum Value: 1

  Maximum Value: 200

  Pattern: ^[a-zA-Z ]*$

  Example: guest

{
    "description":"Special Needs",
    "type":"object",
    "properties":{
        "roomNumber":{
            "type":"string",
            "minimum":1,
            "maximum":100,
            "pattern":"^[a-zA-Z ]*$",
            "example":"1001"
        },
        "roomProfileType":{
            "type":"string",
            "minimum":1,
            "maximum":200,
            "pattern":"^[a-zA-Z ]*$",
            "example":"guest"
        }
    }
}

Example Response (application/json)

{
    "reservationId":989323,
    "onBoardStatus":"ONBOARD"
}

403 Response

This API is not allowed for your current user role

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

404 Response

Invalid parameter(s) passed in

Body ()

Root Schema : Oracle Response object with singular object returned

Type: object

Title: Oracle Response object with singular object returned

The wrapper object when returning successful values in Oracle standard

Show Source

• item(optional): array item
  A list object that contains error message and field.

{
    "title":"Oracle Response object with singular object returned",
    "description":"The wrapper object when returning successful values in Oracle standard",
    "type":"object",
    "properties":{
        "item":{
            "type":"array",
            "description":"A list object that contains error message and field."
        }
    }
}

Nested Schema : item

Type: array

A list object that contains error message and field.

Example Response (application/json)

{
    "item":[
        {
            "message":"Reservation Id is missing!",
            "field":"reservationId"
        }
    ]
}

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

Get Status failed

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 occured 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