Paths
Get assigned interviewers for a survey
GET /surveys/{surveyId}/interviewers
Description
Returns a list of assigned interviewers for a survey Sample request:
GET /surveys/p123456789/interviewers
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
surveyId |
Survey Id |
string |
|
Query |
skip |
Use this when paging through the interviewers |
integer (int32) |
|
Query |
take |
Number to interviewers per page |
integer (int32) |
|
Assign interviewers to a survey
PUT /surveys/{surveyId}/interviewers
Description
Sample request:
PUT /surveys/p123456789/interviewers
{
"dataSchema": {
"key": "userid"
},
"data":[
{"userid": 1},
{"userid": 2},
{"userid": 3},
]
}
PUT /surveys/p123456789/interviewers
{
"dataSchema": {
"key": "username"
},
"data":[
{"username": "interviewer1"},
{"username": "interviewer2"},
{"username": "interviewer3"},
]
}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
surveyId |
Survey Id |
string |
Body |
body |
Object containing interviewer ids |
Unassign interviewers to a survey
DELETE /surveys/{surveyId}/interviewers
Description
Sample request:
DELETE /surveys/p123456789/interviewers
{
"dataSchema": {
"key": "userid"
},
"data":[
{"userid": 1},
{"userid": 2},
{"userid": 3},
]
}
DELETE /surveys/p123456789/interviewers
{
"dataSchema": {
"key": "username"
},
"data":[
{"username": "interviewer1"},
{"username": "interviewer2"},
{"username": "interviewer3"},
]
}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
surveyId |
Survey Id |
string |
Body |
body |
Object containing interviewer ids |
Assign respondents to an interviewer
PUT /surveys/{surveyId}/interviewers/{interviewerId}/respondents
Description
Sample request:
PUT /surveys/p123456789/interviewers/12345/respondents
{
"respIds":[
1,
2,
3
]
}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
interviewerId |
Interviewer Id |
integer (int32) |
Path |
surveyId |
Survey Id |
string |
Body |
body |
Object containing respondent ids |
Unassign respondents to an interviewer
DELETE /surveys/{surveyId}/interviewers/{interviewerId}/respondents
Description
Sample request:
DELETE /surveys/p123456789/interviewers/12345/respondents
{
"respIds":[
1,
2,
3
]
}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
interviewerId |
Interviewer Id |
integer (int32) |
Path |
surveyId |
Survey Id |
string |
Body |
body |
Object containing respondent ids |