ns_get_form_attachments: Retrieve all attachments associated with a Nettskjema

In nettskjemar: Connect to the 'nettskjema.no' API of the University of Oslo

Retrieve all attachments associated with a Nettskjema

Description

Some Nettskjema have fields for attachments. These can be downloaded through this function. There are two naming convention that may be used for the saved files' names. See output of ns_list_submission_attachments for idea of the names used.

Usage

ns_get_form_attachments(
  form_id,
  filenames = c("standardized", "original"),
  output_dir = "."
)

Arguments

form_id	integer. Number of the form to retrieve
filenames	Character of either 'standardized' (default) or 'original' indicating which file names to use.
output_dir	directory to output the files to

Details

filenames types

"original"

- uses file names are they were uploaded to Nettskjema

"standardized"

- creates file names based on the submission id and a counter number to uniquely create file names for each submission (in case there are more than one attachment)

Value

invisible named logical if the file was saved successfully

Examples

## Not run: 
form_id <- 1100000
ns_get_form_attachments(form_id)

# save files to specific folder
ns_get_form_attachments(form_id, output_dir = "~/Desktop")

# save using original file names
ns_get_form_attachments(form_id, filenames = "original")


## End(Not run)

nettskjemar documentation built on April 4, 2025, 12:22 a.m.