getElectronicTranscriptPersonV1: Get an ElectronicTranscriptPersonV1

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

Description

This function returns a dataframe or json object of an ElectronicTranscriptPersonV1

Usage

getElectronicTranscriptPersonV1(
  ElectronicTranscriptPersonV1ID,
  BirthDate = F,
  CreatedTime = F,
  ElectronicTranscriptRunHistoryID = F,
  EntityID = F,
  FirstName = F,
  Gender = F,
  GuardianFirstName = F,
  GuardianLastName = F,
  HasErrors = F,
  KeyHash = F,
  LastName = F,
  MiddleName = F,
  ModifiedTime = F,
  NameIDGuardian = F,
  NameSuffix = F,
  SchoolAssignedPersonID = F,
  SchoolYearID = F,
  StudentID = F,
  UpdateHash = F,
  UserIDCreatedBy = F,
  UserIDModifiedBy = F,
  fieldPaths = NULL,
  entityId = 1,
  query = NULL,
  flatten = T,
  returnResponse = F
)

Arguments

ElectronicTranscriptPersonV1ID	The ID of the ElectronicTranscriptPersonV1 to return.
fieldPaths	Fields from other objects with 'Many to One' or 'One to One' relationships to the given object listed as text. Run getSchemaForObjects('ElectronicTranscriptPersonV1') to get more field paths.
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	A TRUE or FALSE value determining whether or not to return the field for the given ElectronicTranscriptPersonV1. Defaults to FALSE for all return fields which, for convenience, returns all fields for the ElectronicTranscriptPersonV1.

Value

A dataframe or of ElectronicTranscriptPersonV1 Skyward's Knowledge Hub

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