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

Save a Questionnaire Acknowledgement by Reservation Id and Template Id

post

/spms/v2/ships/{shipId}/reservations/{reservationId}/questionnairesAcknowledgements/{questionnairesAcknowledgementId}

This is to create/update an acknowledged questionnaire template by reservation id and template id

Request

Supported Media Types
Path Parameters
Body ()
Required to save Questionnaire Acknowledgement
Root Schema : questionnaireAcknowledgementWithoutId
Type: object
Questionnaire Acknowledgement
Show Source
Example:
{
    "acknowledgedAnswers":[
        {
            "questionId":"1122",
            "answers":[
                {
                    "answerId":"1"
                },
                {
                    "answerId":"2"
                },
                {
                    "answerId":"3"
                }
            ]
        },
        {
            "questionId":"1222",
            "answers":[
                {
                    "answerId":"4",
                    "answerText":"This is guest specify answer."
                }
            ]
        },
        {
            "questionId":"1333",
            "answers":[
                {
                    "answerText":"This is guest specify answer."
                }
            ]
        }
    ],
    "acknowledgement":{
        "signature":"/9j/4AAQSkZJRgABAQEASABIAAD=="
    }
}
Nested Schema : acknowledgedAnswers
Type: array
Show Source
Nested Schema : signatureAcknowledgement
Type: object
Questionnaire Signature Acknowledgement
Show Source
Nested Schema : questionAnswer
Type: object
Question and Answer
Show Source
Nested Schema : answers
Type: array
Show Source
Nested Schema : answer
Type: object
Answer and Text
Show Source
  • Minimum Value: 1
    Pattern: ^[0-9]*$
    Questionnaire Answer Id
    Example: 1001
  • Minimum Length: 1
    Maximum Length: 255
    Text Answer for the Question
    Example: Health
Back to Top

Response

Supported Media Types

201 Response

CREATED
Body ()
Root Schema : questionnaireAcknowledgement
Type: object
Questionnaire Acknowledgement
Show Source
Example:
{
    "reservationId":"1234",
    "templateId":"1",
    "acknowledgedAnswers":[
        {
            "questionId":"1122",
            "answers":[
                {
                    "answerId":"1"
                },
                {
                    "answerId":"2"
                },
                {
                    "answerId":"3"
                }
            ]
        },
        {
            "questionId":"1222",
            "answers":[
                {
                    "answerId":"4",
                    "answerText":"This is guest specify answer."
                }
            ]
        },
        {
            "questionId":"1333",
            "answers":[
                {
                    "answerText":"This is guest specify answer."
                }
            ]
        }
    ],
    "acknowledgement":{
        "signature":"/9j/4AAQSkZJRgABAQEASABIAAD=="
    }
}
Nested Schema : acknowledgedAnswers
Type: array
Show Source
Nested Schema : signatureAcknowledgement
Type: object
Questionnaire Signature Acknowledgement
Show Source
Nested Schema : questionAnswer
Type: object
Question and Answer
Show Source
Nested Schema : answers
Type: array
Show Source
Nested Schema : answer
Type: object
Answer and Text
Show Source
  • Minimum Value: 1
    Pattern: ^[0-9]*$
    Questionnaire Answer Id
    Example: 1001
  • Minimum Length: 1
    Maximum Length: 255
    Text Answer for the Question
    Example: Health

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 shipId 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":"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

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":"Ship 123 was 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

409 Response

CONFLICT
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
    "title":"Conflict",
    "detail":""
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

415 Response

UNSUPPORTED MEDIA TYPE
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Invalid content",
    "detail":"Content type Not supported"
}
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