GET v1/CapiInterviewers

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

Permissions required to make this request: Interviewer.Read

This method retrieve a list of interviewers. This list can be filtered and sorted using standard OData syntax.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A (filtered) list of interviewers

Response Message

Collection of Interviewer

Name	Description	Type	Additional information
InterviewerId	The unique id of the user	string	None.
UserName	The interviewer's username	string	Max length: 50
FirstName	First name of the interviewer	string	Max length: 50
LastName	Last name of the interviewer	string	Max length: 50
EmailAddress	Email Address of the interviewer	string	Max length: 50
TelephoneNumber	TelephoneNumber of the interviewer	string	Max length: 30
LastPasswordChangeTime	Time the password was last changed	date	None.
ClientInterviewerId	The InterviewerId as it is used on the client (and stored in data)	string	String length: inclusive between 0 and 8
SuccessfulCount	Number of successfully completed interviews for this interviewer	integer	None.
UnsuccessfulCount	Number of unsuccessfully completed interviews for this interviewer	integer	None.
DroppedOutCount	Number of dropped out interviews for this interviewer	integer	None.
RejectedCount	Number of rejected interviews for this interviewer	integer	None.
LastSyncDate	The date and time of the last sync	date	None.
IsFullSynced	interviewer full-sync status: true if fully synced, false if not fully synced	boolean	None.
IsLastSyncSuccessful	true if last sync was successful, false if not	boolean	None.
IsSupervisor	Property indicating weather the interviewer is a supervisor or not. Supervisors have special powers e.g. they can enter and modify the device ID in the CAPI client application in the Settings page.	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",
    "EmailAddress": "sample string 5",
    "TelephoneNumber": "sample string 6",
    "LastPasswordChangeTime": "2024-09-07T01:28:26.3625095+00:00",
    "ClientInterviewerId": "sample string 7",
    "SuccessfulCount": 8,
    "UnsuccessfulCount": 9,
    "DroppedOutCount": 10,
    "RejectedCount": 11,
    "LastSyncDate": "2024-09-07T01:28:26.3625095+00:00",
    "IsFullSynced": true,
    "IsLastSyncSuccessful": true,
    "IsSupervisor": true
  },
  {
    "InterviewerId": "sample string 1",
    "UserName": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "EmailAddress": "sample string 5",
    "TelephoneNumber": "sample string 6",
    "LastPasswordChangeTime": "2024-09-07T01:28:26.3625095+00:00",
    "ClientInterviewerId": "sample string 7",
    "SuccessfulCount": 8,
    "UnsuccessfulCount": 9,
    "DroppedOutCount": 10,
    "RejectedCount": 11,
    "LastSyncDate": "2024-09-07T01:28:26.3625095+00:00",
    "IsFullSynced": true,
    "IsLastSyncSuccessful": true,
    "IsSupervisor": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfInterviewer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Interviewer>
    <ClientInterviewerId>sample string 7</ClientInterviewerId>
    <DroppedOutCount>10</DroppedOutCount>
    <EmailAddress>sample string 5</EmailAddress>
    <FirstName>sample string 3</FirstName>
    <InterviewerId>sample string 1</InterviewerId>
    <IsFullSynced>true</IsFullSynced>
    <IsLastSyncSuccessful>true</IsLastSyncSuccessful>
    <IsSupervisor>true</IsSupervisor>
    <LastName>sample string 4</LastName>
    <LastPasswordChangeTime>2024-09-07T01:28:26.3625095+00:00</LastPasswordChangeTime>
    <LastSyncDate>2024-09-07T01:28:26.3625095+00:00</LastSyncDate>
    <RejectedCount>11</RejectedCount>
    <SuccessfulCount>8</SuccessfulCount>
    <TelephoneNumber>sample string 6</TelephoneNumber>
    <UnsuccessfulCount>9</UnsuccessfulCount>
    <UserName>sample string 2</UserName>
  </Interviewer>
  <Interviewer>
    <ClientInterviewerId>sample string 7</ClientInterviewerId>
    <DroppedOutCount>10</DroppedOutCount>
    <EmailAddress>sample string 5</EmailAddress>
    <FirstName>sample string 3</FirstName>
    <InterviewerId>sample string 1</InterviewerId>
    <IsFullSynced>true</IsFullSynced>
    <IsLastSyncSuccessful>true</IsLastSyncSuccessful>
    <IsSupervisor>true</IsSupervisor>
    <LastName>sample string 4</LastName>
    <LastPasswordChangeTime>2024-09-07T01:28:26.3625095+00:00</LastPasswordChangeTime>
    <LastSyncDate>2024-09-07T01:28:26.3625095+00:00</LastSyncDate>
    <RejectedCount>11</RejectedCount>
    <SuccessfulCount>8</SuccessfulCount>
    <TelephoneNumber>sample string 6</TelephoneNumber>
    <UnsuccessfulCount>9</UnsuccessfulCount>
    <UserName>sample string 2</UserName>
  </Interviewer>
</ArrayOfInterviewer>