PATCH v1/Interviewers/{interviewerId}

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

Permissions required to make this request: Interviewer.Write Interviewer.Read

Update an interviewer with the specified specified fields

Request Information

URI Parameters

Name	Description	Type	Additional information
interviewerId	The id of the interviewer that is updated.	string	Required

Body Parameters

Supply Interviewer object with only the properties and values you would like to update. Some properties might not be allowed. At least allowed: FirstName, LastName, EmailAddress, TelephoneNumber, IsSupervisor

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.

Request Formats

application/json, text/json

Sample:

{
  "EmailAddress": "mynewaddress@gmail.com",
  "TelephoneNumber": "0612345678",
  "FirstName": "FirstName",
  "LastName": "LastName",
  "IsSupervisor": true
}

application/xml, text/xml

Sample:

<Interviewer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <EmailAddress>mynewaddress@gmail.com</EmailAddress>
  <TelephoneNumber>0612345678</TelephoneNumber>
  <FirstName>FirstName</FirstName>
  <LastName>LastName</LastName>
  <IsSupervisor>true</IsSupervisor>
</Interviewer>

application/x-www-form-urlencoded

Sample:

No sample available

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

The updated details of the interviewer

Response Message

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.