GET v1/Surveys/{surveyId}/Interviewers

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

Permissions required to make this request: SurveyInterviewerAssignment.Read Interviewer.Read Survey.Read SurveyQuotaFrame.Read SurveyInterviewSetting.Read

Has survey type usage restrictions capi

Retrieves list of interviewers for the survey.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The survey ID.	string	Required

Body Parameters

None.

Response Information

Resource Description

Response Message

Collection of SurveyInterviewerAssignmentModel

Name	Description	Type	Additional information
InterviewerId	InterviewerId	string	None.
IsAssigned	Whether the interviewer is assigned to the survey	boolean	None.
IsActive	Whether the interviewer has downloaded the survey	boolean	None.
SuccessfulCount	Number of successfully completed interviews for this interviewer on this survey	integer	None.
UnsuccessfulCount	Number of unsuccessfully completed interviews for this interviewer on this survey	integer	None.
DroppedOutCount	Number of dropped out interviews for this interviewer on this survey	integer	None.
RejectedCount	Number of rejected interviews for this interviewer on this survey	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "InterviewerId": "sample string 1",
    "IsAssigned": true,
    "IsActive": true,
    "SuccessfulCount": 4,
    "UnsuccessfulCount": 5,
    "DroppedOutCount": 6,
    "RejectedCount": 7
  },
  {
    "InterviewerId": "sample string 1",
    "IsAssigned": true,
    "IsActive": true,
    "SuccessfulCount": 4,
    "UnsuccessfulCount": 5,
    "DroppedOutCount": 6,
    "RejectedCount": 7
  }
]

application/xml, text/xml

Sample:

<ArrayOfSurveyInterviewerAssignmentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <SurveyInterviewerAssignmentModel>
    <DroppedOutCount>6</DroppedOutCount>
    <InterviewerId>sample string 1</InterviewerId>
    <IsActive>true</IsActive>
    <IsAssigned>true</IsAssigned>
    <RejectedCount>7</RejectedCount>
    <SuccessfulCount>4</SuccessfulCount>
    <UnsuccessfulCount>5</UnsuccessfulCount>
  </SurveyInterviewerAssignmentModel>
  <SurveyInterviewerAssignmentModel>
    <DroppedOutCount>6</DroppedOutCount>
    <InterviewerId>sample string 1</InterviewerId>
    <IsActive>true</IsActive>
    <IsAssigned>true</IsAssigned>
    <RejectedCount>7</RejectedCount>
    <SuccessfulCount>4</SuccessfulCount>
    <UnsuccessfulCount>5</UnsuccessfulCount>
  </SurveyInterviewerAssignmentModel>
</ArrayOfSurveyInterviewerAssignmentModel>