comment_question: Leave a comment on a question

In arthur-shaw/susoapi: Interface for Survey Solutions' APIs

Leave a comment on a question

Description

Has server-side side-effect of posting a comment to a target question. To target a question, specify it in variable_name. If the question is in a roster, specify the row code as a comma-separated set of coordinates in row_number.

Usage

comment_question(
  interview_id,
  variable_name,
  roster_vector = "",
  comment,
  verbose = FALSE,
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

interview_id	Character. Interview ID. GUID from server or interview__id from exported data
variable_name	Character. Variable name. User name from Designer.
roster_vector	Character. Row code(s) of variable. If a single row code, a single character value (e.g., "102"). If multiple row codes, a character containing a comma-separated list (e.g, "1, 2").
comment	Character. Comment to post.
verbose	Logical. If verbose == TRUE, return logical outcome and print message. Otherwise, be silent.
server	Character. Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)
workspace	Character. Name of the workspace whose interviews to get. In workspace list, value of NAME, not ⁠DISPLAY NAME⁠, for the target workspace.
user	Character. API user name
password	Character. API password

Details

Wrapper for POST /api/v1/interviews/{id}/comment-by-variable/{variable} endpoint

Value

If verbose = FALSE, no return value. If verbose = TRUE, return logical outcome.

arthur-shaw/susoapi documentation built on Oct. 15, 2024, 3:44 a.m.