Version numbers are returned as a character string. This feature is available for REDCap 6.0.0 and higher.
exportVersion(rcon, ...)# S3 method for redcapApiConnection
exportVersion(
rcon,
...,
error_handling = getOption("redcap_error_handling"),
config = list(),
api_param = list()
)
A REDCap connection object as generated by redcapConnection
Arguments to be passed to other methods.
An option for how to handle errors returned by the API.
see redcap_error
list Additional configuration parameters to pass to
POST. These are appended to any parameters in
rcon$config.
list Additional API parameters to pass into the
body of the API call. This provides users to execute calls with options
that may not otherwise be supported by redcapAPI.
This method returns the current REDCap version number as plain text (e.g., 4.13.18, 5.12.2, 6.0.0).
6.0.0+
None
Benjamin Nutter
If this function is used in a version of REDCap that does not
support the Export Version Number function, the character string
'5.12.2' is returned. This is done solely for the convenience
of always returning a value that can be compared against other versions.
Please refer to your institution's API documentation.
Additional details on API parameters are found on the package wiki at https://github.com/vubiostat/redcapAPI/wiki/REDCap-API-Parameters