GET api/questionnaires/questionnaire/{questionnaireGroupID}
Get a questionnaire by questionnaire group id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| questionnaireGroupID |
Questionnaire Group ID. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
OrgQuestionnaireGroup| Name | Description | Type | Additional information |
|---|---|---|---|
| NumberOfQuestionnairesAvailable |
Number of active questionnaires available for this group. |
integer |
None. |
| IsLicensed |
If the questionnaire group is licensed for your organisation. |
boolean |
None. |
| QuestionnaireGroupID |
Questionnaire group id |
integer |
None. |
| QuestionnaireGroupName |
Questionnaire group name |
string |
None. |
| QuestionnaireGroupIcon |
Questionnaire group icon |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"NumberOfQuestionnairesAvailable": 1,
"IsLicensed": true,
"QuestionnaireGroupID": 3,
"QuestionnaireGroupName": "sample string 4",
"QuestionnaireGroupIcon": "sample string 5"
}
application/xml, text/xml
Sample:
<OrgQuestionnaireGroup xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <QuestionnaireGroupID>3</QuestionnaireGroupID> <QuestionnaireGroupName>sample string 4</QuestionnaireGroupName> <QuestionnaireGroupIcon>sample string 5</QuestionnaireGroupIcon> <NumberOfQuestionnairesAvailable>1</NumberOfQuestionnairesAvailable> <IsLicensed>true</IsLicensed> </OrgQuestionnaireGroup>
