R/referees.R

In openvolley/fivbvis: Client for the FIVB VIS Web Service \url{https://www.fivb.org/VisSDK/VisWebService/}

#' Get a list of referees
#'
#' @references \url{https://www.fivb.org/VisSDK/VisWebService/#Beach%20Live_xsd~e-BeachLive~e-Referee.html}
#' @param fields character: fields to return
#' @param version integer: version of local list (currently ignored)
#' @param filter list: (currently ignored)
#'
#' @return A data.frame
#'
#' @examples
#' \dontrun{
#'   v_get_referee_list()
#' }
#'
#' @export
v_get_referee_list <- function(fields = v_fields("Referee"), version, filter) {
    ## <Request Type="GetRefereeList"
    ##          Fields="<list of the fields to return>">
    ##          Version="<version of local list>">
    ##   <Filter /> <!-- optional: contains the filter to use -->
    ## </Request>
    req <- v_request(type = "GetRefereeList", fields = fields, version = version, filter = filter, old_style = TRUE)
    make_request(req, node_path = "//Referee")
}