GET api/Survey/GetReferenceSurvey?SurveyID={SurveyID}&ReferenceID={ReferenceID}&DistrictID={DistrictID}&DistrictAddedReferenceID={DistrictAddedReferenceID}&DistrictName={DistrictName}&CanonicalUrl={CanonicalUrl}&IsPreview={IsPreview}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| SurveyID | integer |
None. |
|
| ReferenceID | integer |
None. |
|
| DistrictID | integer |
None. |
|
| DistrictAddedReferenceID | integer |
None. |
|
| DistrictName | string |
None. |
|
| CanonicalUrl | string |
None. |
|
| IsPreview | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
ReferenceSurveyOutput| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| ID | integer |
None. |
|
| SurveyResponseID | integer |
None. |
|
| SurveyRequestID | integer |
None. |
|
| isPossibleFishing | boolean |
None. |
|
| Name | string |
None. |
|
| Instructions | string |
None. |
|
| QuestionsList |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml, text/xml
Sample:
<ReferenceSurveyOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Public">
<ID>3</ID>
<Instructions>sample string 8</Instructions>
<Message>sample string 2</Message>
<Name>sample string 7</Name>
<QuestionsList>
<SurveyQuestionOutput>
<Answer xmlns:d4p1="http://schemas.datacontract.org/2004/07/TTCMiddleTier.DistrictManagement">
<d4p1:AnswerText>sample string 4</d4p1:AnswerText>
<d4p1:ID>sample string 1</d4p1:ID>
<d4p1:QuestionAnswerOptionID>5</d4p1:QuestionAnswerOptionID>
<d4p1:QuestionID>3</d4p1:QuestionID>
<d4p1:SurveyResponseID>2</d4p1:SurveyResponseID>
</Answer>
<AnswerOptions xmlns:d4p1="http://schemas.datacontract.org/2004/07/TTCM.BusinessLayer.Services">
<d4p1:GenericValue />
<d4p1:GenericValue />
</AnswerOptions>
<IsRequired>true</IsRequired>
<OrderBy>5</OrderBy>
<PhysicalTypeID>sample string 4</PhysicalTypeID>
<QuestionID>sample string 1</QuestionID>
<QuestionTypeID>sample string 3</QuestionTypeID>
<Text>sample string 2</Text>
</SurveyQuestionOutput>
<SurveyQuestionOutput>
<Answer xmlns:d4p1="http://schemas.datacontract.org/2004/07/TTCMiddleTier.DistrictManagement">
<d4p1:AnswerText>sample string 4</d4p1:AnswerText>
<d4p1:ID>sample string 1</d4p1:ID>
<d4p1:QuestionAnswerOptionID>5</d4p1:QuestionAnswerOptionID>
<d4p1:QuestionID>3</d4p1:QuestionID>
<d4p1:SurveyResponseID>2</d4p1:SurveyResponseID>
</Answer>
<AnswerOptions xmlns:d4p1="http://schemas.datacontract.org/2004/07/TTCM.BusinessLayer.Services">
<d4p1:GenericValue />
<d4p1:GenericValue />
</AnswerOptions>
<IsRequired>true</IsRequired>
<OrderBy>5</OrderBy>
<PhysicalTypeID>sample string 4</PhysicalTypeID>
<QuestionID>sample string 1</QuestionID>
<QuestionTypeID>sample string 3</QuestionTypeID>
<Text>sample string 2</Text>
</SurveyQuestionOutput>
</QuestionsList>
<Success>true</Success>
<SurveyRequestID>5</SurveyRequestID>
<SurveyResponseID>4</SurveyResponseID>
<isPossibleFishing>true</isPossibleFishing>
</ReferenceSurveyOutput>