deleteEligibilityCategory: Delete an EligibilityCategory

In samterfa/rqmlativ: Creates R Functions for Skyward Qmlativ's Generic API

Description

This function deletes an EligibilityCategory

Usage

deleteEligibilityCategory(
  EligibilityCategoryID,
  ignoreWarnings = F,
  entityId = 1,
  query = NULL,
  flatten = T,
  returnResponse = F
)

Arguments

EligibilityCategoryID	The ID of the EligibilityCategory 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 EligibilityCategoryID of the deleted EligibilityCategory. Skyward's Knowledge Hub

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