construct_document_url: Create a URL for the Documents Endpoint

In q-w-a/regulationsgov: Accessing Regulations.gov Data

Create a URL for the Documents Endpoint

Description

Takes the parameters available for the documents endpoint of the regulations.gov API, as described here under the documents section under API calls, and constructs a URL that can be used to retrieve the data specified. To understand how these parameters relate to the data, it may help to go the the regulations.gov search function and go to a specific docket or document and look at the details section.

Usage

construct_document_url(
  key = NULL,
  documentId = NULL,
  attachments = NULL,
  docketId = NULL,
  agencyId = NULL,
  commentEndDate = NULL,
  documentType = NULL,
  frDocNum = NULL,
  searchTerm = NULL,
  postedDate = NULL,
  lastModifiedDate = NULL,
  subtype = NULL,
  withinCommentPeriod = NULL,
  sort = NULL,
  page_number = 1,
  page_size = 250
)

Arguments

key	the API key passed in the function call; this may be NULL if the user has chosen to set up the key as an environmental variable instead with the function set_datagov_key. You can use "DEMO_KEY" for a very limited number of calls if needed.
documentId	character string representing one valid document ID, for example, "CMS-2014-0063-0001". Only one documentId can be provided.
attachments	character string "true" if you want the download links included for a document, otherwise leave as NULL. Note the API only provides functionality for obtaining download link if you provide a document ID with the documentId argument.
docketId	character string representing a valid docket ID, for example, "CMS-2014-0063", or a character vector of multiple docketIds, for example, c("CMS-2014-0063", "NIH-2007-0930")
agencyId	character string representing a government agency, for example, "CMS" or "EPA" or a character vector of multiple agencies
commentEndDate	character string of length 1, representing a single comment end date, or length 2, representing a date range starting with the first element of the vector and ending at the second element of the vector. The format of each date must be yyyy-MM-dd, for example, "2020-12-01"
documentType	character string that is one of the following categories, or, if multiple document types are desired, a character vector containing a subset of these categories: "Notice", "Rule", "Proposed Rule", "Supporting & Related Material", "Other"
frDocNum	character string representing the Federal Register Number, for example, "2014-10228". Only a single federal register number is accepted.
searchTerm	character string representing a search term to filter the results for or a character vector with multiple search terms to filter for.
postedDate	character vector of length 1, representing a single posted date, or a vector of length 2, representing a date range beginning with the first element and ending at the second. Each element must be in the format yyyy-MM-dd.
lastModifiedDate	a character vector of length 1, representing a single posted date to filter for, or a vector of length 2, representing a date range beginning with the first element and ending at the second. Each element must be in the format yyyy-MM-dd HH:mm:ss.
subtype	character string representing a document subtype, for example, "Petitions for Exemption" or "Request for Comments"
withinCommentPeriod	"true" if you only want results that are still open for comment, otherwise leave this argument null.
sort	character string representing which value you want to sort the results by, supported variables are "commentEndDate", "postedDate", "lastModifiedDate", "documentId" and "title"
page_number	character string representing which page to retrieve the data; useful when output is on multiple pages. Valid values are between 1 and 20. Default value is 1.
page_size	character string representing how many elements should be on each page. Valid values are between 5 and 250. The default value is 250.

Examples

url <- construct_document_url(
  agencyId = c("CMS", "EPA"),
  postedDate = c("2020-02-02", "2020-10-02"),
  key = "DEMO_KEY"
)
url <- construct_document_url(
  documentId = "CMS-2014-0063-0001",
  attachments = "true",
  key = "DEMO_KEY"
)

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