getAttendancePeriod: Get a specific AttendancePeriod

Description Usage Arguments Value References

View source: R/AttendanceFunctions.R

Description

This function returns fields for an AttendancePeriod.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
getAttendancePeriod(
  AttendancePeriodID,
  EntityID = 1,
  returnAttendancePeriodID = F,
  returnAttendancePeriodIDClonedFrom = F,
  returnAttendancePeriodIDClonedTo = F,
  returnCode = F,
  returnCreatedTime = F,
  returnDisplayOrder = F,
  returnDynamicRelationshipID = F,
  returnEntityGroupKey = F,
  returnEntityID = F,
  returnModifiedTime = F,
  returnSchoolYearID = F,
  returnUseForSchoolTrakPositiveAttendance = F,
  returnUserIDCreatedBy = F,
  returnUserIDModifiedBy = F,
  returnUseTeacherEntryCutOffTime = F
)

Arguments

AttendancePeriodID

The id of the AttendancePeriod.
Run getAllAttendancePeriods for a list of AttendancePeriods.

EntityID

The id of the entity. Run getAllEntities for a list of entities.

returnFieldName

A TRUE or FALSE value determining whether or not to return FieldName for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.

Value

Details for the AttendancePeriod.

References

{yourApiUrl}/swagger

Skyward's Knowledge Hub


samterfa/SkywardSDK documentation built on Oct. 13, 2020, 6:53 a.m.