GET v1/Interviewers/{interviewerId}/Assignments

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

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

This method retrieves all assignments with counts for the interviewer. It is only allowed for CAPI surveys.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
interviewerId

The id of the interviewer

string

Required

Body Parameters

None.

Response Information

Resource Description

The assignments details list of the interviewer

Response Message

Collection of InterviewerAssignmentResponseModel
NameDescriptionTypeAdditional information
SurveyName

string

None.

SurveyId

string

None.

Interviewer

string

None.

InterviewerId

string

None.

Discriminator

string

None.

Assigned

boolean

None.

Active

boolean

None.

IsGroupAssignment

boolean

None.

AssignedTarget

integer

None.

AssignedSamplingPointTarget

integer

None.

Successful

integer

None.

ScreenedOut

integer

None.

DroppedOut

integer

None.

Rejected

integer

None.

LastSyncDate

date

None.

IsFullSynced

boolean

None.

IsLastSyncSuccessful

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "SurveyName": "sample string 1",
    "SurveyId": "sample string 2",
    "Interviewer": "sample string 3",
    "InterviewerId": "sample string 4",
    "Discriminator": "sample string 5",
    "Assigned": true,
    "Active": true,
    "IsGroupAssignment": true,
    "AssignedTarget": 1,
    "AssignedSamplingPointTarget": 1,
    "Successful": 6,
    "ScreenedOut": 7,
    "DroppedOut": 8,
    "Rejected": 9,
    "LastSyncDate": "2024-05-23T10:15:39.2730334+00:00",
    "IsFullSynced": true,
    "IsLastSyncSuccessful": true
  },
  {
    "SurveyName": "sample string 1",
    "SurveyId": "sample string 2",
    "Interviewer": "sample string 3",
    "InterviewerId": "sample string 4",
    "Discriminator": "sample string 5",
    "Assigned": true,
    "Active": true,
    "IsGroupAssignment": true,
    "AssignedTarget": 1,
    "AssignedSamplingPointTarget": 1,
    "Successful": 6,
    "ScreenedOut": 7,
    "DroppedOut": 8,
    "Rejected": 9,
    "LastSyncDate": "2024-05-23T10:15:39.2730334+00:00",
    "IsFullSynced": true,
    "IsLastSyncSuccessful": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfInterviewerAssignmentResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.InterviewerAssignments">
  <InterviewerAssignmentResponseModel>
    <Active>true</Active>
    <Assigned>true</Assigned>
    <AssignedSamplingPointTarget>1</AssignedSamplingPointTarget>
    <AssignedTarget>1</AssignedTarget>
    <Discriminator>sample string 5</Discriminator>
    <DroppedOut>8</DroppedOut>
    <Interviewer>sample string 3</Interviewer>
    <InterviewerId>sample string 4</InterviewerId>
    <IsFullSynced>true</IsFullSynced>
    <IsGroupAssignment>true</IsGroupAssignment>
    <IsLastSyncSuccessful>true</IsLastSyncSuccessful>
    <LastSyncDate>2024-05-23T10:15:39.2730334+00:00</LastSyncDate>
    <Rejected>9</Rejected>
    <ScreenedOut>7</ScreenedOut>
    <Successful>6</Successful>
    <SurveyId>sample string 2</SurveyId>
    <SurveyName>sample string 1</SurveyName>
  </InterviewerAssignmentResponseModel>
  <InterviewerAssignmentResponseModel>
    <Active>true</Active>
    <Assigned>true</Assigned>
    <AssignedSamplingPointTarget>1</AssignedSamplingPointTarget>
    <AssignedTarget>1</AssignedTarget>
    <Discriminator>sample string 5</Discriminator>
    <DroppedOut>8</DroppedOut>
    <Interviewer>sample string 3</Interviewer>
    <InterviewerId>sample string 4</InterviewerId>
    <IsFullSynced>true</IsFullSynced>
    <IsGroupAssignment>true</IsGroupAssignment>
    <IsLastSyncSuccessful>true</IsLastSyncSuccessful>
    <LastSyncDate>2024-05-23T10:15:39.2730334+00:00</LastSyncDate>
    <Rejected>9</Rejected>
    <ScreenedOut>7</ScreenedOut>
    <Successful>6</Successful>
    <SurveyId>sample string 2</SurveyId>
    <SurveyName>sample string 1</SurveyName>
  </InterviewerAssignmentResponseModel>
</ArrayOfInterviewerAssignmentResponseModel>