Skip to contents

Write One Submission's Validation Status Back to KoBoToolbox

Source: R/validation-kobo.R
update_validation_status.Rd

This mutates the live form. There is no development KoBoToolbox instance, so the assets a pipeline reads are the only targets in either environment — R_CONFIG_ACTIVE does not isolate this call.

Usage

update_validation_status(
  submission_id = NULL,
  asset_id = NULL,
  token = NULL,
  username = NULL,
  password = NULL,
  status = "validation_status_approved",
  url = "eu.kobotoolbox.org",
  debug = FALSE
)

Arguments

submission_id

Character or integer. The submission to query.

asset_id

Character. The KoBoToolbox asset id.

token

Character. A KoBoToolbox API token, with or without the Token prefix. Ignored when username is supplied.

username, password

Character. Basic-auth credentials.

status

Character. One of validation_status_approved, validation_status_not_approved or validation_status_on_hold.

url

Character. The KoBoToolbox host.

debug

Logical. Print the request before performing it.

Value

A one-row tibble as get_validation_status() returns, with fetch_error replaced by update_success.

See also

get_validation_status(), list_validation_statuses()

Examples

if (FALSE) { # \dontrun{
conf <- read_config()
update_validation_status(
  submission_id = "452176760",
  asset_id = conf$ingestion$landings$v3$asset_id,
  username = conf$ingestion$landings$v3$username,
  password = conf$ingestion$landings$v3$password,
  status = "validation_status_approved"
)
} # }