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

Retrieve Questionnaire Templates

get

/spms/v1/questionnaires/templates

Retrieve list of questionnaire templates

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : Questionnaire Template Setup
Type: object
Title: Questionnaire Template Setup
Questionnaire Template Setup
Show Source
Nested Schema : items
Type: array
Show Source
Example:
[
    {
        "id":1001,
        "templateName":"China Embarkation Questionnaire",
        "enabled":true,
        "questionnaireCategory":{
            "id":1,
            "category":"Embarakation Questionnaire Category",
            "enabled":true
        },
        "viewOnly":false
    },
    {
        "id":1002,
        "templateName":"German Embarkation Questionnaire",
        "enabled":true,
        "questionnaireCategory":{
            "id":1,
            "category":"Embarakation Questionnaire Category",
            "enabled":true
        },
        "viewOnly":true
    },
    {
        "id":1003,
        "templateName":"Canada Embarkation Questionnaire",
        "enabled":false,
        "questionnaireCategory":{
            "id":1,
            "category":"Embarakation Questionnaire Category",
            "enabled":true
        },
        "viewOnly":false
    }
]
Nested Schema : questionnaireTemplateWithId
Type: object
Questionnaire template
Show Source
  • Activation status of questionnaire template: * `true` - Questionnaire template is active * `false` - Questionnaire template is inactive
  • Minimum Value: 1
    Pattern: ^[0-9]*$
    Questionnaire template Id
    Example: 1001
  • questionnaireCategory
    Title: questionnaireCategory
  • Minimum Length: 1
    Maximum Length: 4000
    The name of questionnaire template
    Example: China Embarkation Questionnaire
  • Read Only: true
    The flag which indicates whether or not questionnaire template is view-only (i.e. unmodifiable and unremovable): * false - Questionnaire template is modifiable. It can be updated or deleted. * true - Questionnaire template is unmodifiable. It cannot be updated or deleted.
Nested Schema : questionnaireCategory
Type: object
Title: questionnaireCategory
Show Source
  • Minimum Length: 1
    Maximum Length: 4000
    Example: Embarkation
  • Activation status of questionnaire category: * `true` - Questionnaire category is active * `false` - Questionnaire category is inactive
  • Minimum Value: 1
    Maximum Value: 12
    Pattern: ^[0-9]*$
    Example: 1

204 Response

No Content

401 Response

Unauthorized
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"https://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":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\"",
    "title":"Forbidden",
    "detail":"Access to this resource is 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":"This resource path does not exist"
}
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:
{
    "title":"Method Not Supported",
    "detail":"HTTP method not supported for this resource",
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6"
}
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

Error occured while processing this request
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Internal Server Error",
    "detail":""
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

503 Response

Service not available
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service not available",
    "detail":""
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source
Back to Top