deleteDoseInterval: Delete a DoseInterval

Description Usage Arguments Value

Description

This function deletes a DoseInterval

Usage

1
2
3
4
5
6
7
8
deleteDoseInterval(
  DoseIntervalID,
  ignoreWarnings = F,
  entityId = 1,
  query = NULL,
  flatten = T,
  returnResponse = F
)

Arguments

DoseIntervalID

The ID of the DoseInterval to delete

entityId

The id of the entity (school). Run listEntities for a list of entities. Defaults to 1 (district).

query

Queries to be added to the request. Ex. list(SchoolYearID = 1). Defaults to NULL.

flatten

Whether to flatten result into a dataframe or return the json object. Default is TRUE (flatten to dataframe).

returnResponse

Whether to return the server response instead of the results. Useful for debugging. Default is FALSE.

Value

The DoseIntervalID of the deleted DoseInterval. Skyward's Knowledge Hub


samterfa/rqmlativ documentation built on April 2, 2021, 12:03 p.m.