Paths

GET /

Responses

HTTP Code Description Schema

200

OK

RootResponse

401

Unauthorized

No Content

Produces

  • application/json

Tags

  • Root

Example HTTP response

Response 200

{
  "id" : "Confirmit.Public.Capi.Api",
  "links" : {
    "self" : "/",
    "interviewers" : "/interviewers",
    "spec" : "/swagger"
  }
}

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
required

Survey Id

string

Query

skip
optional

Use this when paging through the interviewers

integer (int32)

0

Query

take
optional

Number to interviewers per page

integer (int32)

10

Responses

HTTP Code Description Schema

200

Ok, the request has succeeded. The list of assigned interviewers are returned.

ResourceCollection[Interviewer]

400

Bad request from various factors. Query parameters or not found project

No Content

401

Unauthorized

No Content

Produces

  • application/json

Tags

  • Interviewers

Example HTTP response

Response 200

{
  "itemType" : "Interviewer",
  "itemCount" : 1,
  "totalCount" : 1,
  "items" : [ {
    "username" : "interviewer1",
    "userId" : 1,
    "links" : { }
  } ],
  "links" : { }
}

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
required

Survey Id

string

Body

body
optional

Object containing interviewer ids

InterviewAssignmentBatch

Responses

HTTP Code Description Schema

200

Ok, the request has succeeded. The interviewers are assigned to survey

No Content

400

Bad request, data schema key value pair is incorrect or not found project

No Content

401

Unauthorized

No Content

Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

Tags

  • Interviewers

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
required

Survey Id

string

Body

body
optional

Object containing interviewer ids

InterviewAssignmentBatch

Responses

HTTP Code Description Schema

200

Ok, the request has succeeded. The interviewers are unassigned from survey.

No Content

400

Bad request, data schema key value pair is incorrect or not found project

No Content

401

Unauthorized

No Content

Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

Tags

  • Interviewers

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
required

Interviewer Id

integer (int32)

Path

surveyId
required

Survey Id

string

Body

body
optional

Object containing respondent ids

RespondentsAssignmentBatch

Responses

HTTP Code Description Schema

200

Respondent ids are added for capi interviewer

No Content

400

Bad request, respondent id exceeded 500 limit, the project, end user list or capi interviewer is not found.

No Content

401

Unauthorized

No Content

Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

Tags

  • Interviewers

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
required

Interviewer Id

integer (int32)

Path

surveyId
required

Survey Id

string

Body

body
optional

Object containing respondent ids

RespondentsAssignmentBatch

Responses

HTTP Code Description Schema

200

Respondent ids are removed for capi interviewer

No Content

400

Bad request, respondent id exceeded 500 limit, the project, end user list or capi interviewer is not found.

No Content

401

Unauthorized

No Content

Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

Tags

  • Interviewers