check_non_id: Check if Invalid Arguments Are Provided When ID Argument is...

View source: R/validate-params-comments.R

check_non_idR Documentation

Check if Invalid Arguments Are Provided When ID Argument is Provided

Description

Because the structure of the url is different if the user provides an id, more specifically a "docketId", "documentId", or "commentId", this function checks if the user has supplied additional arguments that can't be included into the valid API call, and constructs an error accordingly.

Usage

check_non_id(arg_list, id)

Arguments

arg_list

named list containing arguments to the one of the *_construct_url functions.

id

which type of ID to check ("docketId", "documentId", or "commentId")


q-w-a/regulationsgov documentation built on May 3, 2022, 8:23 p.m.