1. Oracle Hospitality Cruise REST API
  2. Tasks
  3. Questionnaire
  4. Questionnaire Acknowledgement

Retrieve questionnaire acknowledgement by template id

get

/spms/v1/questionnaires/templates/{templateId}/acknowledgement

This is to retrieve questionnaire acknowledgement by template id

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Questionnaire Acknowledgement
Type: object
Title: Questionnaire Acknowledgement
Acknowledgement for Questionnaire
Show Source
Example:
{
    "id":1,
    "acknowledgement":{
        "title":{
            "default":"Questionnaire Acknowledgement",
            "zh":"问卷确认"
        },
        "description":{
            "default":"I hereby acknowledge the above given answers in this questionnaire are accurate and without any obligation.",
            "zh":"我特此确认，本问卷中上述给出的答案是准确的，没有任何义务。"
        },
        "enabled":true
    },
    "signature":{
        "enabled":true
    },
    "viewOnly":true
}
Nested Schema : acknowledgement
Type: object
Show Source
Nested Schema : signature
Type: object
Show Source
Nested Schema : description
Type: object
A hashmap which contains key/value pairs
Show Source
  • Minimum Length: 1
    Maximum Length: 2000
    Example: I hereby acknowledge the above given answers in this questionnaire are accurate and without any obligation.
  • Minimum Length: 1
    Maximum Length: 2000
    Example: 我特此确认，本问卷中上述给出的答案是准确的，没有任何义务。
Nested Schema : title
Type: object
A hashmap which contains key/value pairs
Show Source

204 Response

No Content

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"HTTP://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

401 Response

Unauthorized
Body ()
Root Schema : schema
Match All
Show Source
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

403 Response

Forbidden
Body ()
Root Schema : schema
Match All
Show Source
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

404 Response

Not Found
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Template not found"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

405 Response

Method Not Allowed
Body ()
Root Schema : schema
Match All
Show Source
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

406 Response

Not Acceptable
Body ()
Root Schema : schema
Match All
Show Source
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

500 Response

Internal Server Error
Body ()
Root Schema : schema
Match All
Show Source
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

503 Response

Service Unavailable
Body ()
Root Schema : schema
Match All
Show Source
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
Back to Top