Fetching Information on Forms

Overview

In this vignette, we demonstrate how to interact with the Nettskjema API to perform the following tasks: 1. Retrieve a list of all forms you have access to. 1. Download reports associated with a form.

Prerequisites

Before you begin, ensure that you have already set up authentication. If you haven’t, refer to the vignette on authentication setup.

Additionally, load the required package:

library(nettskjemar)

Retrieving All Available Forms

To see which forms you have access to, use the ns_get_forms function.

Example: Getting Forms

# Retrieve all forms
forms <- ns_get_forms()

head(forms)
#>   formId         title
#> 1 123823 API test form
#>              openFrom
#> 1 2023-06-01T20:55:49
#>                openTo
#> 1 2024-06-02T02:00:02
#>    lastSubmissionDate
#> 1 2023-06-01T20:59:50
#>          modifiedDate
#> 1 2025-05-14T19:47:03
#>   personalDataErasedDate
#> 1                     NA
#>   deliveryDestination anonymous
#> 1            DATABASE     FALSE
#>   numberOfDeliveredSubmissions
#> 1                            3
#>   owners isDictaphone
#> 1      3        FALSE
#>   myFormsFormListingGroup  open
#> 1                     OLD FALSE

Retrieving Raw Form Data

If you prefer to get the raw list format as returned by the API, use asis = TRUE.

# Retrieve raw form data
raw_forms <- ns_get_forms(asis = TRUE)

# Display the raw response
print(raw_forms)

Downloading Form Reports

Each form can have reports such as CSV, Excel, or SPSS files associated with it. Use the ns_get_form_reports function to download these reports.

Example: Download a CSV Report

# Define the form ID
form_id <- 110000

# Download a CSV report to the default path
ns_get_form_reports(form_id, type = "csv")

# The report will be saved as `110000.csv` in your working directory

Example: Download an Excel Report

# Download an Excel report
ns_get_form_reports(form_id, type = "excel")

Example: Save SPSS Report to a Custom Path

# Specify the path you want to save the file
path <- fs::path_home("Desktop/110000_report.sav")

# Download and save the SPSS report
ns_get_form_reports(form_id, type = "spss", path = path)

Custom Output Paths

For custom output locations, make sure to provide the full file path in the path argument.