Retrieve Questionnaire Templates
get
/spms/v1/questionnaires/templates
Retrieve list of questionnaire templates
Request
Supported Media Types
- application/json
Query Parameters
-
categoryId: string
Questionnaire category Id
-
enabled: boolean
Activation status of questionnaire template: * `true` - Questionnaire template is active * `false` - Questionnaire template is inactive
-
limit: integer(int32)
Minimum Value:
1
Paging limit -
offset: integer(int32)
Minimum Value:
0
Paging offset -
templateName: string
Filter template name
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : schema
Type:
Show Source
array
-
Array of:
object Questionnaire Template Setup
Title:
Questionnaire Template Setup
Questionnaire Template Setup
Nested Schema : Questionnaire Template Setup
Type:
object
Title:
Questionnaire Template Setup
Questionnaire Template Setup
Show Source
-
count(optional):
number
The total number of items in the list.Example:
3
-
hasMore(optional):
boolean
Flag which indicates whether or not there are more items.Example:
false
-
items(optional):
array items
-
limit(optional):
number
Paging limitExample:
5
-
offset(optional):
number
Paging offsetExample:
10
Nested Schema : items
Type:
Show Source
array
-
Array of:
object questionnaireTemplateWithId
Questionnaire template
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
-
enabled:
boolean
Activation status of questionnaire template: * `true` - Questionnaire template is active * `false` - Questionnaire template is inactive
-
id:
number
Minimum Value:
1
Pattern:^[0-9]*$
Questionnaire template IdExample:1001
-
questionnaireCategory:
object questionnaireCategory
Questionnaire Categorye
-
templateName:
string
Minimum Length:
1
Maximum Length:4000
The name of questionnaire templateExample:China Embarkation Questionnaire
-
viewOnly(optional):
boolean
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
Questionnaire Categorye
Show Source
-
categoryName(optional):
string
Minimum Value:
1
Maximum Value:255
Example:Chinese
-
enabled(optional):
boolean
Example:
true
-
id(optional):
number
Minimum Value:
1
Maximum Value:12
Pattern:^[0-9_]*$
Example:2.1548485562E10
-
viewOnly(optional):
boolean
Example:
false
204 Response
No Content
401 Response
Unauthorized
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.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":"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
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":"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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
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
Error occured while processing this 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.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
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.5.4",
"title":"Service not available",
"detail":""
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source