POST v1/Surveys/{surveyId}/SamplingPoints/{samplingPointId}/Assignments/{interviewerId}
User roles allowed to make this request:
DomainAdministrator
PowerUser
RegularUser
LimitedUser
Permissions required to make this request:
SamplingPointInterviewerAssignment.Write
SamplingPointInterviewerAssignment.Read
SamplingPoint.Read
Survey.Read
Interviewer.Read
Has survey type usage restrictions capi
Assign an interviewer to a sampling point.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
surveyId |
The survey id that the sampling point belongs to |
string |
Required |
samplingPointId |
The id of the sampling point to assign |
string |
Required |
interviewerId |
The id of the interviewer to assign |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Response Message
SamplingPointInterviewerAssignmentsModelName | Description | Type | Additional 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. |
Response Formats
application/json, text/json
{ "SamplingPointIds": [ "sample string 1", "sample string 2" ], "InterviewerIds": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
<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>