modifyCertificationThirdPartyFormat: Modify a CertificationThirdPartyFormat

Description Usage Arguments Value

Description

This function modifies a CertificationThirdPartyFormat

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
modifyCertificationThirdPartyFormat(
  CertificationThirdPartyFormatID,
  Code = NULL,
  DateFormat = NULL,
  Description = NULL,
  DistrictID = NULL,
  ImportType = NULL,
  NameIdentification = NULL,
  SkywardIDClonedFrom = 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 CertificationThirdPartyFormat. Each defaults to NULL.

Value

The modified CertificationThirdPartyFormat Skyward's Knowledge Hub


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