PATCH v1/CapiInterviewers/{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: FirstName, LastName, EmailAddress, TelephoneNumber, IsSupervisor

EditCapiInterviewerRequestModel

Name	Description	Type	Additional information
FirstName	First name of the interviewer	string	None.
LastName	Last name of the interviewer	string	None.
EmailAddress	Email Address of the interviewer	string	None.
TelephoneNumber	TelephoneNumber of the interviewer	string	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:

{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "EmailAddress": "sample string 3",
  "TelephoneNumber": "sample string 4",
  "IsSupervisor": true
}

application/xml, text/xml

Sample:

<EditCapiInterviewerRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.CapiInterviewers">
  <EmailAddress>sample string 3</EmailAddress>
  <FirstName>sample string 1</FirstName>
  <IsSupervisor>true</IsSupervisor>
  <LastName>sample string 2</LastName>
  <TelephoneNumber>sample string 4</TelephoneNumber>
</EditCapiInterviewerRequestModel>

application/x-www-form-urlencoded

Sample:

FirstName=sample&LastName=sample&EmailAddress=sample&TelephoneNumber=sample&IsSupervisor=true

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.