/api/surveys/PROJECT
This URL is used to start a new interview for the specified survey. A POST to this URL is required to supply the interview properties and sample management fields. The information is passed directly to the mrIEng::CreateInterviewWithAuthentication() method. The PROJECT specified in the URL is inserted into the InterviewProperties. The POST data is supported by the JSON, XML, and HTML formats, depending on the format query parameter.
JSON POST input
{
"InterviewParameters": {
"InterviewProperties": {
"property": [
{
"name": "IsTest",
"value": "True"
},
{
"name": "Language",
"value": "en-US"
}
]
},
"SampleFields": {
"SampleField": {
"name": "Id",
"value": "IT34DX6"
}
}
}
}
XML POST input
<InterviewParameters>
<InterviewProperties>
<property>
<name>IsTest</name>
<value><![CDATA[True]]></value>
</property>
<property>
<name>Language</name>
<value><![CDATA[en-US]]></value>
</property>
</InterviewProperties>
<SampleFields>
<SampleField>
<name>Id</name>
<value><![CDATA[IT34DX6]]></value>
</SampleField>
</SampleFields>
</InterviewParameters>
HTML POST input
I.IsTest=True&I.Language=en-US&Id=IT34DX6
The HTML
POST input is identical to the current
mrIWeb query parameters. When authentication is not required, or authentication was successful based on the supplied
SampleFields, the first page of the interview is returned in the appropriate format. This page includes a URL in the format that is described in
/api/interviews/ENGINE/PROJECT/authentication. When authentication is not successful, a page within the
SampleFields is returned and needs to be answered. The page includes a URL in the format described in
/api/surveys/PROJECT. It is possible to issue a
GET for this URL and receive the same response when no additional initial sample fields or interview properties, other than the
Project Name, are required.
See also