GET v1/Surveys/{surveyId}/SamplingPoints/{samplingPointId}/Assignments

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

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

Has survey type usage restrictions capi

Get the interviewers assigned 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 sampling point to get assignments for	string	Required

Body Parameters

None.

Response Information

Resource Description

A list of interviewers that are assigned to the sampling point

Response Message

Collection of InterviewerSamplingPointAssignmentModel

Name	Description	Type	Additional information
InterviewerId	ID of the Interviewer	string	None.
UserName	UserName of the Interviewer	string	None.
FirstName	First name of the interviewer	string	None.
LastName	Last name of the interviewer	string	None.
Assigned	Whether this interviewer is assigned or not	boolean	None.
Active	Whether this interviewer is active	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "InterviewerId": "sample string 1",
    "UserName": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "Assigned": true,
    "Active": true
  },
  {
    "InterviewerId": "sample string 1",
    "UserName": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "Assigned": true,
    "Active": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfInterviewerSamplingPointAssignmentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <InterviewerSamplingPointAssignmentModel>
    <Active>true</Active>
    <Assigned>true</Assigned>
    <FirstName>sample string 3</FirstName>
    <InterviewerId>sample string 1</InterviewerId>
    <LastName>sample string 4</LastName>
    <UserName>sample string 2</UserName>
  </InterviewerSamplingPointAssignmentModel>
  <InterviewerSamplingPointAssignmentModel>
    <Active>true</Active>
    <Assigned>true</Assigned>
    <FirstName>sample string 3</FirstName>
    <InterviewerId>sample string 1</InterviewerId>
    <LastName>sample string 4</LastName>
    <UserName>sample string 2</UserName>
  </InterviewerSamplingPointAssignmentModel>
</ArrayOfInterviewerSamplingPointAssignmentModel>