getElectronicTranscriptAcademicSessionV1: Get an ElectronicTranscriptAcademicSessionV1

Description Usage Arguments Value

Description

This function returns a dataframe or json object of an ElectronicTranscriptAcademicSessionV1

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
getElectronicTranscriptAcademicSessionV1(
  ElectronicTranscriptAcademicSessionV1ID,
  CreatedTime = F,
  DaysAbsent = F,
  DaysPresent = F,
  ElectronicTranscriptRunHistoryID = F,
  EntityID = F,
  EntryWithdrawalID = F,
  HasErrors = F,
  KeyHash = F,
  ModifiedTime = F,
  OrganizationName = F,
  SchoolYearID = F,
  SectionLengthID = F,
  SessionDesignator = F,
  SessionName = F,
  SessionSchoolYear = F,
  SessionType = F,
  StudentID = F,
  StudentLevel = F,
  UpdateHash = F,
  UserIDCreatedBy = F,
  UserIDModifiedBy = F,
  fieldPaths = NULL,
  entityId = 1,
  query = NULL,
  flatten = T,
  returnResponse = F
)

Arguments

ElectronicTranscriptAcademicSessionV1ID

The ID of the ElectronicTranscriptAcademicSessionV1 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('ElectronicTranscriptAcademicSessionV1') 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 ElectronicTranscriptAcademicSessionV1. Defaults to FALSE for all return fields which, for convenience, returns all fields for the ElectronicTranscriptAcademicSessionV1.

Value

A dataframe or of ElectronicTranscriptAcademicSessionV1 Skyward's Knowledge Hub


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