deleteECFERegistrationV1RegisteringPersonV1: Delete an ECFERegistrationV1RegisteringPersonV1

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

Description

This function deletes an ECFERegistrationV1RegisteringPersonV1

Usage

deleteECFERegistrationV1RegisteringPersonV1(
  ECFERegistrationV1RegisteringPersonV1ID,
  ignoreWarnings = F,
  entityId = 1,
  query = NULL,
  flatten = T,
  returnResponse = F
)

Arguments

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

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