Retrieve Questionnaire Acknowledgement by Reservation Id
get
/spms/v2/ships/{shipId}/reservations/{reservationId}/questionnairesAcknowledgements
This is to retrieve an acknowledged questionnaire template by reservation id
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : questionnaireAcknowledgement
Type:
object
Questionnaire Acknowledgement
Show Source
-
acknowledgedAnswers:
array acknowledgedAnswers
-
acknowledgement:
object signatureAcknowledgement
Questionnaire Signature Acknowledgement
-
reservationId:
object reservationId
Reservation Id
-
templateId:
number
Minimum Value:
1
Pattern:^[0-9]*$
Questionnaire Template IdExample:1001
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:
Show Source
array
-
Array of:
object questionAnswer
Question and Answer
Nested Schema : signatureAcknowledgement
Type:
object
Questionnaire Signature Acknowledgement
Show Source
-
signature:
string
Minimum Length:
1
Maximum Length:2097152
Guest SignatureExample:/9j/4AAQSkZJRgABAQEASABIAAD==
Nested Schema : reservationId
Type:
object
Reservation Id
Show Source
-
hasManualGuardianAssignment(optional):
boolean(boolean)
This is a value indicate whether this profile has done the manual guardian assignment or not. true - user had perform manual guardian assignment, false - system perform auto guardian assignment based on parameterExample:
true
-
reservationId(optional):
integer(int64)
Reservation IDExample:
12345678
Nested Schema : questionAnswer
Type:
object
Question and Answer
Show Source
-
answers(optional):
array answers
-
questionId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Questionnaire Question IdExample:1001
Nested Schema : answer
Type:
object
Answer and Text
Show Source
-
answerId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Questionnaire Answer IdExample:1001
-
answerText(optional):
string
Minimum Length:
1
Maximum Length:255
Text Answer for the QuestionExample:Health
401 Response
UNAUTHORIZED
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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