getTempCourseMoveCourse: Get a TempCourseMoveCourse

Description Usage Arguments Value

Description

This function returns a dataframe or json object of a TempCourseMoveCourse

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
getTempCourseMoveCourse(
  TempCourseMoveCourseID,
  CodeDescription = F,
  CourseCode = F,
  CourseDescription = F,
  CourseID = F,
  CreatedTime = F,
  EntityID = F,
  GradingPeriodSetID = F,
  GroupCourseID = F,
  IsValidUpdate = F,
  ModifiedTime = F,
  NewCalculationGroupDescription = F,
  NewCalculationGroupID = F,
  OriginalCalculationGroupDescription = F,
  OriginalCalculationGroupID = F,
  SchoolYearID = F,
  UserIDCreatedBy = F,
  UserIDModifiedBy = F,
  fieldPaths = NULL,
  entityId = 1,
  query = NULL,
  flatten = T,
  returnResponse = F
)

Arguments

TempCourseMoveCourseID

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

Value

A dataframe or of TempCourseMoveCourse Skyward's Knowledge Hub


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