GET v1/Surveys/{surveyId}/VarFile

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser Scripter LimitedUser OperationsUser

Permissions required to make this request: SurveyVarFile.Read

This method retrieves the varfile of a specific survey.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

The id of the survey

 string

Required

Body Parameters

None.

Response Information

Resource Description

Model containing the varfile

Response Message

SurveyVarFileModel
NameDescriptionTypeAdditional 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>