POST v1/CatiInterviewers
User roles allowed to make this request:
DomainAdministrator
PowerUser
RegularUser
Supervisor
Permissions required to make this request:
CatiInterviewer.Write
CatiInterviewer.Read
This method creates a new interviewer.
Request Information
URI Parameters
None.
Body Parameters
An object describing the details for the new interviewer
CatiInterviewerModelName | 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 |
Request Formats
application/json, text/json
{ "UserName": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "EmailAddress": "sample string 4", "TelephoneNumber": "sample string 5", "Password": "sample string 6" }
application/xml, text/xml
<CatiInterviewerModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models"> <EmailAddress>sample string 4</EmailAddress> <FirstName>sample string 2</FirstName> <LastName>sample string 3</LastName> <Password>sample string 6</Password> <TelephoneNumber>sample string 5</TelephoneNumber> <UserName>sample string 1</UserName> </CatiInterviewerModel>
application/x-www-form-urlencoded
UserName=sample&FirstName=sample&LastName=sample&EmailAddress=sample&TelephoneNumber=sample&Password=sample
multipart/form-data
Sample not available.
Response Information
Resource Description
If sucessful, this method returns the newly created interviewer
Response Message
HttpResponseMessageName | Description | 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. |