POST v1/CapiInterviewers

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

NewCapiInterviewerRequestModel

Name	Description	Type	Additional information
UserName	The interviewer's username	string	None.
Password	The initial password for the interviewer.	string	None.
ClientInterviewerId	The InterviewerId as it is used on the client (and stored in data)	string	None.
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:

{
  "UserName": "sample string 1",
  "Password": "sample string 2",
  "ClientInterviewerId": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "EmailAddress": "sample string 6",
  "TelephoneNumber": "sample string 7",
  "IsSupervisor": true
}

application/xml, text/xml

Sample:

<NewCapiInterviewerRequestModel 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 6</EmailAddress>
  <FirstName>sample string 4</FirstName>
  <IsSupervisor>true</IsSupervisor>
  <LastName>sample string 5</LastName>
  <TelephoneNumber>sample string 7</TelephoneNumber>
  <ClientInterviewerId>sample string 3</ClientInterviewerId>
  <Password>sample string 2</Password>
  <UserName>sample string 1</UserName>
</NewCapiInterviewerRequestModel>

application/x-www-form-urlencoded

Sample:

UserName=sample&Password=sample&ClientInterviewerId=sample&FirstName=sample&LastName=sample&EmailAddress=sample&TelephoneNumber=sample&IsSupervisor=true

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.