POST v1/Surveys/{surveyId}/DataDownload/{interviewId}
User roles allowed to make this request:
DomainAdministrator
PowerUser
RegularUser
LimitedUser
OperationsUser
DemoUser
Permissions required to make this request:
SurveyData.Read
Survey.Read
Supports survey simulations
Post a request for a data download of one interview.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
surveyId |
The survey for which the download is requested |
string |
Required |
interviewId |
The interview for which the download is requested |
integer |
Required |
Body Parameters
The information that the download should contain
SurveyDataInterviewRequestModelName | Description | Type | Additional information |
---|---|---|---|
FileName |
Optional. Name of the file. The default is the surveyName_interviewId |
string |
None. |
Request Formats
application/json, text/json
{ "FileName": "sample string 1" }
application/xml, text/xml
<SurveyDataInterviewRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.SurveyData"> <FileName>sample string 1</FileName> </SurveyDataInterviewRequestModel>
application/x-www-form-urlencoded
FileName=sample
multipart/form-data
Sample not available.
Response Information
Resource Description
ActivityId of the download request
Response Message
HttpResponseMessageName | 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. |