GET api/Questionnaire/LoadQuestionnaireByID/{questionnaireID}
Gets the full questionnaire details based on the ID, this will return the name, description and list of questions for the Questionnaire.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| questionnaireID |
Used to state the Questionnaire ID. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{"ID":1,"Name":"Sample Questionnaire","Description":"This is the description of the questionnaire","Questions":[{"ID":1,"QuestionText":"Sample Question","QuestionType":"Text Box","Compulsory":false,"ExpectedAnswers":"Sample Answer","QuestionOptions":[]}]}
application/xml, text/xml
Sample:
<?xml version="1.0" encoding="utf-16"?>
<Questionnaire xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ID>1</ID>
<Name>Sample Questionnaire</Name>
<Description>This is the description of the questionnaire</Description>
<Questions>
<APIQuestionnaireItem>
<ID>1</ID>
<QuestionText>Sample Question</QuestionText>
<QuestionType>Text Box</QuestionType>
<Compulsory>false</Compulsory>
<ExpectedAnswers>Sample Answer</ExpectedAnswers>
<QuestionOptions />
</APIQuestionnaireItem>
</Questions>
</Questionnaire>