PUT v1/Surveys/{surveyId}/Interviewers/{interviewerId}/Assignments
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
This method creates an interviewer assignment
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
surveyId |
The id of the survey |
string |
Required |
interviewerId |
The id of the interviewer |
string |
Required |
Body Parameters
Assignment parameters
SurveyInterviewerAssignmentRequestModelName | Description | Type | Additional information |
---|---|---|---|
Description |
Assignment description. It's Shown in sampling point page in CAPI device |
string |
None. |
TargetToDistribute |
Target depends on AssignmentType (Only available for WorkPackageAssignment) |
integer |
None. |
AssignmentType |
Assignment type |
string |
None. |
SamplingPointsFilter |
Sampling Point Filter(Only available for SamplingPointAssignment) |
Collection of FilterWithOr |
None. |
Request Formats
application/json, text/json
{ "Description": "sample string 1", "TargetToDistribute": 1, "AssignmentType": "sample string 2", "SamplingPointsFilter": [ { "Or": [ { "Name": "sample string 1", "Op": "sample string 2", "Value": "sample string 3" }, { "Name": "sample string 1", "Op": "sample string 2", "Value": "sample string 3" } ], "Name": "sample string 1", "Op": "sample string 2", "Value": "sample string 3" }, { "Or": [ { "Name": "sample string 1", "Op": "sample string 2", "Value": "sample string 3" }, { "Name": "sample string 1", "Op": "sample string 2", "Value": "sample string 3" } ], "Name": "sample string 1", "Op": "sample string 2", "Value": "sample string 3" } ] }
application/xml, text/xml
<SurveyInterviewerAssignmentRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.SurveyInterviewerAssignment"> <AssignmentType>sample string 2</AssignmentType> <Description>sample string 1</Description> <SamplingPointsFilter xmlns:d2p1="http://schemas.datacontract.org/2004/07/Nfield.Capi.Interviewers.Models"> <d2p1:FilterWithOr> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:Op>sample string 2</d2p1:Op> <d2p1:Value>sample string 3</d2p1:Value> <d2p1:Or> <d2p1:Filter> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:Op>sample string 2</d2p1:Op> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:Filter> <d2p1:Filter> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:Op>sample string 2</d2p1:Op> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:Filter> </d2p1:Or> </d2p1:FilterWithOr> <d2p1:FilterWithOr> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:Op>sample string 2</d2p1:Op> <d2p1:Value>sample string 3</d2p1:Value> <d2p1:Or> <d2p1:Filter> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:Op>sample string 2</d2p1:Op> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:Filter> <d2p1:Filter> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:Op>sample string 2</d2p1:Op> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:Filter> </d2p1:Or> </d2p1:FilterWithOr> </SamplingPointsFilter> <TargetToDistribute>1</TargetToDistribute> </SurveyInterviewerAssignmentRequestModel>
application/x-www-form-urlencoded
Description=sample&TargetToDistribute=1&AssignmentType=sample&SamplingPointsFilter=IEnumerable`1
multipart/form-data
Sample not available.
Response Information
Resource Description
The assignments details list of the 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. |