DELETE v1/Surveys/{surveyId}/Interviews/{interviewId}

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

Permissions required to make this request: InterviewData.Delete SampleRecord.Read Survey.Read

Delete all data for a specified interview of a specified survey.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

[MANDATORY] The survey's ID

 string

Required
interviewId

[MANDATORY] The interview's ID

 integer

Required

Body Parameters

None.

Response Information

Resource Description

The id of the background activity you can use to get the results.

Response Message

BackgroundActivityStatus
NameDescriptionTypeAdditional information
ActivityId

The id of the started activity

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ActivityId": "sample string 1"
}

application/xml, text/xml

Sample: 
<BackgroundActivityStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <ActivityId>sample string 1</ActivityId>
</BackgroundActivityStatus>