GET api/v{version}/survey?surveyId={surveyId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
surveyId | string |
Required |
|
version |
The requested API version |
string |
Required Default value is 1.0 |
Body Parameters
None.
Response Information
Resource Description
Collection of SurveyQuestionName | Description | Type | Additional information |
---|---|---|---|
type | string |
None. |
|
name | string |
None. |
|
id | string |
None. |
|
internalName | string |
None. |
|
defaultValue | string |
None. |
|
choices | Collection of Choice |
None. |
|
gridChoices | Collection of string |
None. |
|
min | integer |
None. |
|
max | integer |
None. |
|
required | boolean |
None. |
|
choicesFormat | string |
None. |
|
gridTxtRng1 | string |
None. |
|
gridTxtRng2 | string |
None. |
|
gridTxtRng3 | string |
None. |
|
dependants | Dictionary of string [key] and string [value] |
None. |
|
maxLength | string |
None. |
|
triggeredQuestionName | string |
None. |
|
triggeredAnswerValues | Collection of string |
None. |
|
isDependent | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ { "type": "sample string 1", "name": "sample string 2", "id": "sample string 3", "internalName": "sample string 4", "defaultValue": "sample string 5", "choices": [ { "value": "sample string 1", "label": "sample string 2" }, { "value": "sample string 1", "label": "sample string 2" } ], "gridChoices": [ "sample string 1", "sample string 2" ], "min": 1, "max": 1, "required": true, "choicesFormat": "sample string 7", "gridTxtRng1": "sample string 8", "gridTxtRng2": "sample string 9", "gridTxtRng3": "sample string 10", "dependants": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "maxLength": "sample string 11", "triggeredQuestionName": "sample string 12", "triggeredAnswerValues": [ "sample string 1", "sample string 2" ], "isDependent": true }, { "type": "sample string 1", "name": "sample string 2", "id": "sample string 3", "internalName": "sample string 4", "defaultValue": "sample string 5", "choices": [ { "value": "sample string 1", "label": "sample string 2" }, { "value": "sample string 1", "label": "sample string 2" } ], "gridChoices": [ "sample string 1", "sample string 2" ], "min": 1, "max": 1, "required": true, "choicesFormat": "sample string 7", "gridTxtRng1": "sample string 8", "gridTxtRng2": "sample string 9", "gridTxtRng3": "sample string 10", "dependants": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "maxLength": "sample string 11", "triggeredQuestionName": "sample string 12", "triggeredAnswerValues": [ "sample string 1", "sample string 2" ], "isDependent": true } ]
text/javascript
Sample:
[{"type":"sample string 1","name":"sample string 2","id":"sample string 3","internalName":"sample string 4","defaultValue":"sample string 5","choices":[{"value":"sample string 1","label":"sample string 2"},{"value":"sample string 1","label":"sample string 2"}],"gridChoices":["sample string 1","sample string 2"],"min":1,"max":1,"required":true,"choicesFormat":"sample string 7","gridTxtRng1":"sample string 8","gridTxtRng2":"sample string 9","gridTxtRng3":"sample string 10","dependants":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"maxLength":"sample string 11","triggeredQuestionName":"sample string 12","triggeredAnswerValues":["sample string 1","sample string 2"],"isDependent":true},{"type":"sample string 1","name":"sample string 2","id":"sample string 3","internalName":"sample string 4","defaultValue":"sample string 5","choices":[{"value":"sample string 1","label":"sample string 2"},{"value":"sample string 1","label":"sample string 2"}],"gridChoices":["sample string 1","sample string 2"],"min":1,"max":1,"required":true,"choicesFormat":"sample string 7","gridTxtRng1":"sample string 8","gridTxtRng2":"sample string 9","gridTxtRng3":"sample string 10","dependants":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"maxLength":"sample string 11","triggeredQuestionName":"sample string 12","triggeredAnswerValues":["sample string 1","sample string 2"],"isDependent":true}]
application/xml, text/xml
Sample:
<ArrayOfSurveyQuestion xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UNITE.External.API.Support.Survey"> <SurveyQuestion> <choices> <Choice> <label>sample string 2</label> <value>sample string 1</value> </Choice> <Choice> <label>sample string 2</label> <value>sample string 1</value> </Choice> </choices> <choicesFormat>sample string 7</choicesFormat> <defaultValue>sample string 5</defaultValue> <dependants xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value>sample string 4</d3p1:Value> </d3p1:KeyValueOfstringstring> </dependants> <gridChoices xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </gridChoices> <gridTxtRng1>sample string 8</gridTxtRng1> <gridTxtRng2>sample string 9</gridTxtRng2> <gridTxtRng3>sample string 10</gridTxtRng3> <id>sample string 3</id> <internalName>sample string 4</internalName> <isDependent>true</isDependent> <max>1</max> <maxLength>sample string 11</maxLength> <min>1</min> <name>sample string 2</name> <required>true</required> <triggeredAnswerValues xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </triggeredAnswerValues> <triggeredQuestionName>sample string 12</triggeredQuestionName> <type>sample string 1</type> </SurveyQuestion> <SurveyQuestion> <choices> <Choice> <label>sample string 2</label> <value>sample string 1</value> </Choice> <Choice> <label>sample string 2</label> <value>sample string 1</value> </Choice> </choices> <choicesFormat>sample string 7</choicesFormat> <defaultValue>sample string 5</defaultValue> <dependants xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value>sample string 4</d3p1:Value> </d3p1:KeyValueOfstringstring> </dependants> <gridChoices xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </gridChoices> <gridTxtRng1>sample string 8</gridTxtRng1> <gridTxtRng2>sample string 9</gridTxtRng2> <gridTxtRng3>sample string 10</gridTxtRng3> <id>sample string 3</id> <internalName>sample string 4</internalName> <isDependent>true</isDependent> <max>1</max> <maxLength>sample string 11</maxLength> <min>1</min> <name>sample string 2</name> <required>true</required> <triggeredAnswerValues xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </triggeredAnswerValues> <triggeredQuestionName>sample string 12</triggeredQuestionName> <type>sample string 1</type> </SurveyQuestion> </ArrayOfSurveyQuestion>