DELETE v1/Surveys/{surveyId}/SamplingPointsAssignments

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

Permissions required to make this request: SamplingPointInterviewerAssignment.Delete SamplingPointInterviewerAssignment.Read SamplingPoint.Read Survey.Read Interviewer.Read

Has survey type usage restrictions capi

Unassign many interviewers from many sampling points.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

The survey id that the sampling point belongs to

string

Required

Body Parameters

The id's of the sampling points and the interviewers to unassign

SamplingPointInterviewerAssignmentsModel
NameDescriptionTypeAdditional information
SamplingPointIds

The id's of the sampling points having the interviewers assigned

Collection of string

None.

InterviewerIds

The id's of the interviewers to assign to the sampling points

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "SamplingPointIds": [
    "sample string 1",
    "sample string 2"
  ],
  "InterviewerIds": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<SamplingPointInterviewerAssignmentsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <InterviewerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </InterviewerIds>
  <SamplingPointIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SamplingPointIds>
</SamplingPointInterviewerAssignmentsModel>

application/x-www-form-urlencoded

Sample:
SamplingPointIds=[]&InterviewerIds=[]

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Message indicating the status of the request

Response Message

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.