PUT v1/Surveys/{surveyId}/Assignment

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

Permissions required to make this request: SurveyInterviewerAssignment.Write SurveyInterviewerAssignment.Read Interviewer.Read Survey.Read SurveyQuotaFrame.Read SurveyInterviewSetting.Read

Assigns/Unassigns the interviewer to the survey.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

The survey ID.

string

Required

Body Parameters

The model that contains the interviewer ID and assignment value.

SurveyInterviewerAssignmentChangeModel
NameDescriptionTypeAdditional information
InterviewerId

Gets/sets the interviewer ID.

string

Required

Assign

Gets/sets whether to assign/unassign interviewer to a survey.

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "InterviewerId": "sample string 1",
  "Assign": true
}

application/xml, text/xml

Sample:
<SurveyInterviewerAssignmentChangeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Assign>true</Assign>
  <InterviewerId>sample string 1</InterviewerId>
</SurveyInterviewerAssignmentChangeModel>

application/x-www-form-urlencoded

Sample:
InterviewerId=sample&Assign=true

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Message indicating the status of the request

Response Message

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.