Oracle Hospitality Cruise REST API

Update a question by question id

put

/spms/v1/questionnaires/templates/{templateId}/questionGroups/{questionGroupId}/questions/{questionId}

This is to update a question by question id

Request

Supported Media Types

application/json

Path Parameters

questionGroupId: integer
questionId: integer
templateId: integer

Required to update question

Root Schema : Question

Type: object

Title: Question

Question for questionnaire

Show Source

answers(optional): array answers
displayMethod(optional): string

Minimum Length: 1

Maximum Length: 50

Allowed Values: [ "VERTICAL", "HORIZONTAL" ]

Example: HORIZONTAL
id(optional): integer

Minimum Value: 1
orderNumber(optional): integer

Minimum Value: 1

Maximum Value: 100
question(optional): object question

A hashmap which contains key/value pairs
questionType(optional): string

Minimum Length: 1

Maximum Length: 50

Allowed Values: [ "SINGLE_SELECTION", "MULTI_SELECTION", "FREE_TEXT" ]

Example: MULTI_SELECTION

{
    "title":"Question",
    "description":"Question for questionnaire",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "minimum":1
        },
        "question":{
            "type":"object",
            "description":"A hashmap which contains key/value pairs",
            "properties":{
                "default":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":2000,
                    "example":"Do you have the following symptoms?"
                },
                "zh":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":2000,
                    "example":"????????????????????????"
                }
            }
        },
        "orderNumber":{
            "type":"integer",
            "minimum":1,
            "maximum":100
        },
        "questionType":{
            "type":"string",
            "minLength":1,
            "maxLength":50,
            "enum":[
                "SINGLE_SELECTION",
                "MULTI_SELECTION",
                "FREE_TEXT"
            ],
            "example":"MULTI_SELECTION"
        },
        "displayMethod":{
            "type":"string",
            "minLength":1,
            "maxLength":50,
            "enum":[
                "VERTICAL",
                "HORIZONTAL"
            ],
            "example":"HORIZONTAL"
        },
        "answers":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"integer",
                        "minimum":1
                    },
                    "orderNumber":{
                        "type":"integer",
                        "minimum":1,
                        "maximum":10
                    },
                    "answerText":{
                        "type":"object",
                        "description":"A hashmap which contains key/value pairs",
                        "properties":{
                            "default":{
                                "type":"string",
                                "minLength":1,
                                "maxLength":2000,
                                "example":"Diarrhea"
                            },
                            "zh":{
                                "type":"string",
                                "minLength":1,
                                "maxLength":2000,
                                "example":"??????"
                            }
                        }
                    },
                    "alert":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "type":"integer",
                                "minimum":1
                            },
                            "enabled":{
                                "type":"boolean"
                            },
                            "alertMessage":{
                                "type":"string",
                                "minLength":1,
                                "maxLength":4000,
                                "example":"Alert!!!! Diarrhea!!!"
                            }
                        }
                    },
                    "requiredToSpecify":{
                        "type":"boolean"
                    }
                }
            }
        }
    }
}

Nested Schema : answers

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "type":"integer",
                "minimum":1
            },
            "orderNumber":{
                "type":"integer",
                "minimum":1,
                "maximum":10
            },
            "answerText":{
                "type":"object",
                "description":"A hashmap which contains key/value pairs",
                "properties":{
                    "default":{
                        "type":"string",
                        "minLength":1,
                        "maxLength":2000,
                        "example":"Diarrhea"
                    },
                    "zh":{
                        "type":"string",
                        "minLength":1,
                        "maxLength":2000,
                        "example":"??????"
                    }
                }
            },
            "alert":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"integer",
                        "minimum":1
                    },
                    "enabled":{
                        "type":"boolean"
                    },
                    "alertMessage":{
                        "type":"string",
                        "minLength":1,
                        "maxLength":4000,
                        "example":"Alert!!!! Diarrhea!!!"
                    }
                }
            },
            "requiredToSpecify":{
                "type":"boolean"
            }
        }
    }
}

Nested Schema : question

Type: object

A hashmap which contains key/value pairs

Show Source

default(optional): string

Minimum Length: 1

Maximum Length: 2000

Example: Do you have the following symptoms?
zh(optional): string

Minimum Length: 1

Maximum Length: 2000

Example: ????????????????????????

{
    "type":"object",
    "description":"A hashmap which contains key/value pairs",
    "properties":{
        "default":{
            "type":"string",
            "minLength":1,
            "maxLength":2000,
            "example":"Do you have the following symptoms?"
        },
        "zh":{
            "type":"string",
            "minLength":1,
            "maxLength":2000,
            "example":"????????????????????????"
        }
    }
}

Nested Schema : items

Type: object

Show Source

alert(optional): object alert
answerText(optional): object answerText

A hashmap which contains key/value pairs
id(optional): integer

Minimum Value: 1
orderNumber(optional): integer

Minimum Value: 1

Maximum Value: 10
requiredToSpecify(optional): boolean

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "minimum":1
        },
        "orderNumber":{
            "type":"integer",
            "minimum":1,
            "maximum":10
        },
        "answerText":{
            "type":"object",
            "description":"A hashmap which contains key/value pairs",
            "properties":{
                "default":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":2000,
                    "example":"Diarrhea"
                },
                "zh":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":2000,
                    "example":"??????"
                }
            }
        },
        "alert":{
            "type":"object",
            "properties":{
                "id":{
                    "type":"integer",
                    "minimum":1
                },
                "enabled":{
                    "type":"boolean"
                },
                "alertMessage":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":4000,
                    "example":"Alert!!!! Diarrhea!!!"
                }
            }
        },
        "requiredToSpecify":{
            "type":"boolean"
        }
    }
}

Nested Schema : alert

Type: object

Show Source

alertMessage(optional): string

Minimum Length: 1

Maximum Length: 4000

Example: Alert!!!! Diarrhea!!!
enabled(optional): boolean
id(optional): integer

Minimum Value: 1

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "minimum":1
        },
        "enabled":{
            "type":"boolean"
        },
        "alertMessage":{
            "type":"string",
            "minLength":1,
            "maxLength":4000,
            "example":"Alert!!!! Diarrhea!!!"
        }
    }
}

Nested Schema : answerText

Type: object

A hashmap which contains key/value pairs

Show Source

default(optional): string

Minimum Length: 1

Maximum Length: 2000

Example: Diarrhea
zh(optional): string

Minimum Length: 1

Maximum Length: 2000

Example: ??????

{
    "type":"object",
    "description":"A hashmap which contains key/value pairs",
    "properties":{
        "default":{
            "type":"string",
            "minLength":1,
            "maxLength":2000,
            "example":"Diarrhea"
        },
        "zh":{
            "type":"string",
            "minLength":1,
            "maxLength":2000,
            "example":"??????"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : Question

Type: object

Title: Question

Question for questionnaire

Show Source

answers(optional): array answers
displayMethod(optional): string

Minimum Length: 1

Maximum Length: 50

Allowed Values: [ "VERTICAL", "HORIZONTAL" ]

Example: HORIZONTAL
id(optional): integer

Minimum Value: 1
orderNumber(optional): integer

Minimum Value: 1

Maximum Value: 100
question(optional): object question

A hashmap which contains key/value pairs
questionType(optional): string

Minimum Length: 1

Maximum Length: 50

Allowed Values: [ "SINGLE_SELECTION", "MULTI_SELECTION", "FREE_TEXT" ]

Example: MULTI_SELECTION
viewOnly(optional): boolean

{
    "title":"Question",
    "description":"Question for questionnaire",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "minimum":1
        },
        "question":{
            "type":"object",
            "description":"A hashmap which contains key/value pairs",
            "properties":{
                "default":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":2000,
                    "example":"Do you have the following symptoms?"
                },
                "zh":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":2000,
                    "example":"????????????????????????"
                }
            }
        },
        "orderNumber":{
            "type":"integer",
            "minimum":1,
            "maximum":100
        },
        "questionType":{
            "type":"string",
            "minLength":1,
            "maxLength":50,
            "enum":[
                "SINGLE_SELECTION",
                "MULTI_SELECTION",
                "FREE_TEXT"
            ],
            "example":"MULTI_SELECTION"
        },
        "displayMethod":{
            "type":"string",
            "minLength":1,
            "maxLength":50,
            "enum":[
                "VERTICAL",
                "HORIZONTAL"
            ],
            "example":"HORIZONTAL"
        },
        "answers":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"integer",
                        "minimum":1
                    },
                    "orderNumber":{
                        "type":"integer",
                        "minimum":1,
                        "maximum":10
                    },
                    "answerText":{
                        "type":"object",
                        "description":"A hashmap which contains key/value pairs",
                        "properties":{
                            "default":{
                                "type":"string",
                                "minLength":1,
                                "maxLength":2000,
                                "example":"Diarrhea"
                            },
                            "zh":{
                                "type":"string",
                                "minLength":1,
                                "maxLength":2000,
                                "example":"??????"
                            }
                        }
                    },
                    "alert":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "type":"integer",
                                "minimum":1
                            },
                            "enabled":{
                                "type":"boolean"
                            },
                            "alertMessage":{
                                "type":"string",
                                "minLength":1,
                                "maxLength":4000,
                                "example":"Alert!!!! Diarrhea!!!"
                            }
                        }
                    },
                    "requiredToSpecify":{
                        "type":"boolean"
                    }
                }
            }
        },
        "viewOnly":{
            "type":"boolean"
        }
    }
}

Nested Schema : answers

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "type":"integer",
                "minimum":1
            },
            "orderNumber":{
                "type":"integer",
                "minimum":1,
                "maximum":10
            },
            "answerText":{
                "type":"object",
                "description":"A hashmap which contains key/value pairs",
                "properties":{
                    "default":{
                        "type":"string",
                        "minLength":1,
                        "maxLength":2000,
                        "example":"Diarrhea"
                    },
                    "zh":{
                        "type":"string",
                        "minLength":1,
                        "maxLength":2000,
                        "example":"??????"
                    }
                }
            },
            "alert":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"integer",
                        "minimum":1
                    },
                    "enabled":{
                        "type":"boolean"
                    },
                    "alertMessage":{
                        "type":"string",
                        "minLength":1,
                        "maxLength":4000,
                        "example":"Alert!!!! Diarrhea!!!"
                    }
                }
            },
            "requiredToSpecify":{
                "type":"boolean"
            }
        }
    }
}

Nested Schema : question

Type: object

A hashmap which contains key/value pairs

Show Source

default(optional): string

Minimum Length: 1

Maximum Length: 2000

Example: Do you have the following symptoms?
zh(optional): string

Minimum Length: 1

Maximum Length: 2000

Example: ????????????????????????

{
    "type":"object",
    "description":"A hashmap which contains key/value pairs",
    "properties":{
        "default":{
            "type":"string",
            "minLength":1,
            "maxLength":2000,
            "example":"Do you have the following symptoms?"
        },
        "zh":{
            "type":"string",
            "minLength":1,
            "maxLength":2000,
            "example":"????????????????????????"
        }
    }
}

Nested Schema : items

Type: object

Show Source

alert(optional): object alert
answerText(optional): object answerText

A hashmap which contains key/value pairs
id(optional): integer

Minimum Value: 1
orderNumber(optional): integer

Minimum Value: 1

Maximum Value: 10
requiredToSpecify(optional): boolean

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "minimum":1
        },
        "orderNumber":{
            "type":"integer",
            "minimum":1,
            "maximum":10
        },
        "answerText":{
            "type":"object",
            "description":"A hashmap which contains key/value pairs",
            "properties":{
                "default":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":2000,
                    "example":"Diarrhea"
                },
                "zh":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":2000,
                    "example":"??????"
                }
            }
        },
        "alert":{
            "type":"object",
            "properties":{
                "id":{
                    "type":"integer",
                    "minimum":1
                },
                "enabled":{
                    "type":"boolean"
                },
                "alertMessage":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":4000,
                    "example":"Alert!!!! Diarrhea!!!"
                }
            }
        },
        "requiredToSpecify":{
            "type":"boolean"
        }
    }
}

Nested Schema : alert

Type: object

Show Source

alertMessage(optional): string

Minimum Length: 1

Maximum Length: 4000

Example: Alert!!!! Diarrhea!!!
enabled(optional): boolean
id(optional): integer

Minimum Value: 1

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "minimum":1
        },
        "enabled":{
            "type":"boolean"
        },
        "alertMessage":{
            "type":"string",
            "minLength":1,
            "maxLength":4000,
            "example":"Alert!!!! Diarrhea!!!"
        }
    }
}

Nested Schema : answerText

Type: object

A hashmap which contains key/value pairs

Show Source

default(optional): string

Minimum Length: 1

Maximum Length: 2000

Example: Diarrhea
zh(optional): string

Minimum Length: 1

Maximum Length: 2000

Example: ??????

{
    "type":"object",
    "description":"A hashmap which contains key/value pairs",
    "properties":{
        "default":{
            "type":"string",
            "minLength":1,
            "maxLength":2000,
            "example":"Diarrhea"
        },
        "zh":{
            "type":"string",
            "minLength":1,
            "maxLength":2000,
            "example":"??????"
        }
    }
}

400 Response

Bad Request

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionSetupErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter 'templateId' has incorrect format"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter 'templateId' has incorrect format"
}

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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionSetupErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorised",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorised",
    "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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionSetupErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Question group not found."
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Question group not 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionSetupErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Supported",
        "detail":"HTTP method not supported for this resource"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Supported",
    "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"
        }
    }
}

500 Response

Internal Server Error

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

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