R/info.R

In evanodell/dwpstat: Access 'Stat-Xplore' data on the UK benefits system

#' Information on the Stat-Xplore API
#'
#' As of 2018-10-31, `dwp_info` only returns the languages available on the
#' server, and the only available language is English. This function does
#' not accept any parameters.
#'
#' @return A list with available languages on the API
#' @export
#'
#' @examples \dontrun{
#' dwp_info()
#' #> $`languages`
#' #> list()
#' }

dwp_info <- function() {
  query <- paste0(dwp_baseurl, "info")

  resp <- dwp_get_info_util(query)

  resp
}