api_paginate_action: General API search function

In UCSF-MSLAB/msbwaiter: Tools to Interact with the MS Bioscreen API

Description

api_search returns the bioscreen entries that match the specified search query.

Usage

api_paginate_action(action, search_by_list = list(source_id = 1,
  external_identifier = 1), endpoint = "subjects",
  base_url = "https://msbioscreen-uat.herokuapp.com/api/v1",
  token = get_token(), verbose_b = TRUE, number_of_pages = NULL,
  results_per_page = NULL)

Arguments

action	the HTTP method (GET or POST)
search_by_list	list of search parameter names and values. Set to NULL if performing a batch query (action = GET)
endpoint	the data endpoint of interest. Possible values are "subjects", "attacks", "treatments", and "visits".
base_url	the API base URL.
token	HTTP authorization token. Default is to get environment variable 'MSBWAITER_TOKEN'.
verbose_b	print progress messages as function runs?
number_of_pages	number of pages of data to return. If set to NULL (default), all pages are returned.
results_per_page	number of results to return per page. If set to NULL (default), the results_per_page query argument in the HTTP request header is equal to its default value.

See Also

api_get_batch, api_search_by_msid, api_search_by_updated_at

UCSF-MSLAB/msbwaiter documentation built on May 9, 2019, 5:19 p.m.