Interviews

Leave a comment on a question using questionnaire variable name and roster vector

post/api/v1/interviews/{id}/comment-by-variable/{variable}

Request

  • Base URL: https://demo.mysurvey.solutions (the document declares no server; this is the origin it was published from)
  • URL: https://demo.mysurvey.solutions/api/v1/interviews/{id}/comment-by-variable/{variable}
  • Auth: HTTP basic and HTTP bearer

Path parameters

idstring uuid required

Interview Id. This corresponds to the interview__id variable in data export files or the interview Id obtained through other API requests

variablestring required

Variable name. This is the variable name for a question in Designer or in an export file

Query parameters

rosterVectorinteger[]

Roster row. In simple rosters, the row code. In nested rosters, an array of row codes: first, the row code of the parent(s); followed by the row code of the target child roster (e.g., a question in a second-level roster needs 2 row codes, a question in a first-level roster only 1). For variables not in rosters, this parameter may be left blank

commentstring required

Comment. Comment to be posted to the chosen question

Response

Comment added.

Changes

No recorded changes to this operation across all 1 revision of this API.