get_events: Extract events from a program

In psi-mis/a360connect: Integrate A360 Events & Tracker Program

Extract events from a program

Description

Extract events from a DHIS2 program.

Usage

get_events(
  baseurl = NULL,
  program_id = NULL,
  startDate = NULL,
  endDate = NULL,
  user = NULL,
  pass = NULL,
  paging = TRUE,
  pageSize = 50,
  pageNumber = 1,
  ...
)

Arguments

baseurl	the server url.
program_id	the program ID.
startDate	the date in YYYY-MM-DD format.
endDate	the date in YYYY-MM-DD format.
user	string. the user account used in the pass key.
pass	string. password of the user account, used in the pass key.
paging	logical. Whether to page the results or not. By default, the return events are paged.
pageSize	numeric. indicating the size of the page. default is 50.
pageNumber	Numeric. Specifies the page number to be returned. default is page 1.
...	Additional params passed to httr::config()

Value

A S3 object containing a content, endpoint and the parsed response.

psi-mis/a360connect documentation built on Nov. 22, 2022, 12:36 p.m.