GET v1/Surveys/{surveyId}/VarFile/{eTag}
User roles allowed to make this request:
DomainAdministrator
PowerUser
RegularUser
Scripter
LimitedUser
OperationsUser
Permissions required to make this request:
SurveyVarFile.Read
Supports survey simulations
This method retrieves the specific version of the varfile for the specified survey.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
surveyId |
The id of the survey |
string |
Required |
eTag |
The version of the varfile to retrieve |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Model containing the varfile
Response Message
SurveyVarFileModelName | Description | Type | Additional information |
---|---|---|---|
FileContent |
The content |
string |
None. |
FileName |
The suggested file name |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "FileContent": "sample string 1", "FileName": "sample string 2" }
application/xml, text/xml
Sample:
<SurveyVarFileModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models"> <FileContent>sample string 1</FileContent> <FileName>sample string 2</FileName> </SurveyVarFileModel>