Retrieve questionnaire questions by question group id
get
/spms/v1/questionnaires/templates/{templateId}/questionGroups/{questionGroupId}/questions
This is to retrieve questionnaire questions by question group id
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
OK
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Question
Title:
Question
Question for questionnaire
Example:
[
{
"id":1,
"question":{
"default":"Do you have the following symptoms?",
"zh":"????????????????????????"
},
"orderNumber":1,
"questionType":"MULTI_SELECTION",
"displayMethod":"HORIZONTAL",
"answers":[
{
"id":1,
"orderNumber":1,
"answerText":{
"default":"Diarrhea",
"zh":"??????"
},
"alert":{
"id":1,
"enabled":true,
"alertMessage":"Alert!!!! Diarrhea!!!"
}
},
{
"id":2,
"orderNumber":2,
"answerText":{
"default":"Vomiting",
"zh":"??????"
}
},
{
"id":3,
"orderNumber":3,
"answerText":{
"default":"Others (please specify)",
"zh":"?????????????????????"
},
"requiredToSpecify":true
}
],
"viewOnly":true
},
{
"id":2,
"question":{
"default":"Do you have any allegy?",
"zh":"??????????????????"
},
"orderNumber":2,
"questionType":"FREE_TEXT",
"viewOnly":true
}
]
Nested Schema : Question
Type:
object
Title:
Question
Question for questionnaire
Show Source
-
answers(optional):
array answers
-
displayMethod(optional):
string
Minimum Length:
1
Maximum Length:50
Allowed Values:[ "VERTICAL", "HORIZONTAL" ]
Example:HORIZONTAL
-
id(optional):
integer
Minimum Value:
1
-
orderNumber(optional):
integer
Minimum Value:
1
Maximum Value:100
-
question(optional):
object question
A hashmap which contains key/value pairs
-
questionType(optional):
string
Minimum Length:
1
Maximum Length:50
Allowed Values:[ "SINGLE_SELECTION", "MULTI_SELECTION", "FREE_TEXT" ]
Example:MULTI_SELECTION
-
viewOnly(optional):
boolean
Nested Schema : question
Type:
object
A hashmap which contains key/value pairs
Show Source
-
default(optional):
string
Minimum Length:
1
Maximum Length:2000
Example:Do you have the following symptoms?
-
zh(optional):
string
Minimum Length:
1
Maximum Length:2000
Example:????????????????????????
Nested Schema : items
Type:
Show Source
object
-
alert(optional):
object alert
-
answerText(optional):
object answerText
A hashmap which contains key/value pairs
-
id(optional):
integer
Minimum Value:
1
-
orderNumber(optional):
integer
Minimum Value:
1
Maximum Value:10
-
requiredToSpecify(optional):
boolean
Nested Schema : alert
Type:
Show Source
object
-
alertMessage(optional):
string
Minimum Length:
1
Maximum Length:4000
Example:Alert!!!! Diarrhea!!!
-
enabled(optional):
boolean
-
id(optional):
integer
Minimum Value:
1
Nested Schema : answerText
Type:
object
A hashmap which contains key/value pairs
Show Source
-
default(optional):
string
Minimum Length:
1
Maximum Length:2000
Example:Diarrhea
-
zh(optional):
string
Minimum Length:
1
Maximum Length:2000
Example:??????
204 Response
No Content
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":"https://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
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":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
"title":"Not Found",
"detail":"Question group 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
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