get_interview_transcript: Get interview transcript

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

Get interview transcript

Description

Get a PDF transcript of interview responses.

Usage

get_interview_transcript(
  interview_id,
  path,
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

interview_id	Character. GUID for interview.
path	Character. Path to folder where transcript should be downloaded.
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 the ⁠GET ​/api​/v1​/interviews​/{id}​/pdf⁠ endpoint.

Value

Side-effect of generating and downloading the interview transcript for the target question.

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