Create questionnaire acknowledgement by template id
post
/spms/v1/questionnaires/templates/{templateId}/acknowledgement
This is to create questionnaire acknowledgement by template id
Request
Supported Media Types
- application/json
Path Parameters
Required to create questionnaire acknowledgement
Root Schema : Questionnaire Acknowledgement
Type:
object
Title:
Questionnaire Acknowledgement
Acknowledgement for Questionnaire
Show Source
-
acknowledgement(optional):
object acknowledgement
A hashmap which contains key/value pairs
-
signature(optional):
object signature
Example:
{
"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
}
}
Nested Schema : acknowledgement
Type:
object
A hashmap which contains key/value pairs
Show Source
-
description(optional):
object description
A hashmap which contains key/value pairs
-
enabled(optional):
boolean
-
title(optional):
object title
Nested Schema : description
Type:
object
A hashmap which contains key/value pairs
Show Source
-
default(optional):
string
Minimum Length:
1
Maximum Length:2000
Example:I hereby acknowledge the above given answers in this questionnaire are accurate and without any obligation.
-
zh(optional):
string
Minimum Length:
1
Maximum Length:2000
Example:我特此确认,本问卷中上述给出的答案是准确的,没有任何义务。
Nested Schema : title
Type:
Show Source
object
-
default(optional):
string
Minimum Length:
1
Maximum Length:2000
Example:Questionnaire Acknowledgement
-
zh(optional):
string
Minimum Length:
1
Maximum Length:2000
Example:问卷确认
Response
Supported Media Types
- application/json
201 Response
Created
Root Schema : Questionnaire Acknowledgement
Type:
object
Title:
Questionnaire Acknowledgement
Acknowledgement for Questionnaire
Show Source
-
acknowledgement(optional):
object acknowledgement
-
id(optional):
integer
Minimum Value:
1
-
signature(optional):
object signature
-
viewOnly(optional):
boolean
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:
Show Source
object
-
description(optional):
object description
A hashmap which contains key/value pairs
-
enabled(optional):
boolean
-
title(optional):
object title
A hashmap which contains key/value pairs
Nested Schema : description
Type:
object
A hashmap which contains key/value pairs
Show Source
-
default(optional):
string
Minimum Length:
1
Maximum Length:2000
Example:I hereby acknowledge the above given answers in this questionnaire are accurate and without any obligation.
-
zh(optional):
string
Minimum Length:
1
Maximum Length:2000
Example:我特此确认,本问卷中上述给出的答案是准确的,没有任何义务。
Nested Schema : title
Type:
object
A hashmap which contains key/value pairs
Show Source
-
default(optional):
string
Minimum Length:
1
Maximum Length:2000
Example:Questionnaire Acknowledgement
-
zh(optional):
string
Minimum Length:
1
Maximum Length: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
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
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":"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
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
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
409 Response
Conflict
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.10",
"title":"Method Not Allowed",
"detail":"Duplicated TemplateId Found"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
415 Response
Unsupported Media Type
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.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
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