submission_list.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/submission_list.R
\name{submission_list}
\alias{submission_list}
\title{List all submissions of one form.}
\usage{
submission_list(
  pid = get_default_pid(),
  fid = get_default_fid(),
  url = get_default_url(),
  un = get_default_un(),
  pw = get_default_pw(),
  retries = get_retries(),
  orders = c("YmdHMS", "YmdHMSz", "Ymd HMS", "Ymd HMSz", "Ymd", "ymd"),
  tz = get_default_tz()
)
}
\arguments{
\item{pid}{The numeric ID of the project, e.g.: 2.

Default: \code{\link{get_default_pid}}.

Set default \code{pid} through \code{ru_setup(pid="...")}.

See \code{vignette("Setup", package = "ruODK")}.}

\item{fid}{The alphanumeric form ID, e.g. "build_Spotlighting-0-8_1559885147".

Default: \code{\link{get_default_fid}}.

Set default \code{fid} through \code{ru_setup(fid="...")}.

See \code{vignette("Setup", package = "ruODK")}.}

\item{url}{The ODK Central base URL without trailing slash.

Default: \code{\link{get_default_url}}.

Set default \code{url} through \code{ru_setup(url="...")}.

See \code{vignette("Setup", package = "ruODK")}.}

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

\item{pw}{The ODK Central password.
Default: \code{\link{get_default_pw}}.
Set default \code{pw} through \code{ru_setup(pw="...")}.
See \code{vignette("Setup", package = "ruODK")}.}

\item{retries}{The number of attempts to retrieve a web resource.

This parameter is given to \code{\link[httr]{RETRY}(times = retries)}.

Default: 3.}

\item{orders}{(vector of character) Orders of datetime elements for
lubridate.

Default:
\code{c("YmdHMS", "YmdHMSz", "Ymd HMS", "Ymd HMSz", "Ymd", "ymd")}.}

\item{tz}{A timezone to convert dates and times to.

Read \code{vignette("setup", package = "ruODK")} to learn how \code{ruODK}'s
timezone can be set globally or per function.}
}
\value{
A tibble containing some high-level details of the form submissions.
One row per submission, columns are submission attributes:

\if{html}{\out{<div class="sourceCode">}}\preformatted{    * instance_id: uuid, string. The unique ID for each submission.
    * submitter_id: user ID, integer.
    * created_at: time of submission upload, dttm
    * updated_at: time of submission update on server, dttm or NA
}\if{html}{\out{</div>}}
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}}
}
\examples{
\dontrun{
# Set default credentials, see vignette("setup")
ruODK::ru_setup(
  svc = ...,
  un = "me@email.com",
  pw = "..."
)

sl <- submission_list()
sl \%>\% knitr::kable(.)

fl <- form_list()

# submission_list returns a tibble
class(sl)
# > c("tbl_df", "tbl", "data.frame")

# Submission attributes are the tibble's columns
names(sl)
# > "instance_id" "submitter_id" "device_id" "created_at" "updated_at"

# Number of submissions (rows) is same as advertised in form_list
form_list_nsub <- fl \%>\%
  filter(fid == get_test_fid()) \%>\%
  magrittr::extract2("submissions") \%>\%
  as.numeric()
nrow(sl) == form_list_nsub
# > TRUE
}
}
\seealso{
\url{https://docs.getodk.org/central-api-submission-management/#listing-all-submissions-on-a-form}

Other submission-management: 
\code{\link{attachment_list}()},
\code{\link{encryption_key_list}()},
\code{\link{submission_audit_get}()},
\code{\link{submission_detail}()},
\code{\link{submission_export}()},
\code{\link{submission_get}()}
}
\concept{submission-management}