organizations: Returns data on an animal welfare organization, or...
In PetfindeR: 'Petfinder' API Wrapper

Description Usage Arguments Value Examples

View source: R/method_docs.R

Returns data on an animal welfare organization, or organizations, based on specified criteria.

organizations(
  organization_id = NULL,
  name = NULL,
  location = NULL,
  distance = NULL,
  state = NULL,
  country = NULL,
  query = NULL,
  sort = NULL,
  results_per_page = 20,
  pages = 1,
  return_df = FALSE
)

`organization_id`	Returns results for specified :code:'organization_id'. Can be a character vector or a vector or list of character vectors representing multiple organizations.
`name`	Returns results matching or partially matching organization name.
`location`	Returns results by specified location. Must be in the format 'city, state' for city-level results, 'latitude, longitude' for lat-long results, or 'postal code'.
`distance`	Returns results within the distance of the specified location. If not given, defaults to 100 miles. Maximum distance range is 500 miles.
`state`	Filters the results by the selected state. Must be a two-letter state code abbreviation of the state name, such as 'WA' for Washington or 'NY' for New York.
`country`	Filters results to specified country. Must be a two-letter abbreviation of the country and is limited to the United States and Canada.
`query`	Search matching and partially matching name, city or state.
`sort`	Sorts by specified attribute. Leading dashes represents a reverse-order sort. Must be one of 'recent', '-recent', 'distance', or '-distance'.
`results_per_page`	Number of results to return per page. Defaults to 20 results and cannot exceed 100 results per page.
`pages`	Specifies which page of results to return. Defaults to the first page of results. If set to NULL, all results will be returned.
`return_df`	If TRUE, the results will be returned as a data.frame. Currently does not do anything.

List of returned JSON data of organizations matching given search criteria.

## Not run: 
pf <- Petfinder(key=key, secret=secret) # Initialize Petfinder class
pf$organizations(state='WA', results_per_page = 100, pages = 2)
pf$organizations(organization_id=c(orgid1, orgid2, orgid3))

## End(Not run)