This function is the workhorse for the vectorised function submission_get, which gets all submissions for a list of submission IDs.

get_one_submission(
  iid,
  pid = get_default_pid(),
  fid = get_default_fid(),
  url = get_default_url(),
  un = get_default_un(),
  pw = get_default_pw(),
  retries = get_retries()
)

Arguments

iid

The instance_id, a UUID, as returned by submission_list.

pid

The numeric ID of the project, e.g.: 2.

Default: get_default_pid.

Set default pid through ru_setup(pid="...").

See vignette("Setup", package = "ruODK").

fid

The alphanumeric form ID, e.g. "build_Spotlighting-0-8_1559885147".

Default: get_default_fid.

Set default fid through ru_setup(fid="...").

See vignette("Setup", package = "ruODK").

url

The ODK Central base URL without trailing slash.

Default: get_default_url.

Set default url through ru_setup(url="...").

See vignette("Setup", package = "ruODK").

un

The ODK Central username (an email address). Default: get_default_un. Set default un through ru_setup(un="..."). See vignette("Setup", package = "ruODK").

pw

The ODK Central password. Default: get_default_pw. Set default pw through ru_setup(pw="..."). See vignette("Setup", package = "ruODK").

retries

The number of attempts to retrieve a web resource.

This parameter is given to RETRY(times = retries).

Default: 3.

Value

A nested list of submission data.

Details

Note this function returns a nested list containing any repeating subgroups. As the presence and length of repeating subgroups is non-deterministic and entirely depends on the completeness of the submission data, we cannot rectangle them any further here. Rectangling requires knowledge of the form schema and the completeness of submission data.

[Stable]

See also

Examples

if (FALSE) { # See vignette("setup") for setup and authentication options # ruODK::ru_setup(svc = "....svc", un = "[email protected]", pw = "...") # With explicit credentials, see tests sl <- submission_list() sub <- get_one_submission(sl$instance_id[[1]]) listviewer::jsonedit(sub) # The details for one submission depend on the form fields length(sub) # > 11 # The items are the field names. Repeated groups have the same name. names(sub) # > "meta" "encounter_start_datetime" "reporter" # > "device_id" "location" "habitat" # > "vegetation_structure" "perimeter" "taxon_encounter" # > "taxon_encounter" "encounter_end_datetime" }