Interviews

class InterviewsApi(client, workspace=None)

Set of functions to access and manipulate Interviews.

get_list(fields=[], order=None, skip=0, take=None, where=None, include_calendar_events=False, **kwargs)

Get list of interviews

Parameters
  • fields (list) – list of fields to return, of ommited, all fields wll be returned

  • order – list of fields to sort the results by

  • skip (int) – number of interviews to skip

  • take (Optional[int]) – number of interviews to return

  • questionnaire_id – filter by specific questionnaire id

  • questionnaire_variable – filter by questionnaire variable instead

  • questionnaire_version – filter by specific version number

Include_calendar_events

return calendar_event object as part of the fields

Returns

list of Interview objects

get_info(interview_id)
delete(interviewid, comment=None)
get_calendar_event(interview_key)

Get calendar event associated with the interview

set_calendar_event(interview_key, new_start, start_timezone, comment=None)

Add new calendar event to the interview, or update the existing one

Parameters
  • interview_key (str) – key of the interview to update

  • new_start (str) – start date of the calendar event

  • start_timezone (str) – timezone string for the start date

  • comment (Optional[str]) – add comment to the calendar event

Returns

:class:`CalendarEvent’ object

delete_calendar_event(interview_key)

Remove calendar event associated with the interview

approve(interviewid, comment='')
assign(interviewid, responsibleid, responsiblename='')
assign_supervisor(interviewid, responsibleid, responsiblename='')
comment(interview_id, comment, question_id=None, variable=None, roster_vector=[])
history(interview_id)
hqapprove(interviewid, comment='')
hqreject(interviewid, comment='')
hqunapprove(interviewid, comment='')
reject(interviewid, comment='')