brapi_post_search_people: post /search/people

In mverouden/brapir-v2: Client to Access BrAPI Compliant Plant Breeding Databases

post /search/people

Description

Submit a search request for People

Usage

brapi_post_search_people(
  con = NULL,
  emailAddresses = "",
  externalReferenceIDs = "",
  externalReferenceSources = "",
  firstNames = "",
  middleNames = "",
  lastNames = "",
  mailingAddresses = "",
  personDbIds = "",
  phoneNumbers = "",
  userIDs = "",
  page = 0,
  pageSize = 1000
)

Arguments

con	list; required: TRUE; BrAPI connection object
emailAddresses	vector of type character; required: FALSE; email address(es) for person(s) to search for; default: "", when using multiple values supply as c("value1", "value2").
externalReferenceIDs	vector of type character; required: FALSE; External reference identifier(s) to search for. Could be a simple strings or a URIs (use with externalReferenceSources parameter).; default: "", when using multiple values supply as c("value1", "value2").
externalReferenceSources	vector of type character; required: FALSE; Source system or database identifier(s) of an external reference(s) to search for (use with externalReferenceIDs parameter); default: "", when using multiple values supply as c("value1", "value2").
firstNames	vector of type character; required: FALSE; Person(s) first name(s) to search for; default: "", when using multiple values supply as c("value1", "value2").
middleNames	vector of type character; required: FALSE; Person(s) middle name(s) to search for; default: "", when using multiple values supply as c("value1", "value2").
lastNames	vector of type character; required: FALSE; Person(s) last name(s) to search for; default: "", when using multiple values supply as c("value1", "value2").
mailingAddresses	vector of type character; required: FALSE; physical address(es) of a person(s) to search for; default: "", when using multiple values supply as c("value1", "value2").
personDbIds	vector of type character; required: FALSE; Unique Identifier(s) for person(s) to search for; default: "", when using multiple values supply as c("value1", "value2").
phoneNumbers	vector of type character; required: FALSE; phone number(s) of person(s) to search for; default: "", when using multiple values supply as c("value1", "value2").
userIDs	vector of type character; required: FALSE; A systems user identifier(s) associated with person(s) to search for. Different from personDbId because you could have a person who is not a user of the system.; default: "", when using multiple values supply as c("value1", "value2").
page	integer; required: FALSE; Which result page is requested. The page indexing starts at 0 (the first page is page = 0). Default is 0.
pageSize	integer; required: FALSE; The size of the pages to be returned. Default is 1000.

Details

Advanced searching for the people resource. Function will return either the search results (Status 200 for an immediate response) or a searchResultsDbId (Status 202 for both a saved and an asynchronous search).

Value

data.frame

Author(s)

Maikel Verouden

References

BrAPI SwaggerHub

See Also

Other brapi-core: brapi_get_commoncropnames(), brapi_get_lists_listDbId(), brapi_get_lists(), brapi_get_locations_locationDbId(), brapi_get_locations(), brapi_get_people_personDbId(), brapi_get_people(), brapi_get_programs_programDbId(), brapi_get_programs(), brapi_get_search_lists_searchResultsDbId(), brapi_get_search_locations_searchResultsDbId(), brapi_get_search_people_searchResultsDbId(), brapi_get_search_programs_searchResultsDbId(), brapi_get_search_studies_searchResultsDbId(), brapi_get_search_trials_searchResultsDbId(), brapi_get_seasons_seasonDbId(), brapi_get_seasons(), brapi_get_serverinfo(), brapi_get_studies_studyDbId(), brapi_get_studies(), brapi_get_studytypes(), brapi_get_trials_trialDbId(), brapi_get_trials(), brapi_post_lists_listDbId_items(), brapi_post_lists(), brapi_post_locations(), brapi_post_people(), brapi_post_programs(), brapi_post_search_lists(), brapi_post_search_locations(), brapi_post_search_programs(), brapi_post_search_studies(), brapi_post_search_trials(), brapi_post_seasons(), brapi_post_studies(), brapi_post_trials(), brapi_put_lists_listDbId(), brapi_put_locations_locationDbId(), brapi_put_people_personDbId(), brapi_put_programs_programDbId(), brapi_put_seasons_seasonDbId(), brapi_put_studies_studyDbId(), brapi_put_trials_trialDbId()

Other People: brapi_get_people_personDbId(), brapi_get_people(), brapi_get_search_people_searchResultsDbId(), brapi_post_people(), brapi_put_people_personDbId()

Examples

## Not run: 
con <- brapi_db()$testserver
con[["token"]] <- "YYYY"

# Immediate Response Example
brapi_post_search_people(con = con,
                         personDbIds = c("program_person_2",
                                         "person2"))

# Saved or Asynchronous Search Response Example
brapi_post_search_people(con = con,
                         emailAddresses = "[e-mail]",
                         firstNames = "Bob",
                         middleNames = "Danger",
                         lastNames = "Robertson",
                         personDbIds = c("list_person_1",
                                         "person1"))

## End(Not run)

mverouden/brapir-v2 documentation built on April 22, 2022, 9:24 a.m.