getCourse: Get a specific Course

Description Usage Arguments Value References

Description

This function returns fields for a Course.

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
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
getCourse(
  CourseID,
  EntityID = 1,
  returnCourseID = F,
  returnAcademicMinutes = F,
  returnActiveSections = F,
  returnActiveSectionsOpen = F,
  returnActivityID = F,
  returnAllowTeachersToAddAssignments = F,
  returnCanBeOfferedToAnotherEntity = F,
  returnCategory = F,
  returnCategoryCode = F,
  returnCodeDescription = F,
  returnCourseCloned = F,
  returnCourseCode = F,
  returnCourseGradeLevelCodes = F,
  returnCourseGroupDescriptions = F,
  returnCourseIDClonedFrom = F,
  returnCourseIDClonedTo = F,
  returnCourseIDHash = F,
  returnCourseLengthID = F,
  returnCourseMNID = F,
  returnCourseSubjectID = F,
  returnCourseTypeID = F,
  returnCreatedTime = F,
  returnCurriculumID = F,
  returnDepartmentID = F,
  returnDescription = F,
  returnEarnedCredits = F,
  returnEdFiCourseLevelCharacteristicID = F,
  returnEdFiSubjectTypeID = F,
  returnEntityGroupKey = F,
  returnEntityID = F,
  returnEstimatedNumberOfSections = F,
  returnExcludeFromSTAR = F,
  returnExcludeFromStudentSectionLink = F,
  returnGradeCourse = F,
  returnGradeLevelIDSummary = F,
  returnGradeLevelSummary = F,
  returnGradingPeriodSetID = F,
  returnHasAttachedStandards = F,
  returnHasCourseRequestsInCommonWithCourse = F,
  returnHasNonAlternateStudentCourseRequests = F,
  returnHasOfferedCourseEntity = F,
  returnHasStudentCourseRequests = F,
  returnHasSubjects = F,
  returnHideFromArenaScheduling = F,
  returnHideFromRequestEntry = F,
  returnIsActive = F,
  returnIsActiveForEntity = F,
  returnIsAHistoricRecord = F,
  returnIsCoreAcademic = F,
  returnIsCurrentSchoolYear = F,
  returnIsDirectPay = F,
  returnIsHonors = F,
  returnIsOffered = F,
  returnIsRepeatable = F,
  returnIsRequired = F,
  returnIsRequiredOverride = F,
  returnIsWritingEmphasis = F,
  returnKeepAttendance = F,
  returnLengthOfPeriod = F,
  returnLockCourseFromSectionScheduler = F,
  returnMaximumPercentageOfSectionsInSingleDisplayPeriod = F,
  returnMaxRequestedCount = F,
  returnModifiedTime = F,
  returnNumberOfAlternateCourseRequests = F,
  returnNumberOfCourseRequests = F,
  returnNumberOfCourseRequestsFemales = F,
  returnNumberOfCourseRequestsInCommonWithCourse = F,
  returnNumberOfCourseRequestsMales = F,
  returnNumberOfSeatsAvailable = F,
  returnNumberOfSeatsRemaining = F,
  returnNumberOfTransferStudentSections = F,
  returnOfferingEntity = F,
  returnOverrideStudentSectionLinkByCourse = F,
  returnPeriodsPerWeek = F,
  returnPreventDrop = F,
  returnPreventMultipleSectionsUsingSingleDisplayPeriod = F,
  returnRequestLimitPerStudent = F,
  returnRequired = F,
  returnSchedulingPriority = F,
  returnSchedulingPriorityCode = F,
  returnSchedulingPriorityCodeOverride = F,
  returnSchedulingPriorityOverride = F,
  returnSchedulingTeamMode = F,
  returnSchedulingTeamModeCode = F,
  returnSchedulingType = F,
  returnSchedulingTypeCode = F,
  returnSchedulingTypeCodeOverride = F,
  returnSchedulingTypeOverride = F,
  returnSchoolYearID = F,
  returnSectionSchedulerManualProcessingOrder = F,
  returnSequenceLimit = F,
  returnSequenceNumber = F,
  returnSpecificStudentRequests = F,
  returnStateCarlPerkinsProgramCodeMNID = F,
  returnStateSTARAssignmentCodeMNID = F,
  returnStateSTARGradeLevelMNID = F,
  returnSumTotalActiveSectionsOptimalStudentCount = F,
  returnTotalEntitiesOfferedTo = F,
  returnTotalSectionCount = F,
  returnTotalStudentCourseRequestSectionLengthSubsetCount = F,
  returnTotalStudentSectionCount = F,
  returnUseRequiredOverride = F,
  returnUserIDCreatedBy = F,
  returnUserIDModifiedBy = F,
  returnUseSchedulingPriorityOverride = F,
  returnUseSchedulingTypeOverride = F,
  returnViewingFromOfferingEntity = F,
  returnWebsite = F
)

Arguments

CourseID

The id of the Course.
Run getAllCourses for a list of Courses.

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 Course.

References

{yourApiUrl}/swagger

Skyward's Knowledge Hub


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