POST v1/Interviewers

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

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

This method creates a new interviewer.

Request Information

URI Parameters

None.

Body Parameters

An object describing the details for the new interviewer

InterviewerModel

Name	Description	Type	Additional information
UserName	The interviewer's username This username is used to sign in to the Nfield CAPI client	string	Required 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	Telephone number of the interviewer	string	Max length: 30
Password	The password for the interviewer	string	Required
ClientInterviewerId	The unique identifier for the interviewer to be used on the Nfield CAPI client. This id is also stored as part of the interview results.	string	Max length: 8 Min length: 8
IsSupervisor	Property indicating weather the interviewer is a supervisor or not.	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

If sucessful, this method returns the newly created 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.