modifyStateIdentifierName: Modify a StateIdentifierName

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

Description

This function modifies a StateIdentifierName

Usage

modifyStateIdentifierName(
  StateIdentifierNameID,
  BirthDate = NULL,
  DistrictNumber = NULL,
  DistrictTypeCode = NULL,
  Gender = NULL,
  LegalFirstName = NULL,
  LegalLastName = NULL,
  LegalMiddleName = NULL,
  LegalSuffix = NULL,
  LocalID = NULL,
  NameID = NULL,
  RequiresAPIMatchReview = NULL,
  StateIdentifierRunHistoryID = NULL,
  StudentStateID = NULL,
  entityId = 1,
  query = NULL,
  flatten = T,
  returnResponse = F
)

Arguments

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.
fieldNames	The field values to give the modified StateIdentifierName. Each defaults to NULL.

Value

The modified StateIdentifierName Skyward's Knowledge Hub

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