Academics

API docs by Redocly

Academics - AdditionalGpa (1.0)

Download OpenAPI specification:Download

Anthology, Inc.: support@anthology.com URL: https://www.anthology.com

All API calls related to Academics.

AdditionalGpa

Get Gpa Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-additionalgpa-getgpacourse-request-payload)

studentId	number <int32>
gpaId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentId": 0,
"gpaId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"gpaName": "string",
"isIncludedPreviousEducationTotal": true,
"isIncludedTermCalculation": true,
"cumulativeGpa": 0,
"studentGpaCourseList": [{"id": 0,
"isTransfer": true,
"isCumulativeGpa": true,
"isTermGpa": true,
"isCumulativeGpaByDefault": true,
"isTermGpaByDefault": true,
"isIncludedByDefault": true,
"isManualOverride": true,
"isRemovedByRetake": true,
"code": "string",
"name": "string",
"term": "string",
"section": "string",
"numericGrade": 0,
"grade": "string",
"status": "string",
"endDate": "2019-08-24T14:15:22Z",
"unitsEarned": 0,
"unitsAttempted": 0,
"gradePoints": 0,
"qualityPoints": 0,
"qualityUnits": 0
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Student Gpa

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-additionalgpa-getstudentgpa-request-payload)

studentId

number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentGpaList": [{"id": 0,
"code": "string",
"name": "string",
"isWeighted": true,
"isShownOnDegreeProgressAudit": true,
"isIncludedPreviousEducationTotal": true,
"isIncludedTermCalculations": true,
"isNoteVisible": true,
"note": "string",
"studentTermGpaList": [{"id": 0,
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"parentTermId": 0,
"code": "string",
"name": "string",
"currentGpa": 0,
"cumulativeGpa": 0,
"unitsEarned": 0,
"unitsAttempted": 0,
"qualityPoints": 0,
"qualityUnits": 0,
"gradePoints": 0,
"coursesTaken": 0
}
],
"cumulativeGpa": 0,
"unitsEarned": 0,
"unitsAttempted": 0,
"qualityPoints": 0,
"qualityUnits": 0,
"gradePoints": 0,
"coursesTaken": 0,
"cumulativeGpaText": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Recalculate Gpa

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-additionalgpa-recalculategpa-request-payload)

studentId

number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentGpaList": [{"id": 0,
"code": "string",
"name": "string",
"isWeighted": true,
"isShownOnDegreeProgressAudit": true,
"isIncludedPreviousEducationTotal": true,
"isIncludedTermCalculations": true,
"isNoteVisible": true,
"note": "string",
"studentTermGpaList": [{"id": 0,
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"parentTermId": 0,
"code": "string",
"name": "string",
"currentGpa": 0,
"cumulativeGpa": 0,
"unitsEarned": 0,
"unitsAttempted": 0,
"qualityPoints": 0,
"qualityUnits": 0,
"gradePoints": 0,
"coursesTaken": 0
}
],
"cumulativeGpa": 0,
"unitsEarned": 0,
"unitsAttempted": 0,
"qualityPoints": 0,
"qualityUnits": 0,
"gradePoints": 0,
"coursesTaken": 0,
"cumulativeGpaText": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Gpa Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-additionalgpa-savegpacourse-request-payload)

gpaCalculationTypeId	number <int32>
studentId	number <int32>
	Array of objects (cmc-nexus-academics-services-studentGpaCourseValue)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"gpaCalculationTypeId": 0,
"studentId": 0,
"studentGpaCourseValueList": [{"id": 0,
"isIncludedInDefaultGpa": true,
"isIncludedInTermGpa": true,
"isIncludeInCumGpa": true,
"isManualOverride": true,
"unitsAttempted": 0,
"unitsEarned": 0
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"calculatedGpaResponse": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Attendance

Create Attendance

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"id": 0,
"absent": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"attendanceDateStartTime": "2019-08-24T14:15:22Z",
"attended": 0,
"classSectionMeetingDateId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"delContext": "string",
"isDependentCourse": true,
"isExcusedAbsence": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"note": "string",
"rowVersion": "string",
"status": "string",
"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"type": "string",
"unitType": "string",
"classSectionMeetingDate": {"isMeetingScheduleConflicted": true,
"isMeetingScheduleConflictOverridden": true,
"courseClockHours": 0,
"classSchedLength": 0,
"id": 0,
"buildingId": 0,
"classSectionId": 0,
"classSectionMeetingPatternId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"instructorId": 0,
"isManualEdit": true,
"isMeetingEdit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lengthMinutes": 0,
"locationId": 0,
"meetingDate": "2019-08-24T14:15:22Z",
"note": "string",
"roomId": 0,
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Attendance

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-attendance-delete-request-payload)

id	number <int32> Id
absent	number <int32> Absent
attendanceDate	string <date-time> Attendance Date
attendanceDateStartTime	string <date-time> Attendance Date Start Time
attended	number <int32> Attended
classSectionMeetingDateId	number <int32> Class Section Meeting Date Id
createdDateTime	string <date-time> Created Date Time
delContext	string Del Context
isDependentCourse	boolean Is Dependent Course
isExcusedAbsence	boolean Is Excused Absence
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
note	string Note
rowVersion	string
status	string Status
studentCourseId	number <int32> Student Course Id
studentEnrollmentPeriodId	number <int32> Student Enrollment Period Id
type	string Type
unitType	string Unit Type
	object (cmc-nexus-academics-entities-classSectionMeetingDateEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"absent": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"attendanceDateStartTime": "2019-08-24T14:15:22Z",
"attended": 0,
"classSectionMeetingDateId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"delContext": "string",
"isDependentCourse": true,
"isExcusedAbsence": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"note": "string",
"rowVersion": "string",
"status": "string",
"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"type": "string",
"unitType": "string",
"classSectionMeetingDate": {"isMeetingScheduleConflicted": true,
"isMeetingScheduleConflictOverridden": true,
"courseClockHours": 0,
"classSchedLength": 0,
"id": 0,
"buildingId": 0,
"classSectionId": 0,
"classSectionMeetingPatternId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"instructorId": 0,
"isManualEdit": true,
"isMeetingEdit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lengthMinutes": 0,
"locationId": 0,
"meetingDate": "2019-08-24T14:15:22Z",
"note": "string",
"roomId": 0,
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Attendance

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-attendance-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"id": 0,
"absent": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"attendanceDateStartTime": "2019-08-24T14:15:22Z",
"attended": 0,
"classSectionMeetingDateId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"delContext": "string",
"isDependentCourse": true,
"isExcusedAbsence": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"note": "string",
"rowVersion": "string",
"status": "string",
"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"type": "string",
"unitType": "string",
"classSectionMeetingDate": {"isMeetingScheduleConflicted": true,
"isMeetingScheduleConflictOverridden": true,
"courseClockHours": 0,
"classSchedLength": 0,
"id": 0,
"buildingId": 0,
"classSectionId": 0,
"classSectionMeetingPatternId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"instructorId": 0,
"isManualEdit": true,
"isMeetingEdit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lengthMinutes": 0,
"locationId": 0,
"meetingDate": "2019-08-24T14:15:22Z",
"note": "string",
"roomId": 0,
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Attendance

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-attendance-getattendance-request-payload)

classSectionId	number <int32>
startDate	string <date-time>
endDate	string <date-time>
termId	number <int32>
isStudentSpecificMeetingSchedule	boolean
defaultTimeForMeeting	number <int32>
startTime	string
isMeetingOnIrregularDaysTimes	boolean
campusId	number <int32>
unitType	string
type	string
classLength	number <int32>
	object (cmc-nexus-academics-entities-attendanceEntity)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionId": 0,
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"termId": 0,
"isStudentSpecificMeetingSchedule": true,
"defaultTimeForMeeting": 0,
"startTime": "string",
"isMeetingOnIrregularDaysTimes": true,
"campusId": 0,
"unitType": "string",
"type": "string",
"classLength": 0,
"entity": {"id": 0,
"absent": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"attendanceDateStartTime": "2019-08-24T14:15:22Z",
"attended": 0,
"classSectionMeetingDateId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"delContext": "string",
"isDependentCourse": true,
"isExcusedAbsence": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"note": "string",
"rowVersion": "string",
"status": "string",
"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"type": "string",
"unitType": "string",
"classSectionMeetingDate": {"isMeetingScheduleConflicted": true,
"isMeetingScheduleConflictOverridden": true,
"courseClockHours": 0,
"classSchedLength": 0,
"id": 0,
"buildingId": 0,
"classSectionId": 0,
"classSectionMeetingPatternId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"instructorId": 0,
"isManualEdit": true,
"isMeetingEdit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lengthMinutes": 0,
"locationId": 0,
"meetingDate": "2019-08-24T14:15:22Z",
"note": "string",
"roomId": 0,
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}
}

Response samples

Content type

application/json

{"payload": {"data": {"entity": {"id": 0,
"absent": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"attendanceDateStartTime": "2019-08-24T14:15:22Z",
"attended": 0,
"classSectionMeetingDateId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"delContext": "string",
"isDependentCourse": true,
"isExcusedAbsence": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"note": "string",
"rowVersion": "string",
"status": "string",
"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"type": "string",
"unitType": "string",
"classSectionMeetingDate": {"isMeetingScheduleConflicted": true,
"isMeetingScheduleConflictOverridden": true,
"courseClockHours": 0,
"classSchedLength": 0,
"id": 0,
"buildingId": 0,
"classSectionId": 0,
"classSectionMeetingPatternId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"instructorId": 0,
"isManualEdit": true,
"isMeetingEdit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lengthMinutes": 0,
"locationId": 0,
"meetingDate": "2019-08-24T14:15:22Z",
"note": "string",
"roomId": 0,
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"isAuditCourse": true,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Post Attendance

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-attendance-postattendance-request-payload)

classSectionId	number <int32>
studentId	number <int32>
startDate	string <date-time>
endDate	string <date-time>
allowClosedTerm	boolean
isPostExternshipOnline	boolean
	object (cmc-nexus-academics-entities-attendanceEntity)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionId": 0,
"studentId": 0,
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"allowClosedTerm": true,
"isPostExternshipOnline": true,
"entity": {"id": 0,
"absent": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"attendanceDateStartTime": "2019-08-24T14:15:22Z",
"attended": 0,
"classSectionMeetingDateId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"delContext": "string",
"isDependentCourse": true,
"isExcusedAbsence": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"note": "string",
"rowVersion": "string",
"status": "string",
"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"type": "string",
"unitType": "string",
"classSectionMeetingDate": {"isMeetingScheduleConflicted": true,
"isMeetingScheduleConflictOverridden": true,
"courseClockHours": 0,
"classSchedLength": 0,
"id": 0,
"buildingId": 0,
"classSectionId": 0,
"classSectionMeetingPatternId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"instructorId": 0,
"isManualEdit": true,
"isMeetingEdit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lengthMinutes": 0,
"locationId": 0,
"meetingDate": "2019-08-24T14:15:22Z",
"note": "string",
"roomId": 0,
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}
}

Response samples

Content type

application/json

{"payload": {"data": {"entity": {"id": 0,
"absent": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"attendanceDateStartTime": "2019-08-24T14:15:22Z",
"attended": 0,
"classSectionMeetingDateId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"delContext": "string",
"isDependentCourse": true,
"isExcusedAbsence": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"note": "string",
"rowVersion": "string",
"status": "string",
"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"type": "string",
"unitType": "string",
"classSectionMeetingDate": {"isMeetingScheduleConflicted": true,
"isMeetingScheduleConflictOverridden": true,
"courseClockHours": 0,
"classSchedLength": 0,
"id": 0,
"buildingId": 0,
"classSectionId": 0,
"classSectionMeetingPatternId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"instructorId": 0,
"isManualEdit": true,
"isMeetingEdit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lengthMinutes": 0,
"locationId": 0,
"meetingDate": "2019-08-24T14:15:22Z",
"note": "string",
"roomId": 0,
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Post Attendance Dates

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-attendance-postattendancedates-request-payload)

Array of objects (cmc-nexus-academics-services-recordAttendanceDatesRoster)

Array

firstName	string
lastName	string
mi	string
studentId	number <int32>
studentEnrollmentId required	number <int32>
studentCourseId	number <int32>
studentCourseStatus	string
studentName	string
ssn	string
schoolStatusCode	string
programVersionName	string
minutesAttended	number <int32>
minutesAbsent	number <int32>
note	string
endDate	string <date-time>
isAfterAddDrop	boolean
enrollmentStatusCategory	string
createdDateTime	string <date-time>
isPreventAttendance	boolean
lastRevenueEarnedDate	string <date-time>
startDate	string <date-time>
lda	string <date-time>
schoolStatusId	number <int32>
schoolStatusName	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"attendanceDatesRosterList": [{"firstName": "string",
"lastName": "string",
"mi": "string",
"studentId": 0,
"studentEnrollmentId": 0,
"studentCourseId": 0,
"studentCourseStatus": "string",
"studentName": "string",
"ssn": "string",
"schoolStatusCode": "string",
"programVersionName": "string",
"minutesAttended": 0,
"minutesAbsent": 0,
"note": "string",
"endDate": "2019-08-24T14:15:22Z",
"isAfterAddDrop": true,
"enrollmentStatusCategory": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isPreventAttendance": true,
"lastRevenueEarnedDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"lda": "2019-08-24T14:15:22Z",
"schoolStatusId": 0,
"schoolStatusName": "string"
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Post Attendance List

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-attendance-postattendancelist-request-payload)

unitType	string
courseName	string
postAttendanceType	string
endDate	string <date-time>
classSectionId	number <int32>
isStudentSpecificMeetingSchedule	boolean
courseId	number <int32>
	Array of objects (cmc-nexus-academics-services-attendanceRoster)
	object (cmc-nexus-academics-entities-attendanceEntity)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"unitType": "string",
"courseName": "string",
"postAttendanceType": "string",
"endDate": "2019-08-24T14:15:22Z",
"classSectionId": 0,
"isStudentSpecificMeetingSchedule": true,
"courseId": 0,
"attendanceRosterList": [{"studentCourseId": 0,
"attendanceDate": "string",
"attendanceDateStartTime": "string",
"minutesAttended": 0,
"minutesAbsent": 0,
"excused": 0,
"classSectionMeetingDateId": 0,
"note": "string",
"attendanceId": 0,
"attendanceType": "string",
"studentId": 0,
"status": "string"
}
],
"entity": {"id": 0,
"absent": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"attendanceDateStartTime": "2019-08-24T14:15:22Z",
"attended": 0,
"classSectionMeetingDateId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"delContext": "string",
"isDependentCourse": true,
"isExcusedAbsence": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"note": "string",
"rowVersion": "string",
"status": "string",
"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"type": "string",
"unitType": "string",
"classSectionMeetingDate": {"isMeetingScheduleConflicted": true,
"isMeetingScheduleConflictOverridden": true,
"courseClockHours": 0,
"classSchedLength": 0,
"id": 0,
"buildingId": 0,
"classSectionId": 0,
"classSectionMeetingPatternId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"instructorId": 0,
"isManualEdit": true,
"isMeetingEdit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lengthMinutes": 0,
"locationId": 0,
"meetingDate": "2019-08-24T14:15:22Z",
"note": "string",
"roomId": 0,
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}
}

Response samples

Content type

application/json

{"payload": {"data": {"entity": {"id": 0,
"absent": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"attendanceDateStartTime": "2019-08-24T14:15:22Z",
"attended": 0,
"classSectionMeetingDateId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"delContext": "string",
"isDependentCourse": true,
"isExcusedAbsence": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"note": "string",
"rowVersion": "string",
"status": "string",
"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"type": "string",
"unitType": "string",
"classSectionMeetingDate": {"isMeetingScheduleConflicted": true,
"isMeetingScheduleConflictOverridden": true,
"courseClockHours": 0,
"classSchedLength": 0,
"id": 0,
"buildingId": 0,
"classSectionId": 0,
"classSectionMeetingPatternId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"instructorId": 0,
"isManualEdit": true,
"isMeetingEdit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lengthMinutes": 0,
"locationId": 0,
"meetingDate": "2019-08-24T14:15:22Z",
"note": "string",
"roomId": 0,
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"isPostAttendanceSuccess": true,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Post Externship Online Hours

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-attendance-postexternshiponlinehours-request-payload)

classSectionId	number <int32>
studentId	number <int32>
startDate	string <date-time>
endDate	string <date-time>
allowClosedTerm	boolean
isPostExternshipOnline	boolean
	object (cmc-nexus-academics-entities-attendanceEntity)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionId": 0,
"studentId": 0,
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"allowClosedTerm": true,
"isPostExternshipOnline": true,
"entity": {"id": 0,
"absent": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"attendanceDateStartTime": "2019-08-24T14:15:22Z",
"attended": 0,
"classSectionMeetingDateId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"delContext": "string",
"isDependentCourse": true,
"isExcusedAbsence": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"note": "string",
"rowVersion": "string",
"status": "string",
"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"type": "string",
"unitType": "string",
"classSectionMeetingDate": {"isMeetingScheduleConflicted": true,
"isMeetingScheduleConflictOverridden": true,
"courseClockHours": 0,
"classSchedLength": 0,
"id": 0,
"buildingId": 0,
"classSectionId": 0,
"classSectionMeetingPatternId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"instructorId": 0,
"isManualEdit": true,
"isMeetingEdit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lengthMinutes": 0,
"locationId": 0,
"meetingDate": "2019-08-24T14:15:22Z",
"note": "string",
"roomId": 0,
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}
}

Response samples

Content type

application/json

{"payload": {"data": {"entity": {"id": 0,
"absent": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"attendanceDateStartTime": "2019-08-24T14:15:22Z",
"attended": 0,
"classSectionMeetingDateId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"delContext": "string",
"isDependentCourse": true,
"isExcusedAbsence": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"note": "string",
"rowVersion": "string",
"status": "string",
"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"type": "string",
"unitType": "string",
"classSectionMeetingDate": {"isMeetingScheduleConflicted": true,
"isMeetingScheduleConflictOverridden": true,
"courseClockHours": 0,
"classSchedLength": 0,
"id": 0,
"buildingId": 0,
"classSectionId": 0,
"classSectionMeetingPatternId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"instructorId": 0,
"isManualEdit": true,
"isMeetingEdit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lengthMinutes": 0,
"locationId": 0,
"meetingDate": "2019-08-24T14:15:22Z",
"note": "string",
"roomId": 0,
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Recall Attendance

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-attendance-recallattendance-request-payload)

studentEnrollmentPeriodId

number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentEnrollmentPeriodId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Attendance

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-attendance-save-request-payload)

id	number <int32> Id
absent	number <int32> Absent
attendanceDate	string <date-time> Attendance Date
attendanceDateStartTime	string <date-time> Attendance Date Start Time
attended	number <int32> Attended
classSectionMeetingDateId	number <int32> Class Section Meeting Date Id
createdDateTime	string <date-time> Created Date Time
delContext	string Del Context
isDependentCourse	boolean Is Dependent Course
isExcusedAbsence	boolean Is Excused Absence
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
note	string Note
rowVersion	string
status	string Status
studentCourseId	number <int32> Student Course Id
studentEnrollmentPeriodId	number <int32> Student Enrollment Period Id
type	string Type
unitType	string Unit Type
	object (cmc-nexus-academics-entities-classSectionMeetingDateEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"absent": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"attendanceDateStartTime": "2019-08-24T14:15:22Z",
"attended": 0,
"classSectionMeetingDateId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"delContext": "string",
"isDependentCourse": true,
"isExcusedAbsence": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"note": "string",
"rowVersion": "string",
"status": "string",
"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"type": "string",
"unitType": "string",
"classSectionMeetingDate": {"isMeetingScheduleConflicted": true,
"isMeetingScheduleConflictOverridden": true,
"courseClockHours": 0,
"classSchedLength": 0,
"id": 0,
"buildingId": 0,
"classSectionId": 0,
"classSectionMeetingPatternId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"instructorId": 0,
"isManualEdit": true,
"isMeetingEdit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lengthMinutes": 0,
"locationId": 0,
"meetingDate": "2019-08-24T14:15:22Z",
"note": "string",
"roomId": 0,
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"id": 0,
"absent": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"attendanceDateStartTime": "2019-08-24T14:15:22Z",
"attended": 0,
"classSectionMeetingDateId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"delContext": "string",
"isDependentCourse": true,
"isExcusedAbsence": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"note": "string",
"rowVersion": "string",
"status": "string",
"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"type": "string",
"unitType": "string",
"classSectionMeetingDate": {"isMeetingScheduleConflicted": true,
"isMeetingScheduleConflictOverridden": true,
"courseClockHours": 0,
"classSchedLength": 0,
"id": 0,
"buildingId": 0,
"classSectionId": 0,
"classSectionMeetingPatternId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"instructorId": 0,
"isManualEdit": true,
"isMeetingEdit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lengthMinutes": 0,
"locationId": 0,
"meetingDate": "2019-08-24T14:15:22Z",
"note": "string",
"roomId": 0,
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Attendance

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-attendance-savenew-request-payload)

id	number <int32> Id
absent	number <int32> Absent
attendanceDate	string <date-time> Attendance Date
attendanceDateStartTime	string <date-time> Attendance Date Start Time
attended	number <int32> Attended
classSectionMeetingDateId	number <int32> Class Section Meeting Date Id
createdDateTime	string <date-time> Created Date Time
delContext	string Del Context
isDependentCourse	boolean Is Dependent Course
isExcusedAbsence	boolean Is Excused Absence
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
note	string Note
rowVersion	string
status	string Status
studentCourseId	number <int32> Student Course Id
studentEnrollmentPeriodId	number <int32> Student Enrollment Period Id
type	string Type
unitType	string Unit Type
	object (cmc-nexus-academics-entities-classSectionMeetingDateEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"absent": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"attendanceDateStartTime": "2019-08-24T14:15:22Z",
"attended": 0,
"classSectionMeetingDateId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"delContext": "string",
"isDependentCourse": true,
"isExcusedAbsence": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"note": "string",
"rowVersion": "string",
"status": "string",
"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"type": "string",
"unitType": "string",
"classSectionMeetingDate": {"isMeetingScheduleConflicted": true,
"isMeetingScheduleConflictOverridden": true,
"courseClockHours": 0,
"classSchedLength": 0,
"id": 0,
"buildingId": 0,
"classSectionId": 0,
"classSectionMeetingPatternId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"instructorId": 0,
"isManualEdit": true,
"isMeetingEdit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lengthMinutes": 0,
"locationId": 0,
"meetingDate": "2019-08-24T14:15:22Z",
"note": "string",
"roomId": 0,
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"id": 0,
"absent": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"attendanceDateStartTime": "2019-08-24T14:15:22Z",
"attended": 0,
"classSectionMeetingDateId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"delContext": "string",
"isDependentCourse": true,
"isExcusedAbsence": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"note": "string",
"rowVersion": "string",
"status": "string",
"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"type": "string",
"unitType": "string",
"classSectionMeetingDate": {"isMeetingScheduleConflicted": true,
"isMeetingScheduleConflictOverridden": true,
"courseClockHours": 0,
"classSchedLength": 0,
"id": 0,
"buildingId": 0,
"classSectionId": 0,
"classSectionMeetingPatternId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"instructorId": 0,
"isManualEdit": true,
"isMeetingEdit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lengthMinutes": 0,
"locationId": 0,
"meetingDate": "2019-08-24T14:15:22Z",
"note": "string",
"roomId": 0,
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

ClassSection

Accept Wait List Students

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-acceptwaitliststudents-request-payload)

studentCoursePendingRegistrationId	number <int32>
isAllowedOverrideRegistrationLockConflict	boolean
isAllowedOverrideMaxAttemptsCourse	boolean
isAllowedOverrideRetake	boolean
isDateTimeConflictAllowed	boolean
isAllowedOverrideMaxRegistrationForClass	boolean
isAllowedOverridePrereqCoregConflict	boolean
isAllowedOverrideAddDrop	boolean
isSendMessage	boolean
isTransferStudent	boolean
transferStudentClassSectionId	number <int32>
isStudentRegistrationHoldOverrideAllowed	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentCoursePendingRegistrationId": 0,
"isAllowedOverrideRegistrationLockConflict": true,
"isAllowedOverrideMaxAttemptsCourse": true,
"isAllowedOverrideRetake": true,
"isDateTimeConflictAllowed": true,
"isAllowedOverrideMaxRegistrationForClass": true,
"isAllowedOverridePrereqCoregConflict": true,
"isAllowedOverrideAddDrop": true,
"isSendMessage": true,
"isTransferStudent": true,
"transferStudentClassSectionId": 0,
"isStudentRegistrationHoldOverrideAllowed": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentCoursePendingRegistrationId": 0,
"isAllowedOverrideRegistrationLockConflict": true,
"isAllowedOverrideMaxAttemptsCourse": true,
"isAllowedOverrideRetake": true,
"isDateTimeConflictAllowed": true,
"isAllowedOverrideMaxRegistrationForClass": true,
"isAllowedOverridePrereqCoregConflict": true,
"isAllowedOverrideAddDrop": true,
"isStudentRegistrationHoldOverrideAllowed": true,
"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"prereqCoreqStatusSummaryInfoMessageList": [{"summaryInfoMessageId": 0,
"classSectionId": 0,
"courseId": 0,
"prereqCheckStatus": 0,
"coreqCheckStatus": 0,
"prereqFailureMessage": "string",
"coreqFailureMessage": "string",
"prereqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"coreqFailureInfoMessagList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"antireqFailureMessage": "string",
"antireqCheckStatus": 0,
"antireqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
]
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Cancel Class Section

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-cancelclasssection-request-payload)

classSectionId	number <int32>
classSectionCancelReasonId	number <int32>
courseStatusChangeReasonId	number <int32>
	Array of objects (cmc-nexus-academics-services-unregisterStudentCourseDetails)
studentGroupId	number <int32>
studentGroupName	string
campusId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionId": 0,
"classSectionCancelReasonId": 0,
"courseStatusChangeReasonId": 0,
"unregisterStudentCourseDetailsList": [{"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"courseId": 0,
"termId": 0,
"campusId": 0,
"studentName": "string",
"enrollmentStatus": "string",
"classStatus": "string",
"studentNumber": "string",
"enrollmentName": "string"
}
],
"studentGroupId": 0,
"studentGroupName": "string",
"campusId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"classSectionId": 0,
"isClassSectionCancelled": true,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Clear Multiple Term Wait List

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-clearmultipletermwaitlist-request-payload)

campusId	number <int32>
termIdList	Array of numbers <int32> [ items <int32 > ]
isSendMessage	boolean
classSectionId	number <int32>
studentEnrollmentPeriodId	number <int32>
classSectionIdList	Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusId": 0,
"termIdList": [0
],
"isSendMessage": true,
"classSectionId": 0,
"studentEnrollmentPeriodId": 0,
"classSectionIdList": [0
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Clear Wait List

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-clearwaitlist-request-payload)

campusId	number <int32>
termId	number <int32>
isSendMessage	boolean
classSectionId	number <int32>
studentEnrollmentPeriodId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusId": 0,
"termId": 0,
"isSendMessage": true,
"classSectionId": 0,
"studentEnrollmentPeriodId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Clear Wait List Students

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-clearwaitliststudents-request-payload)

classSectionId	number <int32>
termId	number <int32>
isClearAllStudents	boolean
studentEnrollmentRegistrationIds	object
isSendMessage	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionId": 0,
"termId": 0,
"isClearAllStudents": true,
"studentEnrollmentRegistrationIds": { },
"isSendMessage": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Copy Class Schedule

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-copyclassschedule-request-payload)

sourceTermId	number <int32>
id	number <int32>
newSectionCode	string
courseId	number <int32>
campusId	number <int32>
isCopyHideFaculty	boolean
isCopyHideLocation	boolean
isCopyAttendanceRules	boolean
isCopyDays	boolean
isCopyGradeBook	boolean
isCopySecondaryInstructor	boolean
targetTermID	number <int32>
isCopyRooms	boolean
isCopyTimes	boolean
isCopyInstructor	boolean
isCopyWaitList	boolean
isCopyLmsVendor	boolean
isCopyCourseFeeSchedule	boolean
isCopyCourseSharingCampuses	boolean
isCopyMaxCourseSections	boolean
isCopyBookList	boolean
isCopyDocuments	boolean
isVariableCredits	boolean
isInstructorAttributes	boolean
defaultInstructorId	number <int32>
isAutoAdded	boolean
isValidationMessageDisplayed	boolean
isOnlyValidation	boolean
	Array of objects (cmc-nexus-academics-services-extendedProperty)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"sourceTermId": 0,
"id": 0,
"newSectionCode": "string",
"courseId": 0,
"campusId": 0,
"isCopyHideFaculty": true,
"isCopyHideLocation": true,
"isCopyAttendanceRules": true,
"isCopyDays": true,
"isCopyGradeBook": true,
"isCopySecondaryInstructor": true,
"targetTermID": 0,
"isCopyRooms": true,
"isCopyTimes": true,
"isCopyInstructor": true,
"isCopyWaitList": true,
"isCopyLmsVendor": true,
"isCopyCourseFeeSchedule": true,
"isCopyCourseSharingCampuses": true,
"isCopyMaxCourseSections": true,
"isCopyBookList": true,
"isCopyDocuments": true,
"isVariableCredits": true,
"isInstructorAttributes": true,
"defaultInstructorId": 0,
"isAutoAdded": true,
"isValidationMessageDisplayed": true,
"isOnlyValidation": true,
"extendedPropertyList": [{"name": "string",
"isExtendedProperty": true
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"newClassSectionId": 0,
"isOverrideCourseComparison": true,
"isBelowCourseContactHrsMsg": true,
"isBelowCourseContactHrsMsgConfirmation": true,
"isValidationMessageDisplayed": true,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Create Class Section

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"isUpdateStudentSchedules": true,
"isUpdateStudentSchedulesConfirmation": true,
"isUpdateStudentSchedulesConfirmationProvided": true,
"isSchedulePeriodDeleteConfirmation": true,
"cantDeleteTerms": "string",
"updateStudentsInCourseSection": true,
"scheduleStartDate": "2019-08-24T14:15:22Z",
"scheduleEndDate": "2019-08-24T14:15:22Z",
"crsgCrossReferenceCampuses": [{"id": 0,
"isCRSG": true,
"name": "string"
}
],
"isContactHoursConfirmed": true,
"isRequireLDAConfirmed": true,
"requireContactHoursConfirmation": true,
"requireLDAConfirmation": true,
"isRequireChangeInWlmAssignment": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"addedClassSectionId": 0,
"allowCreditsHoursOverride": true,
"allowReservations": true,
"attendanceLastPostedDate": "2019-08-24T14:15:22Z",
"autoDropConsecutiveHoursAbsent": 0,
"autoDropCumulativeHoursAbsent": 0,
"autoDropPercentageHoursAbsent": 0,
"autoWarningConsecutiveHoursAbsent": 0,
"autoWarningCumulativeHoursAbsent": 0,
"autoWarningPercentageHoursAbsent": 0,
"campusId": 0,
"classSchedLength": 0,
"clockHours": 0,
"courseCode": "string",
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"daysFlag": 0,
"deliveryMethodId": 0,
"dropEndDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"finalCountDropStudents": 0,
"finalCountRegisteredStudents": 0,
"hideFaculty": true,
"hideLocation": true,
"instructorId": 0,
"isActive": true,
"isAddDropDateOverride": true,
"isAuditAdvisementRequired": true,
"isAutoDropEnforcedAfterLdw": true,
"isAutoWarningOnClassRosterAfterLdw": true,
"isBlindGrading": true,
"isCancelled": true,
"isClassSectionAutoAdded": true,
"isLdwOverride": true,
"isMeetingOnIrregularDaysTimes": true,
"isStudentSpecificMeetingSchedule": true,
"isWaitlistExpiredOrCleared": true,
"isWaitListingAllowed": true,
"lastDayToWithdrawDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lmsExtractStatus": "string",
"lmsVendorId": 0,
"loadMethod": "string",
"makeUpMaxType": "string",
"makeUpMaxValue": 0,
"maximumCredits": 0,
"maximumStudents": 0,
"maxNumberAssignments": 0,
"maxNumberSectionsAllowed": 0,
"minimumCredits": 0,
"nextAttendanceDate": "2019-08-24T14:15:22Z",
"note": "string",
"numberRegisteredStudents": 0,
"passFailSetting": { },
"postAttendanceType": "string",
"rowVersion": "string",
"secondSectionCode": "string",
"sectionCode": "string",
"sectionName": "string",
"sendToLms": true,
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"studentSpecificMeetingScheduleDefaultMinutes": 0,
"syllabusDocument": "string",
"thresholdNumberOfSeats": { },
"thresholdType": true,
"unregisterEndDate": "2019-08-24T14:15:22Z",
"waitListMaximumSeats": 0,
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"meetingPatterns": [{"meetingPattern": {"id": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"frequency": { },
"isMeetingOnFriday": true,
"isMeetingOnMonday": true,
"isMeetingOnSaturday": true,
"isMeetingOnSunday": true,
"isMeetingOnThursday": true,
"isMeetingOnTuesday": true,
"isMeetingOnWednesday": true,
"isRecurrenceEnding": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingLength": { },
"patternType": "string",
"recurrenceEndNumber": { },
"recurrenceStartWeeks": { },
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"dayOfWeekRooms": [{"dayOfWeek": 0,
"roomId": 0,
"roomCode": "string",
"roomName": "string",
"buildingId": 0,
"buildingCode": "string",
"buildingName": "string",
"locationId": 0,
"locationName": "string"
}
],
"isConflict": true,
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingPatternId": 0,
"rowVersion": "string",
"type": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"terms": [{"termName": "string",
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Class Section

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-delete-request-payload)

isUpdateStudentSchedules	boolean
isUpdateStudentSchedulesConfirmation	boolean
isUpdateStudentSchedulesConfirmationProvided	boolean
isSchedulePeriodDeleteConfirmation	boolean
cantDeleteTerms	string
updateStudentsInCourseSection	boolean
scheduleStartDate	string <date-time>
scheduleEndDate	string <date-time>
	Array of objects (cmc-nexus-academics-entities-crsgCrossReferenceCampus)
isContactHoursConfirmed	boolean
isRequireLDAConfirmed	boolean
requireContactHoursConfirmation	boolean
requireLDAConfirmation	boolean
isRequireChangeInWlmAssignment	boolean
id	number <int32> Id
addDropDate	string <date-time> Add Drop Date
addedClassSectionId	number <int32> Added Class Section Id
allowCreditsHoursOverride	boolean Allow Credits Hours Override
allowReservations	boolean Allow Reservations
attendanceLastPostedDate	string <date-time> Attendance Last Posted Date
autoDropConsecutiveHoursAbsent	number <double> Auto Drop Consecutive Hours Absent
autoDropCumulativeHoursAbsent	number <double> Auto Drop Cumulative Hours Absent
autoDropPercentageHoursAbsent	number <double> Auto Drop Percentage Hours Absent
autoWarningConsecutiveHoursAbsent	number <double> Auto Warning Consecutive Hours Absent
autoWarningCumulativeHoursAbsent	number <double> Auto Warning Cumulative Hours Absent
autoWarningPercentageHoursAbsent	number <double> Auto Warning Percentage Hours Absent
campusId	number <int32> Campus Id
classSchedLength	number <int32> Class Sched Length
clockHours	number <double> Clock Hours
courseCode	string Course Code
courseId	number <int32> Course Id
createdDateTime	string <date-time> Created Date Time
creditHours	number <double> Credit Hours
daysFlag	number <int32> Days Flag
deliveryMethodId	number <int32> Delivery Method Id
dropEndDate	string <date-time> Drop End Date
endDate	string <date-time> End Date
enrollmentStatusClockHours	number <double> Enrollment Status Clock Hours
enrollmentStatusCreditHours	number <double> Enrollment Status Credit Hours
finalCountDropStudents	number <int32> Final Count Drop Students
finalCountRegisteredStudents	number <int32> Final Count Registered Students
hideFaculty	boolean Hide Faculty
hideLocation	boolean Hide Location
instructorId	number <int32> Instructor Id
isActive	boolean Is Active
isAddDropDateOverride	boolean Is Add Drop Date Override
isAuditAdvisementRequired	boolean Is Audit Advisement Required
isAutoDropEnforcedAfterLdw	boolean Is Auto Drop Enforced After Ldw
isAutoWarningOnClassRosterAfterLdw	boolean Is Auto Warning On Class Roster After Ldw
isBlindGrading	boolean Is Blind Grading
isCancelled	boolean Is Cancelled
isClassSectionAutoAdded	boolean Is Class Section Auto Added
isLdwOverride	boolean Is Ldw Override
isMeetingOnIrregularDaysTimes	boolean Is Meeting On Irregular Days Times
isStudentSpecificMeetingSchedule	boolean Is Student Specific Meeting Schedule
isWaitlistExpiredOrCleared	boolean Is Waitlist Expired Or Cleared
isWaitListingAllowed	boolean Is Wait Listing Allowed
lastDayToWithdrawDate	string <date-time> Last Day To Withdraw Date
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
lmsExtractStatus	string Lms Extract Status
lmsVendorId	number <int32> Lms Vendor Id
loadMethod	string Load Method
makeUpMaxType	string Make Up Max Type
makeUpMaxValue	number <double> Make Up Max Value
maximumCredits	number <double> Maximum Credits
maximumStudents	number <int32> Maximum Students
maxNumberAssignments	number <int32> Max Number Assignments
maxNumberSectionsAllowed	number <int32> Max Number Sections Allowed
minimumCredits	number <double> Minimum Credits
nextAttendanceDate	string <date-time> Next Attendance Date
note	string Note
numberRegisteredStudents	number <int32> Number Registered Students
passFailSetting	object Pass Fail Setting
postAttendanceType	string Post Attendance Type
rowVersion	string
secondSectionCode	string Second Section Code
sectionCode	string Section Code
sectionName	string Section Name
sendToLms	boolean Send To Lms
shiftId	number <int32> Shift Id
startDate	string <date-time> Start Date
startTime	string <date-time> Start Time
studentSpecificMeetingScheduleDefaultMinutes	number <int32> Student Specific Meeting Schedule Default Minutes
syllabusDocument	string Syllabus Document
thresholdNumberOfSeats	object Threshold Number Of Seats
thresholdType	boolean Threshold Type
unregisterEndDate	string <date-time> Unregister End Date
waitListMaximumSeats	number <int32> Wait List Maximum Seats
wlmActivityTypeId	number <int32> Wlm Activity Type Id
wlmAssignmentTypeId	number <int32> Wlm Assignment Type Id
wlmDepartmentId	number <int32> Wlm Department Id
	Array of objects (cmc-nexus-academics-entities-classSectionMeetingPatternEntity)
	Array of objects (cmc-nexus-academics-entities-classSectionTermEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isUpdateStudentSchedules": true,
"isUpdateStudentSchedulesConfirmation": true,
"isUpdateStudentSchedulesConfirmationProvided": true,
"isSchedulePeriodDeleteConfirmation": true,
"cantDeleteTerms": "string",
"updateStudentsInCourseSection": true,
"scheduleStartDate": "2019-08-24T14:15:22Z",
"scheduleEndDate": "2019-08-24T14:15:22Z",
"crsgCrossReferenceCampuses": [{"id": 0,
"isCRSG": true,
"name": "string"
}
],
"isContactHoursConfirmed": true,
"isRequireLDAConfirmed": true,
"requireContactHoursConfirmation": true,
"requireLDAConfirmation": true,
"isRequireChangeInWlmAssignment": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"addedClassSectionId": 0,
"allowCreditsHoursOverride": true,
"allowReservations": true,
"attendanceLastPostedDate": "2019-08-24T14:15:22Z",
"autoDropConsecutiveHoursAbsent": 0,
"autoDropCumulativeHoursAbsent": 0,
"autoDropPercentageHoursAbsent": 0,
"autoWarningConsecutiveHoursAbsent": 0,
"autoWarningCumulativeHoursAbsent": 0,
"autoWarningPercentageHoursAbsent": 0,
"campusId": 0,
"classSchedLength": 0,
"clockHours": 0,
"courseCode": "string",
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"daysFlag": 0,
"deliveryMethodId": 0,
"dropEndDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"finalCountDropStudents": 0,
"finalCountRegisteredStudents": 0,
"hideFaculty": true,
"hideLocation": true,
"instructorId": 0,
"isActive": true,
"isAddDropDateOverride": true,
"isAuditAdvisementRequired": true,
"isAutoDropEnforcedAfterLdw": true,
"isAutoWarningOnClassRosterAfterLdw": true,
"isBlindGrading": true,
"isCancelled": true,
"isClassSectionAutoAdded": true,
"isLdwOverride": true,
"isMeetingOnIrregularDaysTimes": true,
"isStudentSpecificMeetingSchedule": true,
"isWaitlistExpiredOrCleared": true,
"isWaitListingAllowed": true,
"lastDayToWithdrawDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lmsExtractStatus": "string",
"lmsVendorId": 0,
"loadMethod": "string",
"makeUpMaxType": "string",
"makeUpMaxValue": 0,
"maximumCredits": 0,
"maximumStudents": 0,
"maxNumberAssignments": 0,
"maxNumberSectionsAllowed": 0,
"minimumCredits": 0,
"nextAttendanceDate": "2019-08-24T14:15:22Z",
"note": "string",
"numberRegisteredStudents": 0,
"passFailSetting": { },
"postAttendanceType": "string",
"rowVersion": "string",
"secondSectionCode": "string",
"sectionCode": "string",
"sectionName": "string",
"sendToLms": true,
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"studentSpecificMeetingScheduleDefaultMinutes": 0,
"syllabusDocument": "string",
"thresholdNumberOfSeats": { },
"thresholdType": true,
"unregisterEndDate": "2019-08-24T14:15:22Z",
"waitListMaximumSeats": 0,
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"meetingPatterns": [{"meetingPattern": {"id": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"frequency": { },
"isMeetingOnFriday": true,
"isMeetingOnMonday": true,
"isMeetingOnSaturday": true,
"isMeetingOnSunday": true,
"isMeetingOnThursday": true,
"isMeetingOnTuesday": true,
"isMeetingOnWednesday": true,
"isRecurrenceEnding": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingLength": { },
"patternType": "string",
"recurrenceEndNumber": { },
"recurrenceStartWeeks": { },
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"dayOfWeekRooms": [{"dayOfWeek": 0,
"roomId": 0,
"roomCode": "string",
"roomName": "string",
"buildingId": 0,
"buildingCode": "string",
"buildingName": "string",
"locationId": 0,
"locationName": "string"
}
],
"isConflict": true,
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingPatternId": 0,
"rowVersion": "string",
"type": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"terms": [{"termName": "string",
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Class Section

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isUpdateStudentSchedules": true,
"isUpdateStudentSchedulesConfirmation": true,
"isUpdateStudentSchedulesConfirmationProvided": true,
"isSchedulePeriodDeleteConfirmation": true,
"cantDeleteTerms": "string",
"updateStudentsInCourseSection": true,
"scheduleStartDate": "2019-08-24T14:15:22Z",
"scheduleEndDate": "2019-08-24T14:15:22Z",
"crsgCrossReferenceCampuses": [{"id": 0,
"isCRSG": true,
"name": "string"
}
],
"isContactHoursConfirmed": true,
"isRequireLDAConfirmed": true,
"requireContactHoursConfirmation": true,
"requireLDAConfirmation": true,
"isRequireChangeInWlmAssignment": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"addedClassSectionId": 0,
"allowCreditsHoursOverride": true,
"allowReservations": true,
"attendanceLastPostedDate": "2019-08-24T14:15:22Z",
"autoDropConsecutiveHoursAbsent": 0,
"autoDropCumulativeHoursAbsent": 0,
"autoDropPercentageHoursAbsent": 0,
"autoWarningConsecutiveHoursAbsent": 0,
"autoWarningCumulativeHoursAbsent": 0,
"autoWarningPercentageHoursAbsent": 0,
"campusId": 0,
"classSchedLength": 0,
"clockHours": 0,
"courseCode": "string",
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"daysFlag": 0,
"deliveryMethodId": 0,
"dropEndDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"finalCountDropStudents": 0,
"finalCountRegisteredStudents": 0,
"hideFaculty": true,
"hideLocation": true,
"instructorId": 0,
"isActive": true,
"isAddDropDateOverride": true,
"isAuditAdvisementRequired": true,
"isAutoDropEnforcedAfterLdw": true,
"isAutoWarningOnClassRosterAfterLdw": true,
"isBlindGrading": true,
"isCancelled": true,
"isClassSectionAutoAdded": true,
"isLdwOverride": true,
"isMeetingOnIrregularDaysTimes": true,
"isStudentSpecificMeetingSchedule": true,
"isWaitlistExpiredOrCleared": true,
"isWaitListingAllowed": true,
"lastDayToWithdrawDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lmsExtractStatus": "string",
"lmsVendorId": 0,
"loadMethod": "string",
"makeUpMaxType": "string",
"makeUpMaxValue": 0,
"maximumCredits": 0,
"maximumStudents": 0,
"maxNumberAssignments": 0,
"maxNumberSectionsAllowed": 0,
"minimumCredits": 0,
"nextAttendanceDate": "2019-08-24T14:15:22Z",
"note": "string",
"numberRegisteredStudents": 0,
"passFailSetting": { },
"postAttendanceType": "string",
"rowVersion": "string",
"secondSectionCode": "string",
"sectionCode": "string",
"sectionName": "string",
"sendToLms": true,
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"studentSpecificMeetingScheduleDefaultMinutes": 0,
"syllabusDocument": "string",
"thresholdNumberOfSeats": { },
"thresholdType": true,
"unregisterEndDate": "2019-08-24T14:15:22Z",
"waitListMaximumSeats": 0,
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"meetingPatterns": [{"meetingPattern": {"id": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"frequency": { },
"isMeetingOnFriday": true,
"isMeetingOnMonday": true,
"isMeetingOnSaturday": true,
"isMeetingOnSunday": true,
"isMeetingOnThursday": true,
"isMeetingOnTuesday": true,
"isMeetingOnWednesday": true,
"isRecurrenceEnding": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingLength": { },
"patternType": "string",
"recurrenceEndNumber": { },
"recurrenceStartWeeks": { },
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"dayOfWeekRooms": [{"dayOfWeek": 0,
"roomId": 0,
"roomCode": "string",
"roomName": "string",
"buildingId": 0,
"buildingCode": "string",
"buildingName": "string",
"locationId": 0,
"locationName": "string"
}
],
"isConflict": true,
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingPatternId": 0,
"rowVersion": "string",
"type": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"terms": [{"termName": "string",
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Class Section Documents

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-getclasssectiondocuments-request-payload)

classSectionId

number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"documents": [{"code": "string",
"name": "string",
"id": 0
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Class Section Header

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-getclasssectionheader-request-payload)

classSectionId

number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"termName": "string",
"termDates": "string",
"instructorName": "string",
"classSectionDates": "string",
"buildingName": "string",
"roomName": "string",
"deliveryMethodName": "string",
"shiftName": "string",
"maximumStudents": 0,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Class Section Lms Options

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-getclasssectionlmsoptions-request-payload)

classSectionId

number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"lmsVendorId": 0,
"lmsExtractStatus": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Class Section Periods

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-getclasssectionperiods-request-payload)

classSectionId	number <int32>
isRequestFromUnitTest	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionId": 0,
"isRequestFromUnitTest": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"meetingPatterns": [{"meetingPattern": {"id": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"frequency": { },
"isMeetingOnFriday": true,
"isMeetingOnMonday": true,
"isMeetingOnSaturday": true,
"isMeetingOnSunday": true,
"isMeetingOnThursday": true,
"isMeetingOnTuesday": true,
"isMeetingOnWednesday": true,
"isRecurrenceEnding": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingLength": { },
"patternType": "string",
"recurrenceEndNumber": { },
"recurrenceStartWeeks": { },
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"dayOfWeekRooms": [{"dayOfWeek": 0,
"roomId": 0,
"roomCode": "string",
"roomName": "string",
"buildingId": 0,
"buildingCode": "string",
"buildingName": "string",
"locationId": 0,
"locationName": "string"
}
],
"isConflict": true,
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingPatternId": 0,
"rowVersion": "string",
"type": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Class Sections With Max Class Size Exceed

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-getclasssectionswithmaxclasssizeexceed-request-payload)

registrationTrackId	number <int32>
studentGroupId	number <int32>
schoolDefinedFieldId	number <int32>
isActiveOnly	boolean
studentIds	object

Responses

Request samples

Payload

Content type

application/json

{"payload": {"registrationTrackId": 0,
"studentGroupId": 0,
"schoolDefinedFieldId": 0,
"isActiveOnly": true,
"studentIds": { }
}
}

Response samples

Content type

application/json

{"payload": {"data": {"classSections": [{"id": 0,
"courseId": 0,
"courseName": "string",
"sectionCode": "string",
"seatsAvailable": 0,
"maximumClassSectionSize": 0
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Course Fee Schedule

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-getcoursefeeschedule-request-payload)

classSectionId	number <int32>
courseId	number <int32>
deliveryMethodId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionId": 0,
"courseId": 0,
"deliveryMethodId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"classSectionFees": [{"id": 0,
"code": "string",
"name": "string",
"classSectionFeeScheduleId": 0,
"deliveryMethodId": 0,
"courseId": 0,
"effectiveDate": "2019-08-24T14:15:22Z",
"isDefault": true,
"isViewable": true,
"deliveryMethod": {"id": 0,
"code": "string",
"name": "string"
},
"courseFees": [{"id": 0,
"courseId": 0,
"billingTransactionCodeId": 0,
"courseFeeScheduleId": 0,
"sequence": 0,
"amount": 0,
"auditCourseAmount": 0,
"effectiveDate": "2019-08-24T14:15:22Z",
"billingTransactionName": "string"
}
]
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Dependent Courses Class Sections

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-getdependentcoursesclasssections-request-payload)

courseId	number <int32>
termIds	Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"payload": {"courseId": 0,
"termIds": [0
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"classSectionIds": [0
],
"isDependentCourse": true,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Instructors And Portal Options

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-getinstructorsandportaloptions-request-payload)

classSectionId

number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"instructors": [{"id": 0,
"code": "string",
"name": "string",
"displayOrder": 0,
"isPrimaryInstructor": true,
"attributes": [{"id": 0,
"code": "string",
"name": "string"
}
],
"inactiveAttributes": [{"id": 0,
"code": "string",
"name": "string"
}
],
"canPostAttendance": true,
"canPostLessons": true,
"canPostFinalGrades": true,
"instructorAttributes": [{"id": 0,
"code": "string",
"name": "string"
}
]
}
],
"hideFaculty": true,
"hideLocation": true,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Reinstate Class Section

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-reinstateclasssection-request-payload)

classSectionId

number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"classSectionId": 0,
"isActive": true,
"isCancel": true,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Class Section

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-save-request-payload)

isUpdateStudentSchedules	boolean
isUpdateStudentSchedulesConfirmation	boolean
isUpdateStudentSchedulesConfirmationProvided	boolean
isSchedulePeriodDeleteConfirmation	boolean
cantDeleteTerms	string
updateStudentsInCourseSection	boolean
scheduleStartDate	string <date-time>
scheduleEndDate	string <date-time>
	Array of objects (cmc-nexus-academics-entities-crsgCrossReferenceCampus)
isContactHoursConfirmed	boolean
isRequireLDAConfirmed	boolean
requireContactHoursConfirmation	boolean
requireLDAConfirmation	boolean
isRequireChangeInWlmAssignment	boolean
id	number <int32> Id
addDropDate	string <date-time> Add Drop Date
addedClassSectionId	number <int32> Added Class Section Id
allowCreditsHoursOverride	boolean Allow Credits Hours Override
allowReservations	boolean Allow Reservations
attendanceLastPostedDate	string <date-time> Attendance Last Posted Date
autoDropConsecutiveHoursAbsent	number <double> Auto Drop Consecutive Hours Absent
autoDropCumulativeHoursAbsent	number <double> Auto Drop Cumulative Hours Absent
autoDropPercentageHoursAbsent	number <double> Auto Drop Percentage Hours Absent
autoWarningConsecutiveHoursAbsent	number <double> Auto Warning Consecutive Hours Absent
autoWarningCumulativeHoursAbsent	number <double> Auto Warning Cumulative Hours Absent
autoWarningPercentageHoursAbsent	number <double> Auto Warning Percentage Hours Absent
campusId	number <int32> Campus Id
classSchedLength	number <int32> Class Sched Length
clockHours	number <double> Clock Hours
courseCode	string Course Code
courseId	number <int32> Course Id
createdDateTime	string <date-time> Created Date Time
creditHours	number <double> Credit Hours
daysFlag	number <int32> Days Flag
deliveryMethodId	number <int32> Delivery Method Id
dropEndDate	string <date-time> Drop End Date
endDate	string <date-time> End Date
enrollmentStatusClockHours	number <double> Enrollment Status Clock Hours
enrollmentStatusCreditHours	number <double> Enrollment Status Credit Hours
finalCountDropStudents	number <int32> Final Count Drop Students
finalCountRegisteredStudents	number <int32> Final Count Registered Students
hideFaculty	boolean Hide Faculty
hideLocation	boolean Hide Location
instructorId	number <int32> Instructor Id
isActive	boolean Is Active
isAddDropDateOverride	boolean Is Add Drop Date Override
isAuditAdvisementRequired	boolean Is Audit Advisement Required
isAutoDropEnforcedAfterLdw	boolean Is Auto Drop Enforced After Ldw
isAutoWarningOnClassRosterAfterLdw	boolean Is Auto Warning On Class Roster After Ldw
isBlindGrading	boolean Is Blind Grading
isCancelled	boolean Is Cancelled
isClassSectionAutoAdded	boolean Is Class Section Auto Added
isLdwOverride	boolean Is Ldw Override
isMeetingOnIrregularDaysTimes	boolean Is Meeting On Irregular Days Times
isStudentSpecificMeetingSchedule	boolean Is Student Specific Meeting Schedule
isWaitlistExpiredOrCleared	boolean Is Waitlist Expired Or Cleared
isWaitListingAllowed	boolean Is Wait Listing Allowed
lastDayToWithdrawDate	string <date-time> Last Day To Withdraw Date
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
lmsExtractStatus	string Lms Extract Status
lmsVendorId	number <int32> Lms Vendor Id
loadMethod	string Load Method
makeUpMaxType	string Make Up Max Type
makeUpMaxValue	number <double> Make Up Max Value
maximumCredits	number <double> Maximum Credits
maximumStudents	number <int32> Maximum Students
maxNumberAssignments	number <int32> Max Number Assignments
maxNumberSectionsAllowed	number <int32> Max Number Sections Allowed
minimumCredits	number <double> Minimum Credits
nextAttendanceDate	string <date-time> Next Attendance Date
note	string Note
numberRegisteredStudents	number <int32> Number Registered Students
passFailSetting	object Pass Fail Setting
postAttendanceType	string Post Attendance Type
rowVersion	string
secondSectionCode	string Second Section Code
sectionCode	string Section Code
sectionName	string Section Name
sendToLms	boolean Send To Lms
shiftId	number <int32> Shift Id
startDate	string <date-time> Start Date
startTime	string <date-time> Start Time
studentSpecificMeetingScheduleDefaultMinutes	number <int32> Student Specific Meeting Schedule Default Minutes
syllabusDocument	string Syllabus Document
thresholdNumberOfSeats	object Threshold Number Of Seats
thresholdType	boolean Threshold Type
unregisterEndDate	string <date-time> Unregister End Date
waitListMaximumSeats	number <int32> Wait List Maximum Seats
wlmActivityTypeId	number <int32> Wlm Activity Type Id
wlmAssignmentTypeId	number <int32> Wlm Assignment Type Id
wlmDepartmentId	number <int32> Wlm Department Id
	Array of objects (cmc-nexus-academics-entities-classSectionMeetingPatternEntity)
	Array of objects (cmc-nexus-academics-entities-classSectionTermEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isUpdateStudentSchedules": true,
"isUpdateStudentSchedulesConfirmation": true,
"isUpdateStudentSchedulesConfirmationProvided": true,
"isSchedulePeriodDeleteConfirmation": true,
"cantDeleteTerms": "string",
"updateStudentsInCourseSection": true,
"scheduleStartDate": "2019-08-24T14:15:22Z",
"scheduleEndDate": "2019-08-24T14:15:22Z",
"crsgCrossReferenceCampuses": [{"id": 0,
"isCRSG": true,
"name": "string"
}
],
"isContactHoursConfirmed": true,
"isRequireLDAConfirmed": true,
"requireContactHoursConfirmation": true,
"requireLDAConfirmation": true,
"isRequireChangeInWlmAssignment": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"addedClassSectionId": 0,
"allowCreditsHoursOverride": true,
"allowReservations": true,
"attendanceLastPostedDate": "2019-08-24T14:15:22Z",
"autoDropConsecutiveHoursAbsent": 0,
"autoDropCumulativeHoursAbsent": 0,
"autoDropPercentageHoursAbsent": 0,
"autoWarningConsecutiveHoursAbsent": 0,
"autoWarningCumulativeHoursAbsent": 0,
"autoWarningPercentageHoursAbsent": 0,
"campusId": 0,
"classSchedLength": 0,
"clockHours": 0,
"courseCode": "string",
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"daysFlag": 0,
"deliveryMethodId": 0,
"dropEndDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"finalCountDropStudents": 0,
"finalCountRegisteredStudents": 0,
"hideFaculty": true,
"hideLocation": true,
"instructorId": 0,
"isActive": true,
"isAddDropDateOverride": true,
"isAuditAdvisementRequired": true,
"isAutoDropEnforcedAfterLdw": true,
"isAutoWarningOnClassRosterAfterLdw": true,
"isBlindGrading": true,
"isCancelled": true,
"isClassSectionAutoAdded": true,
"isLdwOverride": true,
"isMeetingOnIrregularDaysTimes": true,
"isStudentSpecificMeetingSchedule": true,
"isWaitlistExpiredOrCleared": true,
"isWaitListingAllowed": true,
"lastDayToWithdrawDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lmsExtractStatus": "string",
"lmsVendorId": 0,
"loadMethod": "string",
"makeUpMaxType": "string",
"makeUpMaxValue": 0,
"maximumCredits": 0,
"maximumStudents": 0,
"maxNumberAssignments": 0,
"maxNumberSectionsAllowed": 0,
"minimumCredits": 0,
"nextAttendanceDate": "2019-08-24T14:15:22Z",
"note": "string",
"numberRegisteredStudents": 0,
"passFailSetting": { },
"postAttendanceType": "string",
"rowVersion": "string",
"secondSectionCode": "string",
"sectionCode": "string",
"sectionName": "string",
"sendToLms": true,
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"studentSpecificMeetingScheduleDefaultMinutes": 0,
"syllabusDocument": "string",
"thresholdNumberOfSeats": { },
"thresholdType": true,
"unregisterEndDate": "2019-08-24T14:15:22Z",
"waitListMaximumSeats": 0,
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"meetingPatterns": [{"meetingPattern": {"id": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"frequency": { },
"isMeetingOnFriday": true,
"isMeetingOnMonday": true,
"isMeetingOnSaturday": true,
"isMeetingOnSunday": true,
"isMeetingOnThursday": true,
"isMeetingOnTuesday": true,
"isMeetingOnWednesday": true,
"isRecurrenceEnding": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingLength": { },
"patternType": "string",
"recurrenceEndNumber": { },
"recurrenceStartWeeks": { },
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"dayOfWeekRooms": [{"dayOfWeek": 0,
"roomId": 0,
"roomCode": "string",
"roomName": "string",
"buildingId": 0,
"buildingCode": "string",
"buildingName": "string",
"locationId": 0,
"locationName": "string"
}
],
"isConflict": true,
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingPatternId": 0,
"rowVersion": "string",
"type": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"terms": [{"termName": "string",
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isUpdateStudentSchedules": true,
"isUpdateStudentSchedulesConfirmation": true,
"isUpdateStudentSchedulesConfirmationProvided": true,
"isSchedulePeriodDeleteConfirmation": true,
"cantDeleteTerms": "string",
"updateStudentsInCourseSection": true,
"scheduleStartDate": "2019-08-24T14:15:22Z",
"scheduleEndDate": "2019-08-24T14:15:22Z",
"crsgCrossReferenceCampuses": [{"id": 0,
"isCRSG": true,
"name": "string"
}
],
"isContactHoursConfirmed": true,
"isRequireLDAConfirmed": true,
"requireContactHoursConfirmation": true,
"requireLDAConfirmation": true,
"isRequireChangeInWlmAssignment": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"addedClassSectionId": 0,
"allowCreditsHoursOverride": true,
"allowReservations": true,
"attendanceLastPostedDate": "2019-08-24T14:15:22Z",
"autoDropConsecutiveHoursAbsent": 0,
"autoDropCumulativeHoursAbsent": 0,
"autoDropPercentageHoursAbsent": 0,
"autoWarningConsecutiveHoursAbsent": 0,
"autoWarningCumulativeHoursAbsent": 0,
"autoWarningPercentageHoursAbsent": 0,
"campusId": 0,
"classSchedLength": 0,
"clockHours": 0,
"courseCode": "string",
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"daysFlag": 0,
"deliveryMethodId": 0,
"dropEndDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"finalCountDropStudents": 0,
"finalCountRegisteredStudents": 0,
"hideFaculty": true,
"hideLocation": true,
"instructorId": 0,
"isActive": true,
"isAddDropDateOverride": true,
"isAuditAdvisementRequired": true,
"isAutoDropEnforcedAfterLdw": true,
"isAutoWarningOnClassRosterAfterLdw": true,
"isBlindGrading": true,
"isCancelled": true,
"isClassSectionAutoAdded": true,
"isLdwOverride": true,
"isMeetingOnIrregularDaysTimes": true,
"isStudentSpecificMeetingSchedule": true,
"isWaitlistExpiredOrCleared": true,
"isWaitListingAllowed": true,
"lastDayToWithdrawDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lmsExtractStatus": "string",
"lmsVendorId": 0,
"loadMethod": "string",
"makeUpMaxType": "string",
"makeUpMaxValue": 0,
"maximumCredits": 0,
"maximumStudents": 0,
"maxNumberAssignments": 0,
"maxNumberSectionsAllowed": 0,
"minimumCredits": 0,
"nextAttendanceDate": "2019-08-24T14:15:22Z",
"note": "string",
"numberRegisteredStudents": 0,
"passFailSetting": { },
"postAttendanceType": "string",
"rowVersion": "string",
"secondSectionCode": "string",
"sectionCode": "string",
"sectionName": "string",
"sendToLms": true,
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"studentSpecificMeetingScheduleDefaultMinutes": 0,
"syllabusDocument": "string",
"thresholdNumberOfSeats": { },
"thresholdType": true,
"unregisterEndDate": "2019-08-24T14:15:22Z",
"waitListMaximumSeats": 0,
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"meetingPatterns": [{"meetingPattern": {"id": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"frequency": { },
"isMeetingOnFriday": true,
"isMeetingOnMonday": true,
"isMeetingOnSaturday": true,
"isMeetingOnSunday": true,
"isMeetingOnThursday": true,
"isMeetingOnTuesday": true,
"isMeetingOnWednesday": true,
"isRecurrenceEnding": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingLength": { },
"patternType": "string",
"recurrenceEndNumber": { },
"recurrenceStartWeeks": { },
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"dayOfWeekRooms": [{"dayOfWeek": 0,
"roomId": 0,
"roomCode": "string",
"roomName": "string",
"buildingId": 0,
"buildingCode": "string",
"buildingName": "string",
"locationId": 0,
"locationName": "string"
}
],
"isConflict": true,
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingPatternId": 0,
"rowVersion": "string",
"type": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"terms": [{"termName": "string",
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Books

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-savebooks-request-payload)

	Array of objects (cmc-nexus-academics-entities-classSectionBookEntity)
classSectionId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"books": [{"id": 0,
"bookId": 0,
"classSectionId": 0,
"courseBookListId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isRequired": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"classSectionId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Class Section Documents

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-saveclasssectiondocuments-request-payload)

classSectionId	number <int32>
documentTypeIds	Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionId": 0,
"documentTypeIds": [0
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Class Section Lms Options

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-saveclasssectionlmsoptions-request-payload)

classSectionId	number <int32>
lmsVendorId	number <int32>
lmsExtractStatus	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionId": 0,
"lmsVendorId": 0,
"lmsExtractStatus": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Class Section Periods

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-saveclasssectionperiods-request-payload)

	Array of objects (cmc-nexus-academics-entities-classSectionMeetingPatternEntity)
classSectionId	number <int32>
	object (cmc-nexus-academics-entities-classSectionEntity)
isScheduleConflictsConfirmed	boolean
isContactHoursConfirmed	boolean
isRequireLDAConfirmed	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"meetingPatterns": [{"meetingPattern": {"id": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"frequency": { },
"isMeetingOnFriday": true,
"isMeetingOnMonday": true,
"isMeetingOnSaturday": true,
"isMeetingOnSunday": true,
"isMeetingOnThursday": true,
"isMeetingOnTuesday": true,
"isMeetingOnWednesday": true,
"isRecurrenceEnding": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingLength": { },
"patternType": "string",
"recurrenceEndNumber": { },
"recurrenceStartWeeks": { },
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"dayOfWeekRooms": [{"dayOfWeek": 0,
"roomId": 0,
"roomCode": "string",
"roomName": "string",
"buildingId": 0,
"buildingCode": "string",
"buildingName": "string",
"locationId": 0,
"locationName": "string"
}
],
"isConflict": true,
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingPatternId": 0,
"rowVersion": "string",
"type": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"classSectionId": 0,
"classSection": {"isUpdateStudentSchedules": true,
"isUpdateStudentSchedulesConfirmation": true,
"isUpdateStudentSchedulesConfirmationProvided": true,
"isSchedulePeriodDeleteConfirmation": true,
"cantDeleteTerms": "string",
"updateStudentsInCourseSection": true,
"scheduleStartDate": "2019-08-24T14:15:22Z",
"scheduleEndDate": "2019-08-24T14:15:22Z",
"crsgCrossReferenceCampuses": [{"id": 0,
"isCRSG": true,
"name": "string"
}
],
"isContactHoursConfirmed": true,
"isRequireLDAConfirmed": true,
"requireContactHoursConfirmation": true,
"requireLDAConfirmation": true,
"isRequireChangeInWlmAssignment": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"addedClassSectionId": 0,
"allowCreditsHoursOverride": true,
"allowReservations": true,
"attendanceLastPostedDate": "2019-08-24T14:15:22Z",
"autoDropConsecutiveHoursAbsent": 0,
"autoDropCumulativeHoursAbsent": 0,
"autoDropPercentageHoursAbsent": 0,
"autoWarningConsecutiveHoursAbsent": 0,
"autoWarningCumulativeHoursAbsent": 0,
"autoWarningPercentageHoursAbsent": 0,
"campusId": 0,
"classSchedLength": 0,
"clockHours": 0,
"courseCode": "string",
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"daysFlag": 0,
"deliveryMethodId": 0,
"dropEndDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"finalCountDropStudents": 0,
"finalCountRegisteredStudents": 0,
"hideFaculty": true,
"hideLocation": true,
"instructorId": 0,
"isActive": true,
"isAddDropDateOverride": true,
"isAuditAdvisementRequired": true,
"isAutoDropEnforcedAfterLdw": true,
"isAutoWarningOnClassRosterAfterLdw": true,
"isBlindGrading": true,
"isCancelled": true,
"isClassSectionAutoAdded": true,
"isLdwOverride": true,
"isMeetingOnIrregularDaysTimes": true,
"isStudentSpecificMeetingSchedule": true,
"isWaitlistExpiredOrCleared": true,
"isWaitListingAllowed": true,
"lastDayToWithdrawDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lmsExtractStatus": "string",
"lmsVendorId": 0,
"loadMethod": "string",
"makeUpMaxType": "string",
"makeUpMaxValue": 0,
"maximumCredits": 0,
"maximumStudents": 0,
"maxNumberAssignments": 0,
"maxNumberSectionsAllowed": 0,
"minimumCredits": 0,
"nextAttendanceDate": "2019-08-24T14:15:22Z",
"note": "string",
"numberRegisteredStudents": 0,
"passFailSetting": { },
"postAttendanceType": "string",
"rowVersion": "string",
"secondSectionCode": "string",
"sectionCode": "string",
"sectionName": "string",
"sendToLms": true,
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"studentSpecificMeetingScheduleDefaultMinutes": 0,
"syllabusDocument": "string",
"thresholdNumberOfSeats": { },
"thresholdType": true,
"unregisterEndDate": "2019-08-24T14:15:22Z",
"waitListMaximumSeats": 0,
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"meetingPatterns": [{"meetingPattern": {"id": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"frequency": { },
"isMeetingOnFriday": true,
"isMeetingOnMonday": true,
"isMeetingOnSaturday": true,
"isMeetingOnSunday": true,
"isMeetingOnThursday": true,
"isMeetingOnTuesday": true,
"isMeetingOnWednesday": true,
"isRecurrenceEnding": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingLength": { },
"patternType": "string",
"recurrenceEndNumber": { },
"recurrenceStartWeeks": { },
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"dayOfWeekRooms": [{"dayOfWeek": 0,
"roomId": 0,
"roomCode": "string",
"roomName": "string",
"buildingId": 0,
"buildingCode": "string",
"buildingName": "string",
"locationId": 0,
"locationName": "string"
}
],
"isConflict": true,
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingPatternId": 0,
"rowVersion": "string",
"type": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"terms": [{"termName": "string",
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"isScheduleConflictsConfirmed": true,
"isContactHoursConfirmed": true,
"isRequireLDAConfirmed": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"scheduleConflicts": [{"campus": "string",
"building": "string",
"room": "string",
"course": "string",
"section": "string",
"weekDay": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"conflictDate": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"dayNumber": { },
"adRoomID": 0,
"conflictType": "string"
}
],
"scheduleConflictsFound": true,
"requireContactHoursConfirmation": true,
"requireLDAConfirmation": true,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Course Fee Schedule

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-savecoursefeeschedule-request-payload)

classSectionId	number <int32>
courseId	number <int32>
deliveryMethodId	number <int32>
isAllowedOverrideDeliveryMethod	boolean
	Array of objects (cmc-nexus-academics-services-courseFeeScheduleList)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionId": 0,
"courseId": 0,
"deliveryMethodId": 0,
"isAllowedOverrideDeliveryMethod": true,
"classSectionFees": [{"id": 0,
"code": "string",
"name": "string",
"classSectionFeeScheduleId": 0,
"deliveryMethodId": 0,
"courseId": 0,
"effectiveDate": "2019-08-24T14:15:22Z",
"isDefault": true,
"isViewable": true,
"deliveryMethod": {"id": 0,
"code": "string",
"name": "string"
},
"courseFees": [{"id": 0,
"courseId": 0,
"billingTransactionCodeId": 0,
"courseFeeScheduleId": 0,
"sequence": 0,
"amount": 0,
"auditCourseAmount": 0,
"effectiveDate": "2019-08-24T14:15:22Z",
"billingTransactionName": "string"
}
]
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isAllowedOverrideDeliveryMethod": true,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Instructors And Portal Options

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-saveinstructorsandportaloptions-request-payload)

	Array of objects (cmc-nexus-academics-services-instructorsEntity)
classSectionId	number <int32>
hideFaculty	boolean
hideLocation	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"instructors": [{"id": 0,
"displayOrder": 0,
"canPostAttendance": true,
"canPostLessons": true,
"canPostFinalGrades": true,
"attributes": [0
]
}
],
"classSectionId": 0,
"hideFaculty": true,
"hideLocation": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Class Section

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-savenew-request-payload)

isUpdateStudentSchedules	boolean
isUpdateStudentSchedulesConfirmation	boolean
isUpdateStudentSchedulesConfirmationProvided	boolean
isSchedulePeriodDeleteConfirmation	boolean
cantDeleteTerms	string
updateStudentsInCourseSection	boolean
scheduleStartDate	string <date-time>
scheduleEndDate	string <date-time>
	Array of objects (cmc-nexus-academics-entities-crsgCrossReferenceCampus)
isContactHoursConfirmed	boolean
isRequireLDAConfirmed	boolean
requireContactHoursConfirmation	boolean
requireLDAConfirmation	boolean
isRequireChangeInWlmAssignment	boolean
id	number <int32> Id
addDropDate	string <date-time> Add Drop Date
addedClassSectionId	number <int32> Added Class Section Id
allowCreditsHoursOverride	boolean Allow Credits Hours Override
allowReservations	boolean Allow Reservations
attendanceLastPostedDate	string <date-time> Attendance Last Posted Date
autoDropConsecutiveHoursAbsent	number <double> Auto Drop Consecutive Hours Absent
autoDropCumulativeHoursAbsent	number <double> Auto Drop Cumulative Hours Absent
autoDropPercentageHoursAbsent	number <double> Auto Drop Percentage Hours Absent
autoWarningConsecutiveHoursAbsent	number <double> Auto Warning Consecutive Hours Absent
autoWarningCumulativeHoursAbsent	number <double> Auto Warning Cumulative Hours Absent
autoWarningPercentageHoursAbsent	number <double> Auto Warning Percentage Hours Absent
campusId	number <int32> Campus Id
classSchedLength	number <int32> Class Sched Length
clockHours	number <double> Clock Hours
courseCode	string Course Code
courseId	number <int32> Course Id
createdDateTime	string <date-time> Created Date Time
creditHours	number <double> Credit Hours
daysFlag	number <int32> Days Flag
deliveryMethodId	number <int32> Delivery Method Id
dropEndDate	string <date-time> Drop End Date
endDate	string <date-time> End Date
enrollmentStatusClockHours	number <double> Enrollment Status Clock Hours
enrollmentStatusCreditHours	number <double> Enrollment Status Credit Hours
finalCountDropStudents	number <int32> Final Count Drop Students
finalCountRegisteredStudents	number <int32> Final Count Registered Students
hideFaculty	boolean Hide Faculty
hideLocation	boolean Hide Location
instructorId	number <int32> Instructor Id
isActive	boolean Is Active
isAddDropDateOverride	boolean Is Add Drop Date Override
isAuditAdvisementRequired	boolean Is Audit Advisement Required
isAutoDropEnforcedAfterLdw	boolean Is Auto Drop Enforced After Ldw
isAutoWarningOnClassRosterAfterLdw	boolean Is Auto Warning On Class Roster After Ldw
isBlindGrading	boolean Is Blind Grading
isCancelled	boolean Is Cancelled
isClassSectionAutoAdded	boolean Is Class Section Auto Added
isLdwOverride	boolean Is Ldw Override
isMeetingOnIrregularDaysTimes	boolean Is Meeting On Irregular Days Times
isStudentSpecificMeetingSchedule	boolean Is Student Specific Meeting Schedule
isWaitlistExpiredOrCleared	boolean Is Waitlist Expired Or Cleared
isWaitListingAllowed	boolean Is Wait Listing Allowed
lastDayToWithdrawDate	string <date-time> Last Day To Withdraw Date
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
lmsExtractStatus	string Lms Extract Status
lmsVendorId	number <int32> Lms Vendor Id
loadMethod	string Load Method
makeUpMaxType	string Make Up Max Type
makeUpMaxValue	number <double> Make Up Max Value
maximumCredits	number <double> Maximum Credits
maximumStudents	number <int32> Maximum Students
maxNumberAssignments	number <int32> Max Number Assignments
maxNumberSectionsAllowed	number <int32> Max Number Sections Allowed
minimumCredits	number <double> Minimum Credits
nextAttendanceDate	string <date-time> Next Attendance Date
note	string Note
numberRegisteredStudents	number <int32> Number Registered Students
passFailSetting	object Pass Fail Setting
postAttendanceType	string Post Attendance Type
rowVersion	string
secondSectionCode	string Second Section Code
sectionCode	string Section Code
sectionName	string Section Name
sendToLms	boolean Send To Lms
shiftId	number <int32> Shift Id
startDate	string <date-time> Start Date
startTime	string <date-time> Start Time
studentSpecificMeetingScheduleDefaultMinutes	number <int32> Student Specific Meeting Schedule Default Minutes
syllabusDocument	string Syllabus Document
thresholdNumberOfSeats	object Threshold Number Of Seats
thresholdType	boolean Threshold Type
unregisterEndDate	string <date-time> Unregister End Date
waitListMaximumSeats	number <int32> Wait List Maximum Seats
wlmActivityTypeId	number <int32> Wlm Activity Type Id
wlmAssignmentTypeId	number <int32> Wlm Assignment Type Id
wlmDepartmentId	number <int32> Wlm Department Id
	Array of objects (cmc-nexus-academics-entities-classSectionMeetingPatternEntity)
	Array of objects (cmc-nexus-academics-entities-classSectionTermEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isUpdateStudentSchedules": true,
"isUpdateStudentSchedulesConfirmation": true,
"isUpdateStudentSchedulesConfirmationProvided": true,
"isSchedulePeriodDeleteConfirmation": true,
"cantDeleteTerms": "string",
"updateStudentsInCourseSection": true,
"scheduleStartDate": "2019-08-24T14:15:22Z",
"scheduleEndDate": "2019-08-24T14:15:22Z",
"crsgCrossReferenceCampuses": [{"id": 0,
"isCRSG": true,
"name": "string"
}
],
"isContactHoursConfirmed": true,
"isRequireLDAConfirmed": true,
"requireContactHoursConfirmation": true,
"requireLDAConfirmation": true,
"isRequireChangeInWlmAssignment": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"addedClassSectionId": 0,
"allowCreditsHoursOverride": true,
"allowReservations": true,
"attendanceLastPostedDate": "2019-08-24T14:15:22Z",
"autoDropConsecutiveHoursAbsent": 0,
"autoDropCumulativeHoursAbsent": 0,
"autoDropPercentageHoursAbsent": 0,
"autoWarningConsecutiveHoursAbsent": 0,
"autoWarningCumulativeHoursAbsent": 0,
"autoWarningPercentageHoursAbsent": 0,
"campusId": 0,
"classSchedLength": 0,
"clockHours": 0,
"courseCode": "string",
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"daysFlag": 0,
"deliveryMethodId": 0,
"dropEndDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"finalCountDropStudents": 0,
"finalCountRegisteredStudents": 0,
"hideFaculty": true,
"hideLocation": true,
"instructorId": 0,
"isActive": true,
"isAddDropDateOverride": true,
"isAuditAdvisementRequired": true,
"isAutoDropEnforcedAfterLdw": true,
"isAutoWarningOnClassRosterAfterLdw": true,
"isBlindGrading": true,
"isCancelled": true,
"isClassSectionAutoAdded": true,
"isLdwOverride": true,
"isMeetingOnIrregularDaysTimes": true,
"isStudentSpecificMeetingSchedule": true,
"isWaitlistExpiredOrCleared": true,
"isWaitListingAllowed": true,
"lastDayToWithdrawDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lmsExtractStatus": "string",
"lmsVendorId": 0,
"loadMethod": "string",
"makeUpMaxType": "string",
"makeUpMaxValue": 0,
"maximumCredits": 0,
"maximumStudents": 0,
"maxNumberAssignments": 0,
"maxNumberSectionsAllowed": 0,
"minimumCredits": 0,
"nextAttendanceDate": "2019-08-24T14:15:22Z",
"note": "string",
"numberRegisteredStudents": 0,
"passFailSetting": { },
"postAttendanceType": "string",
"rowVersion": "string",
"secondSectionCode": "string",
"sectionCode": "string",
"sectionName": "string",
"sendToLms": true,
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"studentSpecificMeetingScheduleDefaultMinutes": 0,
"syllabusDocument": "string",
"thresholdNumberOfSeats": { },
"thresholdType": true,
"unregisterEndDate": "2019-08-24T14:15:22Z",
"waitListMaximumSeats": 0,
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"meetingPatterns": [{"meetingPattern": {"id": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"frequency": { },
"isMeetingOnFriday": true,
"isMeetingOnMonday": true,
"isMeetingOnSaturday": true,
"isMeetingOnSunday": true,
"isMeetingOnThursday": true,
"isMeetingOnTuesday": true,
"isMeetingOnWednesday": true,
"isRecurrenceEnding": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingLength": { },
"patternType": "string",
"recurrenceEndNumber": { },
"recurrenceStartWeeks": { },
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"dayOfWeekRooms": [{"dayOfWeek": 0,
"roomId": 0,
"roomCode": "string",
"roomName": "string",
"buildingId": 0,
"buildingCode": "string",
"buildingName": "string",
"locationId": 0,
"locationName": "string"
}
],
"isConflict": true,
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingPatternId": 0,
"rowVersion": "string",
"type": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"terms": [{"termName": "string",
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isUpdateStudentSchedules": true,
"isUpdateStudentSchedulesConfirmation": true,
"isUpdateStudentSchedulesConfirmationProvided": true,
"isSchedulePeriodDeleteConfirmation": true,
"cantDeleteTerms": "string",
"updateStudentsInCourseSection": true,
"scheduleStartDate": "2019-08-24T14:15:22Z",
"scheduleEndDate": "2019-08-24T14:15:22Z",
"crsgCrossReferenceCampuses": [{"id": 0,
"isCRSG": true,
"name": "string"
}
],
"isContactHoursConfirmed": true,
"isRequireLDAConfirmed": true,
"requireContactHoursConfirmation": true,
"requireLDAConfirmation": true,
"isRequireChangeInWlmAssignment": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"addedClassSectionId": 0,
"allowCreditsHoursOverride": true,
"allowReservations": true,
"attendanceLastPostedDate": "2019-08-24T14:15:22Z",
"autoDropConsecutiveHoursAbsent": 0,
"autoDropCumulativeHoursAbsent": 0,
"autoDropPercentageHoursAbsent": 0,
"autoWarningConsecutiveHoursAbsent": 0,
"autoWarningCumulativeHoursAbsent": 0,
"autoWarningPercentageHoursAbsent": 0,
"campusId": 0,
"classSchedLength": 0,
"clockHours": 0,
"courseCode": "string",
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"daysFlag": 0,
"deliveryMethodId": 0,
"dropEndDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"finalCountDropStudents": 0,
"finalCountRegisteredStudents": 0,
"hideFaculty": true,
"hideLocation": true,
"instructorId": 0,
"isActive": true,
"isAddDropDateOverride": true,
"isAuditAdvisementRequired": true,
"isAutoDropEnforcedAfterLdw": true,
"isAutoWarningOnClassRosterAfterLdw": true,
"isBlindGrading": true,
"isCancelled": true,
"isClassSectionAutoAdded": true,
"isLdwOverride": true,
"isMeetingOnIrregularDaysTimes": true,
"isStudentSpecificMeetingSchedule": true,
"isWaitlistExpiredOrCleared": true,
"isWaitListingAllowed": true,
"lastDayToWithdrawDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lmsExtractStatus": "string",
"lmsVendorId": 0,
"loadMethod": "string",
"makeUpMaxType": "string",
"makeUpMaxValue": 0,
"maximumCredits": 0,
"maximumStudents": 0,
"maxNumberAssignments": 0,
"maxNumberSectionsAllowed": 0,
"minimumCredits": 0,
"nextAttendanceDate": "2019-08-24T14:15:22Z",
"note": "string",
"numberRegisteredStudents": 0,
"passFailSetting": { },
"postAttendanceType": "string",
"rowVersion": "string",
"secondSectionCode": "string",
"sectionCode": "string",
"sectionName": "string",
"sendToLms": true,
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"studentSpecificMeetingScheduleDefaultMinutes": 0,
"syllabusDocument": "string",
"thresholdNumberOfSeats": { },
"thresholdType": true,
"unregisterEndDate": "2019-08-24T14:15:22Z",
"waitListMaximumSeats": 0,
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"meetingPatterns": [{"meetingPattern": {"id": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"frequency": { },
"isMeetingOnFriday": true,
"isMeetingOnMonday": true,
"isMeetingOnSaturday": true,
"isMeetingOnSunday": true,
"isMeetingOnThursday": true,
"isMeetingOnTuesday": true,
"isMeetingOnWednesday": true,
"isRecurrenceEnding": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingLength": { },
"patternType": "string",
"recurrenceEndNumber": { },
"recurrenceStartWeeks": { },
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"dayOfWeekRooms": [{"dayOfWeek": 0,
"roomId": 0,
"roomCode": "string",
"roomName": "string",
"buildingId": 0,
"buildingCode": "string",
"buildingName": "string",
"locationId": 0,
"locationName": "string"
}
],
"isConflict": true,
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingPatternId": 0,
"rowVersion": "string",
"type": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"terms": [{"termName": "string",
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Waitlist And Attendance Rules

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-savewaitlistandattendancerules-request-payload)

object (cmc-nexus-academics-entities-classSectionEntity)

isUpdateStudentSchedules	boolean
isUpdateStudentSchedulesConfirmation	boolean
isUpdateStudentSchedulesConfirmationProvided	boolean
isSchedulePeriodDeleteConfirmation	boolean
cantDeleteTerms	string
updateStudentsInCourseSection	boolean
scheduleStartDate	string <date-time>
scheduleEndDate	string <date-time>
	Array of objects (cmc-nexus-academics-entities-crsgCrossReferenceCampus)
isContactHoursConfirmed	boolean
isRequireLDAConfirmed	boolean
requireContactHoursConfirmation	boolean
requireLDAConfirmation	boolean
isRequireChangeInWlmAssignment	boolean
id required	number <int32> Id
addDropDate	string <date-time> Add Drop Date
addedClassSectionId	number <int32> Added Class Section Id
allowCreditsHoursOverride	boolean Allow Credits Hours Override
allowReservations	boolean Allow Reservations
attendanceLastPostedDate	string <date-time> Attendance Last Posted Date
autoDropConsecutiveHoursAbsent	number <double> Auto Drop Consecutive Hours Absent
autoDropCumulativeHoursAbsent	number <double> Auto Drop Cumulative Hours Absent
autoDropPercentageHoursAbsent	number <double> Auto Drop Percentage Hours Absent
autoWarningConsecutiveHoursAbsent	number <double> Auto Warning Consecutive Hours Absent
autoWarningCumulativeHoursAbsent	number <double> Auto Warning Cumulative Hours Absent
autoWarningPercentageHoursAbsent	number <double> Auto Warning Percentage Hours Absent
campusId required	number <int32> Campus Id
classSchedLength	number <int32> Class Sched Length
clockHours	number <double> Clock Hours
courseCode	string Course Code
courseId required	number <int32> Course Id
createdDateTime required	string <date-time> Created Date Time
creditHours	number <double> Credit Hours
daysFlag	number <int32> Days Flag
deliveryMethodId	number <int32> Delivery Method Id
dropEndDate	string <date-time> Drop End Date
endDate	string <date-time> End Date
enrollmentStatusClockHours	number <double> Enrollment Status Clock Hours
enrollmentStatusCreditHours	number <double> Enrollment Status Credit Hours
finalCountDropStudents	number <int32> Final Count Drop Students
finalCountRegisteredStudents	number <int32> Final Count Registered Students
hideFaculty	boolean Hide Faculty
hideLocation	boolean Hide Location
instructorId	number <int32> Instructor Id
isActive	boolean Is Active
isAddDropDateOverride	boolean Is Add Drop Date Override
isAuditAdvisementRequired	boolean Is Audit Advisement Required
isAutoDropEnforcedAfterLdw	boolean Is Auto Drop Enforced After Ldw
isAutoWarningOnClassRosterAfterLdw	boolean Is Auto Warning On Class Roster After Ldw
isBlindGrading	boolean Is Blind Grading
isCancelled	boolean Is Cancelled
isClassSectionAutoAdded	boolean Is Class Section Auto Added
isLdwOverride	boolean Is Ldw Override
isMeetingOnIrregularDaysTimes	boolean Is Meeting On Irregular Days Times
isStudentSpecificMeetingSchedule	boolean Is Student Specific Meeting Schedule
isWaitlistExpiredOrCleared	boolean Is Waitlist Expired Or Cleared
isWaitListingAllowed	boolean Is Wait Listing Allowed
lastDayToWithdrawDate	string <date-time> Last Day To Withdraw Date
lastModifiedDateTime required	string <date-time> Last Modified Date Time
lastModifiedUserId required	number <int32> Last Modified User Id
lmsExtractStatus	string Lms Extract Status
lmsVendorId	number <int32> Lms Vendor Id
loadMethod	string Load Method
makeUpMaxType	string Make Up Max Type
makeUpMaxValue	number <double> Make Up Max Value
maximumCredits	number <double> Maximum Credits
maximumStudents	number <int32> Maximum Students
maxNumberAssignments	number <int32> Max Number Assignments
maxNumberSectionsAllowed	number <int32> Max Number Sections Allowed
minimumCredits	number <double> Minimum Credits
nextAttendanceDate	string <date-time> Next Attendance Date
note	string Note
numberRegisteredStudents	number <int32> Number Registered Students
passFailSetting	object Pass Fail Setting
postAttendanceType	string Post Attendance Type
rowVersion	string
secondSectionCode	string Second Section Code
sectionCode	string Section Code
sectionName	string Section Name
sendToLms	boolean Send To Lms
shiftId	number <int32> Shift Id
startDate	string <date-time> Start Date
startTime	string <date-time> Start Time
studentSpecificMeetingScheduleDefaultMinutes	number <int32> Student Specific Meeting Schedule Default Minutes
syllabusDocument	string Syllabus Document
thresholdNumberOfSeats	object Threshold Number Of Seats
thresholdType	boolean Threshold Type
unregisterEndDate	string <date-time> Unregister End Date
waitListMaximumSeats	number <int32> Wait List Maximum Seats
wlmActivityTypeId	number <int32> Wlm Activity Type Id
wlmAssignmentTypeId	number <int32> Wlm Assignment Type Id
wlmDepartmentId	number <int32> Wlm Department Id
	Array of objects (cmc-nexus-academics-entities-classSectionMeetingPatternEntity)
	Array of objects (cmc-nexus-academics-entities-classSectionTermEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionEntity": {"isUpdateStudentSchedules": true,
"isUpdateStudentSchedulesConfirmation": true,
"isUpdateStudentSchedulesConfirmationProvided": true,
"isSchedulePeriodDeleteConfirmation": true,
"cantDeleteTerms": "string",
"updateStudentsInCourseSection": true,
"scheduleStartDate": "2019-08-24T14:15:22Z",
"scheduleEndDate": "2019-08-24T14:15:22Z",
"crsgCrossReferenceCampuses": [{"id": 0,
"isCRSG": true,
"name": "string"
}
],
"isContactHoursConfirmed": true,
"isRequireLDAConfirmed": true,
"requireContactHoursConfirmation": true,
"requireLDAConfirmation": true,
"isRequireChangeInWlmAssignment": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"addedClassSectionId": 0,
"allowCreditsHoursOverride": true,
"allowReservations": true,
"attendanceLastPostedDate": "2019-08-24T14:15:22Z",
"autoDropConsecutiveHoursAbsent": 0,
"autoDropCumulativeHoursAbsent": 0,
"autoDropPercentageHoursAbsent": 0,
"autoWarningConsecutiveHoursAbsent": 0,
"autoWarningCumulativeHoursAbsent": 0,
"autoWarningPercentageHoursAbsent": 0,
"campusId": 0,
"classSchedLength": 0,
"clockHours": 0,
"courseCode": "string",
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"daysFlag": 0,
"deliveryMethodId": 0,
"dropEndDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"finalCountDropStudents": 0,
"finalCountRegisteredStudents": 0,
"hideFaculty": true,
"hideLocation": true,
"instructorId": 0,
"isActive": true,
"isAddDropDateOverride": true,
"isAuditAdvisementRequired": true,
"isAutoDropEnforcedAfterLdw": true,
"isAutoWarningOnClassRosterAfterLdw": true,
"isBlindGrading": true,
"isCancelled": true,
"isClassSectionAutoAdded": true,
"isLdwOverride": true,
"isMeetingOnIrregularDaysTimes": true,
"isStudentSpecificMeetingSchedule": true,
"isWaitlistExpiredOrCleared": true,
"isWaitListingAllowed": true,
"lastDayToWithdrawDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lmsExtractStatus": "string",
"lmsVendorId": 0,
"loadMethod": "string",
"makeUpMaxType": "string",
"makeUpMaxValue": 0,
"maximumCredits": 0,
"maximumStudents": 0,
"maxNumberAssignments": 0,
"maxNumberSectionsAllowed": 0,
"minimumCredits": 0,
"nextAttendanceDate": "2019-08-24T14:15:22Z",
"note": "string",
"numberRegisteredStudents": 0,
"passFailSetting": { },
"postAttendanceType": "string",
"rowVersion": "string",
"secondSectionCode": "string",
"sectionCode": "string",
"sectionName": "string",
"sendToLms": true,
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"studentSpecificMeetingScheduleDefaultMinutes": 0,
"syllabusDocument": "string",
"thresholdNumberOfSeats": { },
"thresholdType": true,
"unregisterEndDate": "2019-08-24T14:15:22Z",
"waitListMaximumSeats": 0,
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"meetingPatterns": [{"meetingPattern": {"id": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"frequency": { },
"isMeetingOnFriday": true,
"isMeetingOnMonday": true,
"isMeetingOnSaturday": true,
"isMeetingOnSunday": true,
"isMeetingOnThursday": true,
"isMeetingOnTuesday": true,
"isMeetingOnWednesday": true,
"isRecurrenceEnding": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingLength": { },
"patternType": "string",
"recurrenceEndNumber": { },
"recurrenceStartWeeks": { },
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"dayOfWeekRooms": [{"dayOfWeek": 0,
"roomId": 0,
"roomCode": "string",
"roomName": "string",
"buildingId": 0,
"buildingCode": "string",
"buildingName": "string",
"locationId": 0,
"locationName": "string"
}
],
"isConflict": true,
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingPatternId": 0,
"rowVersion": "string",
"type": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"terms": [{"termName": "string",
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}
}

Response samples

Content type

application/json

{"payload": {"data": {"classSectionEntity": {"isUpdateStudentSchedules": true,
"isUpdateStudentSchedulesConfirmation": true,
"isUpdateStudentSchedulesConfirmationProvided": true,
"isSchedulePeriodDeleteConfirmation": true,
"cantDeleteTerms": "string",
"updateStudentsInCourseSection": true,
"scheduleStartDate": "2019-08-24T14:15:22Z",
"scheduleEndDate": "2019-08-24T14:15:22Z",
"crsgCrossReferenceCampuses": [{"id": 0,
"isCRSG": true,
"name": "string"
}
],
"isContactHoursConfirmed": true,
"isRequireLDAConfirmed": true,
"requireContactHoursConfirmation": true,
"requireLDAConfirmation": true,
"isRequireChangeInWlmAssignment": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"addedClassSectionId": 0,
"allowCreditsHoursOverride": true,
"allowReservations": true,
"attendanceLastPostedDate": "2019-08-24T14:15:22Z",
"autoDropConsecutiveHoursAbsent": 0,
"autoDropCumulativeHoursAbsent": 0,
"autoDropPercentageHoursAbsent": 0,
"autoWarningConsecutiveHoursAbsent": 0,
"autoWarningCumulativeHoursAbsent": 0,
"autoWarningPercentageHoursAbsent": 0,
"campusId": 0,
"classSchedLength": 0,
"clockHours": 0,
"courseCode": "string",
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"daysFlag": 0,
"deliveryMethodId": 0,
"dropEndDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"finalCountDropStudents": 0,
"finalCountRegisteredStudents": 0,
"hideFaculty": true,
"hideLocation": true,
"instructorId": 0,
"isActive": true,
"isAddDropDateOverride": true,
"isAuditAdvisementRequired": true,
"isAutoDropEnforcedAfterLdw": true,
"isAutoWarningOnClassRosterAfterLdw": true,
"isBlindGrading": true,
"isCancelled": true,
"isClassSectionAutoAdded": true,
"isLdwOverride": true,
"isMeetingOnIrregularDaysTimes": true,
"isStudentSpecificMeetingSchedule": true,
"isWaitlistExpiredOrCleared": true,
"isWaitListingAllowed": true,
"lastDayToWithdrawDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lmsExtractStatus": "string",
"lmsVendorId": 0,
"loadMethod": "string",
"makeUpMaxType": "string",
"makeUpMaxValue": 0,
"maximumCredits": 0,
"maximumStudents": 0,
"maxNumberAssignments": 0,
"maxNumberSectionsAllowed": 0,
"minimumCredits": 0,
"nextAttendanceDate": "2019-08-24T14:15:22Z",
"note": "string",
"numberRegisteredStudents": 0,
"passFailSetting": { },
"postAttendanceType": "string",
"rowVersion": "string",
"secondSectionCode": "string",
"sectionCode": "string",
"sectionName": "string",
"sendToLms": true,
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"studentSpecificMeetingScheduleDefaultMinutes": 0,
"syllabusDocument": "string",
"thresholdNumberOfSeats": { },
"thresholdType": true,
"unregisterEndDate": "2019-08-24T14:15:22Z",
"waitListMaximumSeats": 0,
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"meetingPatterns": [{"meetingPattern": {"id": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"frequency": { },
"isMeetingOnFriday": true,
"isMeetingOnMonday": true,
"isMeetingOnSaturday": true,
"isMeetingOnSunday": true,
"isMeetingOnThursday": true,
"isMeetingOnTuesday": true,
"isMeetingOnWednesday": true,
"isRecurrenceEnding": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingLength": { },
"patternType": "string",
"recurrenceEndNumber": { },
"recurrenceStartWeeks": { },
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"dayOfWeekRooms": [{"dayOfWeek": 0,
"roomId": 0,
"roomCode": "string",
"roomName": "string",
"buildingId": 0,
"buildingCode": "string",
"buildingName": "string",
"locationId": 0,
"locationName": "string"
}
],
"isConflict": true,
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingPatternId": 0,
"rowVersion": "string",
"type": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"terms": [{"termName": "string",
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Unschedule Class Section

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-classsection-unscheduleclasssection-request-payload)

date	string
campusId	number <int32>
isContinue	boolean
	Array of objects (cmc-nexus-academics-services-classSectionCustom)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"date": "string",
"campusId": 0,
"isContinue": true,
"selectedClassSections": [{"id": 0,
"courseCode": "string",
"courseName": "string",
"termCode": "string"
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"id": 0,
"isSuccess": true,
"clockHours": 0,
"contactHours": 0,
"isContinue": true,
"isFail": true,
"classSectionDetails": [{"classSectionId": 0,
"courseCode": "string",
"courseName": "string",
"sectionCode": "string",
"termCode": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Course

Create Course

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"coursePrefixCourseAssociationIdList": [0
],
"coursePrefixCourseAssociationList": [{"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"coursePrefixCodeList": [{"coursePrefixCourseAssociation": {"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"campusIdList": [0
],
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"id": 0,
"addDropDays": { },
"adDependentCourseId": 0,
"allowOverride": true,
"allowRetakeOverride": true,
"campusGroupId": 0,
"catalogCode": "string",
"clockHours": 0,
"code": "string",
"compareContactHrsWithClsSched": true,
"courseLevelId": 0,
"courseTypeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"defaultMaxNumOfRepeat": 0,
"defaultPassFailSetting": { },
"enrollStatusCredits": 0,
"enrollStatusHours": 0,
"gradeLevel": { },
"incompleteGradeExpirationDays": 0,
"isActive": true,
"isAddDropDaysBasedOnCalenderDays": true,
"isCourseRemedial": true,
"isDependent": true,
"isExcludeDropsFromAttemptsCount": true,
"isRetakeFee": true,
"isSupplementaryCourse": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"loadMethod": "string",
"matchOverrideCredits": true,
"maximumCredits": 0,
"maximumDays": { },
"maximumNumWithoutRetakeFee": 0,
"maxNumberAssignments": 0,
"minimumCredits": 0,
"minimumDays": { },
"name": "string",
"note": "string",
"outsideCourseWorkHours": 0,
"retakeAssessmentType": "string",
"rowVersion": "string",
"supplementaryAssessmentType": "string",
"unitType": "string",
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"wlmLoadTypes": [{"loadTypeName": "string",
"earningCodeName": "string",
"measurementUnitName": "string",
"id": 0,
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"defaultValue": 0,
"isLoadTracked": true,
"isOverrideAllowed": true,
"isPayTracked": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"wlmEarningCodeId": 0,
"wlmLoadTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-course-delete-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
customProperties	Array of strings
multiValueCustomProperties	Array of strings
originalCustomProperties	Array of strings
originalMultiValueCustomProperties	Array of strings
originalCustomPropertiesValues	string <byte>
originalMultiValueCustomPropertiesValues	string <byte>
coursePrefixCourseAssociationIdList	Array of numbers <int32> [ items <int32 > ]
	Array of objects (cmc-nexus-academics-entities-coursePrefixCourseAssociationEntity)
	Array of objects (cmc-nexus-academics-entities-coursePrefixCodeEntity)
id	number <int32> Id
addDropDays	object Add Drop Days
adDependentCourseId	number <int32> Ad Dependent Course Id
allowOverride	boolean Allow Override
allowRetakeOverride	boolean Allow Retake Override
campusGroupId	number <int32> Campus Group Id
catalogCode	string Catalog Code
clockHours	number <double> Clock Hours
code	string Code
compareContactHrsWithClsSched	boolean Compare Contact Hrs With Cls Sched
courseLevelId	number <int32> Course Level Id
courseTypeId	number <int32> Course Type Id
createdDateTime	string <date-time> Created Date Time
creditHours	number <double> Credit Hours
defaultMaxNumOfRepeat	number <int32> Default Max Num Of Repeat
defaultPassFailSetting	object Default Pass Fail Setting
enrollStatusCredits	number <double> Enroll Status Credits
enrollStatusHours	number <double> Enroll Status Hours
gradeLevel	object Grade Level
incompleteGradeExpirationDays	number <int32> Incomplete Grade Expiration Days
isActive	boolean Is Active
isAddDropDaysBasedOnCalenderDays	boolean Is Add Drop Days Based On Calender Days
isCourseRemedial	boolean Is Course Remedial
isDependent	boolean Is Dependent
isExcludeDropsFromAttemptsCount	boolean Is Exclude Drops From Attempts Count
isRetakeFee	boolean Is Retake Fee
isSupplementaryCourse	boolean Is Supplementary Course
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
loadMethod	string Load Method
matchOverrideCredits	boolean Match Override Credits
maximumCredits	number <double> Maximum Credits
maximumDays	object Maximum Days
maximumNumWithoutRetakeFee	number <int32> Maximum Num Without Retake Fee
maxNumberAssignments	number <int32> Max Number Assignments
minimumCredits	number <double> Minimum Credits
minimumDays	object Minimum Days
name	string Name
note	string Note
outsideCourseWorkHours	number <double> Outside Course Work Hours
retakeAssessmentType	string Retake Assessment Type
rowVersion	string
supplementaryAssessmentType	string Supplementary Assessment Type
unitType	string Unit Type
wlmActivityTypeId	number <int32> Wlm Activity Type Id
wlmAssignmentTypeId	number <int32> Wlm Assignment Type Id
wlmDepartmentId	number <int32> Wlm Department Id
	object (cmc-nexus-common-entities-campusGroupEntity)
	Array of objects (cmc-nexus-academics-entities-wlmCourseLoadTypeAssociationEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"coursePrefixCourseAssociationIdList": [0
],
"coursePrefixCourseAssociationList": [{"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"coursePrefixCodeList": [{"coursePrefixCourseAssociation": {"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"campusIdList": [0
],
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"id": 0,
"addDropDays": { },
"adDependentCourseId": 0,
"allowOverride": true,
"allowRetakeOverride": true,
"campusGroupId": 0,
"catalogCode": "string",
"clockHours": 0,
"code": "string",
"compareContactHrsWithClsSched": true,
"courseLevelId": 0,
"courseTypeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"defaultMaxNumOfRepeat": 0,
"defaultPassFailSetting": { },
"enrollStatusCredits": 0,
"enrollStatusHours": 0,
"gradeLevel": { },
"incompleteGradeExpirationDays": 0,
"isActive": true,
"isAddDropDaysBasedOnCalenderDays": true,
"isCourseRemedial": true,
"isDependent": true,
"isExcludeDropsFromAttemptsCount": true,
"isRetakeFee": true,
"isSupplementaryCourse": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"loadMethod": "string",
"matchOverrideCredits": true,
"maximumCredits": 0,
"maximumDays": { },
"maximumNumWithoutRetakeFee": 0,
"maxNumberAssignments": 0,
"minimumCredits": 0,
"minimumDays": { },
"name": "string",
"note": "string",
"outsideCourseWorkHours": 0,
"retakeAssessmentType": "string",
"rowVersion": "string",
"supplementaryAssessmentType": "string",
"unitType": "string",
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"wlmLoadTypes": [{"loadTypeName": "string",
"earningCodeName": "string",
"measurementUnitName": "string",
"id": 0,
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"defaultValue": 0,
"isLoadTracked": true,
"isOverrideAllowed": true,
"isPayTracked": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"wlmEarningCodeId": 0,
"wlmLoadTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-course-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"coursePrefixCourseAssociationIdList": [0
],
"coursePrefixCourseAssociationList": [{"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"coursePrefixCodeList": [{"coursePrefixCourseAssociation": {"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"campusIdList": [0
],
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"id": 0,
"addDropDays": { },
"adDependentCourseId": 0,
"allowOverride": true,
"allowRetakeOverride": true,
"campusGroupId": 0,
"catalogCode": "string",
"clockHours": 0,
"code": "string",
"compareContactHrsWithClsSched": true,
"courseLevelId": 0,
"courseTypeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"defaultMaxNumOfRepeat": 0,
"defaultPassFailSetting": { },
"enrollStatusCredits": 0,
"enrollStatusHours": 0,
"gradeLevel": { },
"incompleteGradeExpirationDays": 0,
"isActive": true,
"isAddDropDaysBasedOnCalenderDays": true,
"isCourseRemedial": true,
"isDependent": true,
"isExcludeDropsFromAttemptsCount": true,
"isRetakeFee": true,
"isSupplementaryCourse": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"loadMethod": "string",
"matchOverrideCredits": true,
"maximumCredits": 0,
"maximumDays": { },
"maximumNumWithoutRetakeFee": 0,
"maxNumberAssignments": 0,
"minimumCredits": 0,
"minimumDays": { },
"name": "string",
"note": "string",
"outsideCourseWorkHours": 0,
"retakeAssessmentType": "string",
"rowVersion": "string",
"supplementaryAssessmentType": "string",
"unitType": "string",
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"wlmLoadTypes": [{"loadTypeName": "string",
"earningCodeName": "string",
"measurementUnitName": "string",
"id": 0,
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"defaultValue": 0,
"isLoadTracked": true,
"isOverrideAllowed": true,
"isPayTracked": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"wlmEarningCodeId": 0,
"wlmLoadTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Course Attributes

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-course-getcourseattributes-request-payload)

courseId

number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"courseId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Course Prerequisites

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-course-getcourseprerequisites-request-payload)

courseId	number <int32>
isCorequisite	boolean
programVersionId	number <int32>
catalogYearId	number <int32>
courseCategoryId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"courseId": 0,
"isCorequisite": true,
"programVersionId": 0,
"catalogYearId": 0,
"courseCategoryId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"minimumCredits": 0,
"minimumHours": 0,
"gradeLevelId": 0,
"programVersionId": 0,
"catalogYearId": 0,
"courseCategoryId": 0,
"numberRemainingRequiredCredits": 0,
"courePrerequisiteRuleList": [{"id": 0,
"courseId": 0,
"name": "string",
"numberRequired": 0,
"operator": "string",
"parentCousePrerequisiteRuleId": 0,
"ruleType": "string",
"preAndCorequisiteCourseList": [{"id": 0,
"courseId": 0,
"coursePrerequisiteRuleId": 0,
"minimumGpaRequired": 0,
"courseCode": "string",
"courseName": "string"
}
]
}
],
"coursePrerequisiteTests": [{"id": 0,
"courseId": 0,
"entranceTestId": 0,
"testType": "string",
"testName": "string",
"testCode": "string",
"value": "string",
"ruleNumber": 0,
"minimumRequiredNumber": 0,
"testDescription": "string"
}
],
"coursePrerequisiteDocuments": [{"id": 0,
"courseId": 0,
"documentTypeId": 0,
"documentCode": "string",
"documentName": "string",
"ruleNumber": 0,
"minimumNumberRequired": 0
}
],
"coursePrerequisiteList": [{"id": 0,
"courseId": 0,
"prerequisiteType": "string",
"isOptional": true,
"isEnabled": true,
"minNumberRequired": 0
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Parent And Equivalent Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-course-getparentandequivalentcourse-request-payload)

courseId	number <int32>
campusId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"courseId": 0,
"campusId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Student Transfer Credit Campus Course List

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-course-getstudenttransfercreditcampuscourselist-request-payload)

isCollege	boolean
collegeOrHighSchoolIdList	Array of numbers <int32> [ items <int32 > ]
campusId	number <int32>
collegeOrHighSchoolCourseIdList	Array of numbers <int32> [ items <int32 > ]
studentId	number <int32>
studentEnrollmentPeriodId	number <int32>
isEdit	boolean
isCourseIncludeInActive	boolean
statusId	number <int32>
studentTransferCreditId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isCollege": true,
"collegeOrHighSchoolIdList": [0
],
"campusId": 0,
"collegeOrHighSchoolCourseIdList": [0
],
"studentId": 0,
"studentEnrollmentPeriodId": 0,
"isEdit": true,
"isCourseIncludeInActive": true,
"statusId": 0,
"studentTransferCreditId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"courseList": [{"id": 0,
"campusCourseId": 0,
"code": "string",
"name": "string",
"clockHours": 0,
"creditHours": 0,
"isActive": true,
"type": 0,
"campusList": [{"id": 0,
"name": "string"
}
],
"parent": "string",
"courseLevel": "string",
"courseType": "string",
"isRetake": true
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-course-save-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
customProperties	Array of strings
multiValueCustomProperties	Array of strings
originalCustomProperties	Array of strings
originalMultiValueCustomProperties	Array of strings
originalCustomPropertiesValues	string <byte>
originalMultiValueCustomPropertiesValues	string <byte>
coursePrefixCourseAssociationIdList	Array of numbers <int32> [ items <int32 > ]
	Array of objects (cmc-nexus-academics-entities-coursePrefixCourseAssociationEntity)
	Array of objects (cmc-nexus-academics-entities-coursePrefixCodeEntity)
id	number <int32> Id
addDropDays	object Add Drop Days
adDependentCourseId	number <int32> Ad Dependent Course Id
allowOverride	boolean Allow Override
allowRetakeOverride	boolean Allow Retake Override
campusGroupId	number <int32> Campus Group Id
catalogCode	string Catalog Code
clockHours	number <double> Clock Hours
code	string Code
compareContactHrsWithClsSched	boolean Compare Contact Hrs With Cls Sched
courseLevelId	number <int32> Course Level Id
courseTypeId	number <int32> Course Type Id
createdDateTime	string <date-time> Created Date Time
creditHours	number <double> Credit Hours
defaultMaxNumOfRepeat	number <int32> Default Max Num Of Repeat
defaultPassFailSetting	object Default Pass Fail Setting
enrollStatusCredits	number <double> Enroll Status Credits
enrollStatusHours	number <double> Enroll Status Hours
gradeLevel	object Grade Level
incompleteGradeExpirationDays	number <int32> Incomplete Grade Expiration Days
isActive	boolean Is Active
isAddDropDaysBasedOnCalenderDays	boolean Is Add Drop Days Based On Calender Days
isCourseRemedial	boolean Is Course Remedial
isDependent	boolean Is Dependent
isExcludeDropsFromAttemptsCount	boolean Is Exclude Drops From Attempts Count
isRetakeFee	boolean Is Retake Fee
isSupplementaryCourse	boolean Is Supplementary Course
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
loadMethod	string Load Method
matchOverrideCredits	boolean Match Override Credits
maximumCredits	number <double> Maximum Credits
maximumDays	object Maximum Days
maximumNumWithoutRetakeFee	number <int32> Maximum Num Without Retake Fee
maxNumberAssignments	number <int32> Max Number Assignments
minimumCredits	number <double> Minimum Credits
minimumDays	object Minimum Days
name	string Name
note	string Note
outsideCourseWorkHours	number <double> Outside Course Work Hours
retakeAssessmentType	string Retake Assessment Type
rowVersion	string
supplementaryAssessmentType	string Supplementary Assessment Type
unitType	string Unit Type
wlmActivityTypeId	number <int32> Wlm Activity Type Id
wlmAssignmentTypeId	number <int32> Wlm Assignment Type Id
wlmDepartmentId	number <int32> Wlm Department Id
	object (cmc-nexus-common-entities-campusGroupEntity)
	Array of objects (cmc-nexus-academics-entities-wlmCourseLoadTypeAssociationEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"coursePrefixCourseAssociationIdList": [0
],
"coursePrefixCourseAssociationList": [{"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"coursePrefixCodeList": [{"coursePrefixCourseAssociation": {"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"campusIdList": [0
],
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"id": 0,
"addDropDays": { },
"adDependentCourseId": 0,
"allowOverride": true,
"allowRetakeOverride": true,
"campusGroupId": 0,
"catalogCode": "string",
"clockHours": 0,
"code": "string",
"compareContactHrsWithClsSched": true,
"courseLevelId": 0,
"courseTypeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"defaultMaxNumOfRepeat": 0,
"defaultPassFailSetting": { },
"enrollStatusCredits": 0,
"enrollStatusHours": 0,
"gradeLevel": { },
"incompleteGradeExpirationDays": 0,
"isActive": true,
"isAddDropDaysBasedOnCalenderDays": true,
"isCourseRemedial": true,
"isDependent": true,
"isExcludeDropsFromAttemptsCount": true,
"isRetakeFee": true,
"isSupplementaryCourse": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"loadMethod": "string",
"matchOverrideCredits": true,
"maximumCredits": 0,
"maximumDays": { },
"maximumNumWithoutRetakeFee": 0,
"maxNumberAssignments": 0,
"minimumCredits": 0,
"minimumDays": { },
"name": "string",
"note": "string",
"outsideCourseWorkHours": 0,
"retakeAssessmentType": "string",
"rowVersion": "string",
"supplementaryAssessmentType": "string",
"unitType": "string",
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"wlmLoadTypes": [{"loadTypeName": "string",
"earningCodeName": "string",
"measurementUnitName": "string",
"id": 0,
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"defaultValue": 0,
"isLoadTracked": true,
"isOverrideAllowed": true,
"isPayTracked": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"wlmEarningCodeId": 0,
"wlmLoadTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"coursePrefixCourseAssociationIdList": [0
],
"coursePrefixCourseAssociationList": [{"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"coursePrefixCodeList": [{"coursePrefixCourseAssociation": {"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"campusIdList": [0
],
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"id": 0,
"addDropDays": { },
"adDependentCourseId": 0,
"allowOverride": true,
"allowRetakeOverride": true,
"campusGroupId": 0,
"catalogCode": "string",
"clockHours": 0,
"code": "string",
"compareContactHrsWithClsSched": true,
"courseLevelId": 0,
"courseTypeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"defaultMaxNumOfRepeat": 0,
"defaultPassFailSetting": { },
"enrollStatusCredits": 0,
"enrollStatusHours": 0,
"gradeLevel": { },
"incompleteGradeExpirationDays": 0,
"isActive": true,
"isAddDropDaysBasedOnCalenderDays": true,
"isCourseRemedial": true,
"isDependent": true,
"isExcludeDropsFromAttemptsCount": true,
"isRetakeFee": true,
"isSupplementaryCourse": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"loadMethod": "string",
"matchOverrideCredits": true,
"maximumCredits": 0,
"maximumDays": { },
"maximumNumWithoutRetakeFee": 0,
"maxNumberAssignments": 0,
"minimumCredits": 0,
"minimumDays": { },
"name": "string",
"note": "string",
"outsideCourseWorkHours": 0,
"retakeAssessmentType": "string",
"rowVersion": "string",
"supplementaryAssessmentType": "string",
"unitType": "string",
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"wlmLoadTypes": [{"loadTypeName": "string",
"earningCodeName": "string",
"measurementUnitName": "string",
"id": 0,
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"defaultValue": 0,
"isLoadTracked": true,
"isOverrideAllowed": true,
"isPayTracked": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"wlmEarningCodeId": 0,
"wlmLoadTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Course Attributes

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

payload

any (academics-course-savecourseattributes-request-payload)

Responses

Request samples

Payload

Content type

application/json

{"payload": null
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Course Name Change

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-course-savecoursenamechange-request-payload)

id	number <int32>
campusId	number <int32>
studentCourseStatus	string
newCourseName	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"campusId": 0,
"studentCourseStatus": "string",
"newCourseName": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"id": 0,
"campusId": 0,
"studentCourseStatus": "string",
"newCourseName": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Course Prerequisite Details

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-course-savecourseprerequisitedetails-request-payload)

minimumCredits	number <double>
minimumHours	number <double>
gradeLevelId	number <int32>
courseId	number <int32>
programVersionId	number <int32>
catalogYearId	number <int32>
courseCategoryId	number <int32>
minNumberRequired	number <int32>
isCorequisite	boolean
numberRemainingRequiredCredits	number <double>
	Array of objects (cmc-nexus-academics-services-coursePreAndCoRequisite)
	Array of objects (cmc-nexus-academics-services-coursePrerequisiteTest)
	Array of objects (cmc-nexus-academics-services-coursePrerequisiteDocument)
	Array of objects (cmc-nexus-academics-services-coursePrerequisiteConfiguration)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"minimumCredits": 0,
"minimumHours": 0,
"gradeLevelId": 0,
"courseId": 0,
"programVersionId": 0,
"catalogYearId": 0,
"courseCategoryId": 0,
"minNumberRequired": 0,
"isCorequisite": true,
"numberRemainingRequiredCredits": 0,
"courePrerequisiteRuleList": [{"id": 0,
"courseId": 0,
"name": "string",
"numberRequired": 0,
"operator": "string",
"parentCousePrerequisiteRuleId": 0,
"ruleType": "string",
"preAndCorequisiteCourseList": [{"id": 0,
"courseId": 0,
"coursePrerequisiteRuleId": 0,
"minimumGpaRequired": 0,
"courseCode": "string",
"courseName": "string"
}
]
}
],
"coursePrerequisiteTests": [{"id": 0,
"courseId": 0,
"entranceTestId": 0,
"testType": "string",
"testName": "string",
"testCode": "string",
"value": "string",
"ruleNumber": 0,
"minimumRequiredNumber": 0,
"testDescription": "string"
}
],
"coursePrerequisiteDocuments": [{"id": 0,
"courseId": 0,
"documentTypeId": 0,
"documentCode": "string",
"documentName": "string",
"ruleNumber": 0,
"minimumNumberRequired": 0
}
],
"coursePrerequisiteList": [{"id": 0,
"courseId": 0,
"prerequisiteType": "string",
"isOptional": true,
"isEnabled": true,
"minNumberRequired": 0
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-course-savenew-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
customProperties	Array of strings
multiValueCustomProperties	Array of strings
originalCustomProperties	Array of strings
originalMultiValueCustomProperties	Array of strings
originalCustomPropertiesValues	string <byte>
originalMultiValueCustomPropertiesValues	string <byte>
coursePrefixCourseAssociationIdList	Array of numbers <int32> [ items <int32 > ]
	Array of objects (cmc-nexus-academics-entities-coursePrefixCourseAssociationEntity)
	Array of objects (cmc-nexus-academics-entities-coursePrefixCodeEntity)
id	number <int32> Id
addDropDays	object Add Drop Days
adDependentCourseId	number <int32> Ad Dependent Course Id
allowOverride	boolean Allow Override
allowRetakeOverride	boolean Allow Retake Override
campusGroupId	number <int32> Campus Group Id
catalogCode	string Catalog Code
clockHours	number <double> Clock Hours
code	string Code
compareContactHrsWithClsSched	boolean Compare Contact Hrs With Cls Sched
courseLevelId	number <int32> Course Level Id
courseTypeId	number <int32> Course Type Id
createdDateTime	string <date-time> Created Date Time
creditHours	number <double> Credit Hours
defaultMaxNumOfRepeat	number <int32> Default Max Num Of Repeat
defaultPassFailSetting	object Default Pass Fail Setting
enrollStatusCredits	number <double> Enroll Status Credits
enrollStatusHours	number <double> Enroll Status Hours
gradeLevel	object Grade Level
incompleteGradeExpirationDays	number <int32> Incomplete Grade Expiration Days
isActive	boolean Is Active
isAddDropDaysBasedOnCalenderDays	boolean Is Add Drop Days Based On Calender Days
isCourseRemedial	boolean Is Course Remedial
isDependent	boolean Is Dependent
isExcludeDropsFromAttemptsCount	boolean Is Exclude Drops From Attempts Count
isRetakeFee	boolean Is Retake Fee
isSupplementaryCourse	boolean Is Supplementary Course
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
loadMethod	string Load Method
matchOverrideCredits	boolean Match Override Credits
maximumCredits	number <double> Maximum Credits
maximumDays	object Maximum Days
maximumNumWithoutRetakeFee	number <int32> Maximum Num Without Retake Fee
maxNumberAssignments	number <int32> Max Number Assignments
minimumCredits	number <double> Minimum Credits
minimumDays	object Minimum Days
name	string Name
note	string Note
outsideCourseWorkHours	number <double> Outside Course Work Hours
retakeAssessmentType	string Retake Assessment Type
rowVersion	string
supplementaryAssessmentType	string Supplementary Assessment Type
unitType	string Unit Type
wlmActivityTypeId	number <int32> Wlm Activity Type Id
wlmAssignmentTypeId	number <int32> Wlm Assignment Type Id
wlmDepartmentId	number <int32> Wlm Department Id
	object (cmc-nexus-common-entities-campusGroupEntity)
	Array of objects (cmc-nexus-academics-entities-wlmCourseLoadTypeAssociationEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"coursePrefixCourseAssociationIdList": [0
],
"coursePrefixCourseAssociationList": [{"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"coursePrefixCodeList": [{"coursePrefixCourseAssociation": {"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"campusIdList": [0
],
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"id": 0,
"addDropDays": { },
"adDependentCourseId": 0,
"allowOverride": true,
"allowRetakeOverride": true,
"campusGroupId": 0,
"catalogCode": "string",
"clockHours": 0,
"code": "string",
"compareContactHrsWithClsSched": true,
"courseLevelId": 0,
"courseTypeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"defaultMaxNumOfRepeat": 0,
"defaultPassFailSetting": { },
"enrollStatusCredits": 0,
"enrollStatusHours": 0,
"gradeLevel": { },
"incompleteGradeExpirationDays": 0,
"isActive": true,
"isAddDropDaysBasedOnCalenderDays": true,
"isCourseRemedial": true,
"isDependent": true,
"isExcludeDropsFromAttemptsCount": true,
"isRetakeFee": true,
"isSupplementaryCourse": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"loadMethod": "string",
"matchOverrideCredits": true,
"maximumCredits": 0,
"maximumDays": { },
"maximumNumWithoutRetakeFee": 0,
"maxNumberAssignments": 0,
"minimumCredits": 0,
"minimumDays": { },
"name": "string",
"note": "string",
"outsideCourseWorkHours": 0,
"retakeAssessmentType": "string",
"rowVersion": "string",
"supplementaryAssessmentType": "string",
"unitType": "string",
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"wlmLoadTypes": [{"loadTypeName": "string",
"earningCodeName": "string",
"measurementUnitName": "string",
"id": 0,
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"defaultValue": 0,
"isLoadTracked": true,
"isOverrideAllowed": true,
"isPayTracked": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"wlmEarningCodeId": 0,
"wlmLoadTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"coursePrefixCourseAssociationIdList": [0
],
"coursePrefixCourseAssociationList": [{"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"coursePrefixCodeList": [{"coursePrefixCourseAssociation": {"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"campusIdList": [0
],
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"id": 0,
"addDropDays": { },
"adDependentCourseId": 0,
"allowOverride": true,
"allowRetakeOverride": true,
"campusGroupId": 0,
"catalogCode": "string",
"clockHours": 0,
"code": "string",
"compareContactHrsWithClsSched": true,
"courseLevelId": 0,
"courseTypeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"defaultMaxNumOfRepeat": 0,
"defaultPassFailSetting": { },
"enrollStatusCredits": 0,
"enrollStatusHours": 0,
"gradeLevel": { },
"incompleteGradeExpirationDays": 0,
"isActive": true,
"isAddDropDaysBasedOnCalenderDays": true,
"isCourseRemedial": true,
"isDependent": true,
"isExcludeDropsFromAttemptsCount": true,
"isRetakeFee": true,
"isSupplementaryCourse": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"loadMethod": "string",
"matchOverrideCredits": true,
"maximumCredits": 0,
"maximumDays": { },
"maximumNumWithoutRetakeFee": 0,
"maxNumberAssignments": 0,
"minimumCredits": 0,
"minimumDays": { },
"name": "string",
"note": "string",
"outsideCourseWorkHours": 0,
"retakeAssessmentType": "string",
"rowVersion": "string",
"supplementaryAssessmentType": "string",
"unitType": "string",
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"wlmLoadTypes": [{"loadTypeName": "string",
"earningCodeName": "string",
"measurementUnitName": "string",
"id": 0,
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"defaultValue": 0,
"isLoadTracked": true,
"isOverrideAllowed": true,
"isPayTracked": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"wlmEarningCodeId": 0,
"wlmLoadTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Parent And Equivalent Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

payload

any (academics-course-saveparentandequivalentcourse-request-payload)

Responses

Request samples

Payload

Content type

application/json

{"payload": null
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Degree

Create Degree

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"degreeLevel": 0,
"graduateLevel": "string",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Degree

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-degree-delete-request-payload)

isExcludedCrmIntegration	boolean
id	number <int32> Id
campusGroupId	number <int32> The campus or campuses to which a person or item is assigned. If there is more than one campus, all the campuses are listed. In lists, if the column contains more than one campus, you cannot sort or filter on that column.
code	string The alpha numeric code assigned to the item by your institution.
createdDateTime	string <date-time> The date when the item or person was added or the status change was entered.
degreeLevel	number <int32> The degree level for Gainful Employment (GE) reporting. Levels that are followed by (nonGE) are degree levels that you can select for degrees for programs that do not meet GE requirements. The undergraduate levels are Undergraduate (nonGE), Undergraduate Certificate, Associate's Degree, Bachelor's Degree, Post-baccalaureate Certificate, Graduate/professional certificate, and Non-credential programs. The graduate levels are Graduate (nonGE), Professional (nonGE), Master's Degree, Post-master Certificate, Doctor - Research/Scholarship, Doctor - Professional Practice, Doctor - Other, and First-professional Degree.
graduateLevel	string Graduate Level
isActive	boolean Specifies whether or not the associated record is active.
lastModifiedDateTime	string <date-time> The date that the item was updated or changed.
lastModifiedUserId	number <int32> The last and then first name of the person that changed the item.
name	string Specifies the name of the item or person.
rowVersion	string
	object (cmc-nexus-common-entities-campusGroupEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"degreeLevel": 0,
"graduateLevel": "string",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Degree

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-degree-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"degreeLevel": 0,
"graduateLevel": "string",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Degree

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-degree-save-request-payload)

isExcludedCrmIntegration	boolean
id	number <int32> Id
campusGroupId	number <int32> The campus or campuses to which a person or item is assigned. If there is more than one campus, all the campuses are listed. In lists, if the column contains more than one campus, you cannot sort or filter on that column.
code	string The alpha numeric code assigned to the item by your institution.
createdDateTime	string <date-time> The date when the item or person was added or the status change was entered.
degreeLevel	number <int32> The degree level for Gainful Employment (GE) reporting. Levels that are followed by (nonGE) are degree levels that you can select for degrees for programs that do not meet GE requirements. The undergraduate levels are Undergraduate (nonGE), Undergraduate Certificate, Associate's Degree, Bachelor's Degree, Post-baccalaureate Certificate, Graduate/professional certificate, and Non-credential programs. The graduate levels are Graduate (nonGE), Professional (nonGE), Master's Degree, Post-master Certificate, Doctor - Research/Scholarship, Doctor - Professional Practice, Doctor - Other, and First-professional Degree.
graduateLevel	string Graduate Level
isActive	boolean Specifies whether or not the associated record is active.
lastModifiedDateTime	string <date-time> The date that the item was updated or changed.
lastModifiedUserId	number <int32> The last and then first name of the person that changed the item.
name	string Specifies the name of the item or person.
rowVersion	string
	object (cmc-nexus-common-entities-campusGroupEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"degreeLevel": 0,
"graduateLevel": "string",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"degreeLevel": 0,
"graduateLevel": "string",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Degree

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-degree-savenew-request-payload)

isExcludedCrmIntegration	boolean
id	number <int32> Id
campusGroupId	number <int32> The campus or campuses to which a person or item is assigned. If there is more than one campus, all the campuses are listed. In lists, if the column contains more than one campus, you cannot sort or filter on that column.
code	string The alpha numeric code assigned to the item by your institution.
createdDateTime	string <date-time> The date when the item or person was added or the status change was entered.
degreeLevel	number <int32> The degree level for Gainful Employment (GE) reporting. Levels that are followed by (nonGE) are degree levels that you can select for degrees for programs that do not meet GE requirements. The undergraduate levels are Undergraduate (nonGE), Undergraduate Certificate, Associate's Degree, Bachelor's Degree, Post-baccalaureate Certificate, Graduate/professional certificate, and Non-credential programs. The graduate levels are Graduate (nonGE), Professional (nonGE), Master's Degree, Post-master Certificate, Doctor - Research/Scholarship, Doctor - Professional Practice, Doctor - Other, and First-professional Degree.
graduateLevel	string Graduate Level
isActive	boolean Specifies whether or not the associated record is active.
lastModifiedDateTime	string <date-time> The date that the item was updated or changed.
lastModifiedUserId	number <int32> The last and then first name of the person that changed the item.
name	string Specifies the name of the item or person.
rowVersion	string
	object (cmc-nexus-common-entities-campusGroupEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"degreeLevel": 0,
"graduateLevel": "string",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"degreeLevel": 0,
"graduateLevel": "string",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

EnrollmentStatus

Create Enrollment Status

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"id": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"minimumCreditHours": { },
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Enrollment Status

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-enrollmentstatus-delete-request-payload)

id	number <int32> Id
code	string Code
createdDateTime	string <date-time> Created Date Time
isActive	boolean Is Active
isSystemCode	boolean Is System Code
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
minimumCreditHours	object Minimum Credit Hours
name	string Name
rowVersion	string
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"minimumCreditHours": { },
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Enrollment Status

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-enrollmentstatus-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"id": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"minimumCreditHours": { },
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Enrollment Status

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-enrollmentstatus-save-request-payload)

id	number <int32> Id
code	string Code
createdDateTime	string <date-time> Created Date Time
isActive	boolean Is Active
isSystemCode	boolean Is System Code
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
minimumCreditHours	object Minimum Credit Hours
name	string Name
rowVersion	string
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"minimumCreditHours": { },
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"id": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"minimumCreditHours": { },
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Enrollment Status

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-enrollmentstatus-savenew-request-payload)

id	number <int32> Id
code	string Code
createdDateTime	string <date-time> Created Date Time
isActive	boolean Is Active
isSystemCode	boolean Is System Code
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
minimumCreditHours	object Minimum Credit Hours
name	string Name
rowVersion	string
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"minimumCreditHours": { },
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"id": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"minimumCreditHours": { },
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Program

Copy Program

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-program-copyprogram-request-payload)

selectedProgramId	number <int32>
programName	string
programCode	string
isCopyToExistingProgram	boolean
copyToProgramIdList	Array of numbers <int32> [ items <int32 > ]
isName	boolean
isCode	boolean
isCIPCode	boolean
isActive	boolean
isAllowOnlineApplication	boolean
isProgramGroup	boolean
isDocument	boolean
isRequirementRule	boolean
isTest	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"selectedProgramId": 0,
"programName": "string",
"programCode": "string",
"isCopyToExistingProgram": true,
"copyToProgramIdList": [0
],
"isName": true,
"isCode": true,
"isCIPCode": true,
"isActive": true,
"isAllowOnlineApplication": true,
"isProgramGroup": true,
"isDocument": true,
"isRequirementRule": true,
"isTest": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"success": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Create Program

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"programGroupIds": [0
],
"documentTypeIds": [0
],
"requirementRuleIds": [0
],
"id": 0,
"allowOnlineApplications": true,
"approverStaffId": 0,
"cipCode": "string",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"currentYearCipCodeId": 0,
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Program

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-program-delete-request-payload)

isExcludedCrmIntegration	boolean
programGroupIds	Array of numbers <int32> [ items <int32 > ]
documentTypeIds	Array of numbers <int32> [ items <int32 > ]
requirementRuleIds	Array of numbers <int32> [ items <int32 > ]
id	number <int32> Id
allowOnlineApplications	boolean Allow Online Applications
approverStaffId	number <int32> Approver Staff Id
cipCode	string Cip Code
code	string Code
createdDateTime	string <date-time> Created Date Time
currentYearCipCodeId	number <int32> Current Year Cip Code Id
isActive	boolean Is Active
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
name	string Name
rowVersion	string
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"programGroupIds": [0
],
"documentTypeIds": [0
],
"requirementRuleIds": [0
],
"id": 0,
"allowOnlineApplications": true,
"approverStaffId": 0,
"cipCode": "string",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"currentYearCipCodeId": 0,
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Program

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-program-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"programGroupIds": [0
],
"documentTypeIds": [0
],
"requirementRuleIds": [0
],
"id": 0,
"allowOnlineApplications": true,
"approverStaffId": 0,
"cipCode": "string",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"currentYearCipCodeId": 0,
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Program

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-program-save-request-payload)

isExcludedCrmIntegration	boolean
programGroupIds	Array of numbers <int32> [ items <int32 > ]
documentTypeIds	Array of numbers <int32> [ items <int32 > ]
requirementRuleIds	Array of numbers <int32> [ items <int32 > ]
id	number <int32> Id
allowOnlineApplications	boolean Allow Online Applications
approverStaffId	number <int32> Approver Staff Id
cipCode	string Cip Code
code	string Code
createdDateTime	string <date-time> Created Date Time
currentYearCipCodeId	number <int32> Current Year Cip Code Id
isActive	boolean Is Active
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
name	string Name
rowVersion	string
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"programGroupIds": [0
],
"documentTypeIds": [0
],
"requirementRuleIds": [0
],
"id": 0,
"allowOnlineApplications": true,
"approverStaffId": 0,
"cipCode": "string",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"currentYearCipCodeId": 0,
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"programGroupIds": [0
],
"documentTypeIds": [0
],
"requirementRuleIds": [0
],
"id": 0,
"allowOnlineApplications": true,
"approverStaffId": 0,
"cipCode": "string",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"currentYearCipCodeId": 0,
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Credit Balance Configuration

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-program-savecreditbalanceconfiguration-request-payload)

Array of objects (cmc-nexus-academics-services-creditBalanceConfigurationRecord)

Array

programVersionId	number <int32>
creditBalanceScheduleDateType	string
creditBalanceScheduleDateTypeOffsetDays	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"creditBalanceConfigurationList": [{"programVersionId": 0,
"creditBalanceScheduleDateType": "string",
"creditBalanceScheduleDateTypeOffsetDays": 0
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"responseCode": "string",
"message": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Program

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-program-savenew-request-payload)

isExcludedCrmIntegration	boolean
programGroupIds	Array of numbers <int32> [ items <int32 > ]
documentTypeIds	Array of numbers <int32> [ items <int32 > ]
requirementRuleIds	Array of numbers <int32> [ items <int32 > ]
id	number <int32> Id
allowOnlineApplications	boolean Allow Online Applications
approverStaffId	number <int32> Approver Staff Id
cipCode	string Cip Code
code	string Code
createdDateTime	string <date-time> Created Date Time
currentYearCipCodeId	number <int32> Current Year Cip Code Id
isActive	boolean Is Active
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
name	string Name
rowVersion	string
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"programGroupIds": [0
],
"documentTypeIds": [0
],
"requirementRuleIds": [0
],
"id": 0,
"allowOnlineApplications": true,
"approverStaffId": 0,
"cipCode": "string",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"currentYearCipCodeId": 0,
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"programGroupIds": [0
],
"documentTypeIds": [0
],
"requirementRuleIds": [0
],
"id": 0,
"allowOnlineApplications": true,
"approverStaffId": 0,
"cipCode": "string",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"currentYearCipCodeId": 0,
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Program

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-program-saveprogram-request-payload)

	Array of objects (cmc-nexus-academics-entities-programEntity)
programId	number <int32>
programGroupIds	Array of numbers <int32> [ items <int32 > ]
cipCode	string
currentYearCipCodeId	number <int32>
name	string
code	string
isActive	boolean
allowOnlineApplication	boolean
entityState	number <int32>
isProgramGroupChanges	boolean
isCIPCodeUpdateToProgramVersion	boolean
isOverrideProgramGroupChanges	boolean
isProgramVersionRecordFound	boolean
requirementRuleIds	Array of numbers <int32> [ items <int32 > ]
documentTypeIds	Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"payload": {"programs": [{"isExcludedCrmIntegration": true,
"programGroupIds": [0
],
"documentTypeIds": [0
],
"requirementRuleIds": [0
],
"id": 0,
"allowOnlineApplications": true,
"approverStaffId": 0,
"cipCode": "string",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"currentYearCipCodeId": 0,
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"programId": 0,
"programGroupIds": [0
],
"cipCode": "string",
"currentYearCipCodeId": 0,
"name": "string",
"code": "string",
"isActive": true,
"allowOnlineApplication": true,
"entityState": 0,
"isProgramGroupChanges": true,
"isCIPCodeUpdateToProgramVersion": true,
"isOverrideProgramGroupChanges": true,
"isProgramVersionRecordFound": true,
"requirementRuleIds": [0
],
"documentTypeIds": [0
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"program": {"isExcludedCrmIntegration": true,
"programGroupIds": [0
],
"documentTypeIds": [0
],
"requirementRuleIds": [0
],
"id": 0,
"allowOnlineApplications": true,
"approverStaffId": 0,
"cipCode": "string",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"currentYearCipCodeId": 0,
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"programs": [{"isExcludedCrmIntegration": true,
"programGroupIds": [0
],
"documentTypeIds": [0
],
"requirementRuleIds": [0
],
"id": 0,
"allowOnlineApplications": true,
"approverStaffId": 0,
"cipCode": "string",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"currentYearCipCodeId": 0,
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"programId": 0,
"programGroupIds": [0
],
"cipCode": "string",
"currentYearCipCodeId": 0,
"name": "string",
"code": "string",
"isActive": true,
"allowOnlineApplication": true,
"entityState": 0,
"isProgramGroupChanges": true,
"isCIPCodeUpdateToProgramVersion": true,
"isCIPCodeOFProgramVersionDiffrentFromProgram": true,
"requirementRuleIds": [0
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Requirement Rule

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-program-saverequirementrule-request-payload)

programId	number <int32>
requirementRuleIds	Array of numbers <int32> [ items <int32 > ]
	Array of objects (cmc-nexus-academics-services-requirementRule)
isCopyRequirementRule	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"programId": 0,
"requirementRuleIds": [0
],
"requirementRuleList": [{"requirementRuleId": 0,
"programVersionId": 0,
"isRequirementRuleForProgram": true,
"requirementRuleOrder": 0
}
],
"isCopyRequirementRule": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"programRequirementRule": {"programId": 0,
"requirementRuleId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"ruleIdentifier": { },
"ruleOrder": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Registration

Evaluate Prereq Coreq Status

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-registration-evaluateprereqcoreqstatus-request-payload)

studentEnrollmentPeriodId	number <int32>
	Array of objects (cmc-nexus-academics-services-courseInfo)
businessProcessType	number <int32>
courseSectionStartDate	string <date-time>
pendingUnregCourseList	object
	Array of objects (cmc-nexus-academics-services-courseInfo)
	Array of objects (cmc-nexus-academics-entities-courseEntity)
	Array of objects (cmc-nexus-academics-entities-classSectionEntity)
ignoreMultiCourseDependency	boolean
failureMessageType	number <int32>
skipPrereqCheck	boolean
skipCoreqCheck	boolean
isAntireqCheckSkipped	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentEnrollmentPeriodId": 0,
"courseInfoList": [{"courseId": 0,
"courseSectionId": 0,
"termId": 0,
"studentCourseId": 0
}
],
"businessProcessType": 0,
"courseSectionStartDate": "2019-08-24T14:15:22Z",
"pendingUnregCourseList": { },
"pendingRegCourseList": [{"courseId": 0,
"courseSectionId": 0,
"termId": 0,
"studentCourseId": 0
}
],
"inputCourseList": [{"campusIdList": [0
],
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"coursePrefixCourseAssociationIdList": [0
],
"coursePrefixCourseAssociationList": [{"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"coursePrefixCodeList": [{"coursePrefixCourseAssociation": {"id": 0,
"courseId": 0,
"coursePrefixCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"campusIdList": [0
],
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"id": 0,
"addDropDays": { },
"adDependentCourseId": 0,
"allowOverride": true,
"allowRetakeOverride": true,
"campusGroupId": 0,
"catalogCode": "string",
"clockHours": 0,
"code": "string",
"compareContactHrsWithClsSched": true,
"courseLevelId": 0,
"courseTypeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"defaultMaxNumOfRepeat": 0,
"defaultPassFailSetting": { },
"enrollStatusCredits": 0,
"enrollStatusHours": 0,
"gradeLevel": { },
"incompleteGradeExpirationDays": 0,
"isActive": true,
"isAddDropDaysBasedOnCalenderDays": true,
"isCourseRemedial": true,
"isDependent": true,
"isExcludeDropsFromAttemptsCount": true,
"isRetakeFee": true,
"isSupplementaryCourse": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"loadMethod": "string",
"matchOverrideCredits": true,
"maximumCredits": 0,
"maximumDays": { },
"maximumNumWithoutRetakeFee": 0,
"maxNumberAssignments": 0,
"minimumCredits": 0,
"minimumDays": { },
"name": "string",
"note": "string",
"outsideCourseWorkHours": 0,
"retakeAssessmentType": "string",
"rowVersion": "string",
"supplementaryAssessmentType": "string",
"unitType": "string",
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"wlmLoadTypes": [{"loadTypeName": "string",
"earningCodeName": "string",
"measurementUnitName": "string",
"id": 0,
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"defaultValue": 0,
"isLoadTracked": true,
"isOverrideAllowed": true,
"isPayTracked": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"wlmEarningCodeId": 0,
"wlmLoadTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"inputClassSectionList": [{"isUpdateStudentSchedules": true,
"isUpdateStudentSchedulesConfirmation": true,
"isUpdateStudentSchedulesConfirmationProvided": true,
"isSchedulePeriodDeleteConfirmation": true,
"cantDeleteTerms": "string",
"updateStudentsInCourseSection": true,
"scheduleStartDate": "2019-08-24T14:15:22Z",
"scheduleEndDate": "2019-08-24T14:15:22Z",
"crsgCrossReferenceCampuses": [{"id": 0,
"isCRSG": true,
"name": "string"
}
],
"isContactHoursConfirmed": true,
"isRequireLDAConfirmed": true,
"requireContactHoursConfirmation": true,
"requireLDAConfirmation": true,
"isRequireChangeInWlmAssignment": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"addedClassSectionId": 0,
"allowCreditsHoursOverride": true,
"allowReservations": true,
"attendanceLastPostedDate": "2019-08-24T14:15:22Z",
"autoDropConsecutiveHoursAbsent": 0,
"autoDropCumulativeHoursAbsent": 0,
"autoDropPercentageHoursAbsent": 0,
"autoWarningConsecutiveHoursAbsent": 0,
"autoWarningCumulativeHoursAbsent": 0,
"autoWarningPercentageHoursAbsent": 0,
"campusId": 0,
"classSchedLength": 0,
"clockHours": 0,
"courseCode": "string",
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"daysFlag": 0,
"deliveryMethodId": 0,
"dropEndDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"finalCountDropStudents": 0,
"finalCountRegisteredStudents": 0,
"hideFaculty": true,
"hideLocation": true,
"instructorId": 0,
"isActive": true,
"isAddDropDateOverride": true,
"isAuditAdvisementRequired": true,
"isAutoDropEnforcedAfterLdw": true,
"isAutoWarningOnClassRosterAfterLdw": true,
"isBlindGrading": true,
"isCancelled": true,
"isClassSectionAutoAdded": true,
"isLdwOverride": true,
"isMeetingOnIrregularDaysTimes": true,
"isStudentSpecificMeetingSchedule": true,
"isWaitlistExpiredOrCleared": true,
"isWaitListingAllowed": true,
"lastDayToWithdrawDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lmsExtractStatus": "string",
"lmsVendorId": 0,
"loadMethod": "string",
"makeUpMaxType": "string",
"makeUpMaxValue": 0,
"maximumCredits": 0,
"maximumStudents": 0,
"maxNumberAssignments": 0,
"maxNumberSectionsAllowed": 0,
"minimumCredits": 0,
"nextAttendanceDate": "2019-08-24T14:15:22Z",
"note": "string",
"numberRegisteredStudents": 0,
"passFailSetting": { },
"postAttendanceType": "string",
"rowVersion": "string",
"secondSectionCode": "string",
"sectionCode": "string",
"sectionName": "string",
"sendToLms": true,
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"studentSpecificMeetingScheduleDefaultMinutes": 0,
"syllabusDocument": "string",
"thresholdNumberOfSeats": { },
"thresholdType": true,
"unregisterEndDate": "2019-08-24T14:15:22Z",
"waitListMaximumSeats": 0,
"wlmActivityTypeId": 0,
"wlmAssignmentTypeId": 0,
"wlmDepartmentId": 0,
"meetingPatterns": [{"meetingPattern": {"id": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"frequency": { },
"isMeetingOnFriday": true,
"isMeetingOnMonday": true,
"isMeetingOnSaturday": true,
"isMeetingOnSunday": true,
"isMeetingOnThursday": true,
"isMeetingOnTuesday": true,
"isMeetingOnWednesday": true,
"isRecurrenceEnding": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingLength": { },
"patternType": "string",
"recurrenceEndNumber": { },
"recurrenceStartWeeks": { },
"rowVersion": "string",
"startTime": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"dayOfWeekRooms": [{"dayOfWeek": 0,
"roomId": 0,
"roomCode": "string",
"roomName": "string",
"buildingId": 0,
"buildingCode": "string",
"buildingName": "string",
"locationId": 0,
"locationName": "string"
}
],
"isConflict": true,
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"meetingPatternId": 0,
"rowVersion": "string",
"type": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"terms": [{"termName": "string",
"id": 0,
"classSectionId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"ignoreMultiCourseDependency": true,
"failureMessageType": 0,
"skipPrereqCheck": true,
"skipCoreqCheck": true,
"isAntireqCheckSkipped": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"prereqCoreqStatusSummaryInfoMessageList": [{"summaryInfoMessageId": 0,
"classSectionId": 0,
"courseId": 0,
"prereqCheckStatus": 0,
"coreqCheckStatus": 0,
"prereqFailureMessage": "string",
"coreqFailureMessage": "string",
"prereqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"coreqFailureInfoMessagList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"antireqFailureMessage": "string",
"antireqCheckStatus": 0,
"antireqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
]
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Evaluate Registration Locks

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-registration-evaluateregistrationlocks-request-payload)

studentId	number <int32>
	Array of objects (cmc-nexus-academics-services-registrationRuleCourseInfoInput)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentId": 0,
"registrationRuleCourseInfoInputList": [{"action": 0,
"termId": 0,
"parentTermId": 0,
"studentCourseId": 0,
"classSectionId": 0,
"courseId": 0,
"isAuditCourse": true,
"credits": 0,
"hours": 0,
"enrollStatusCredits": 0,
"enrollStatusHours": 0
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"registrationRuleCourseInfoOutputList": [{"termId": 0,
"termCode": "string",
"isSuccess": true,
"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
]
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

SchoolStartDate

Create School Start Date

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"isExcludedCrmIntegration": true,
"id": 0,
"budgetedShow": 0,
"budgetStarts": { },
"budgetTuition": 0,
"campusGroupId": 0,
"cancelDate": "2019-08-24T14:15:22Z",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"expectedGradDate": "2019-08-24T14:15:22Z",
"externshipStartDate": "2019-08-24T14:15:22Z",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"maxBudgetStarts": { },
"maxGradDate": "2019-08-24T14:15:22Z",
"midPointDate": "2019-08-24T14:15:22Z",
"minBudgetStarts": { },
"name": "string",
"programVersionId": 0,
"rowVersion": "string",
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete School Start Date

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-schoolstartdate-delete-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
isExcludedCrmIntegration	boolean
id	number <int32> Id
budgetedShow	number <double> Budgeted Show
budgetStarts	object Budget Starts
budgetTuition	number <double> Budget Tuition
campusGroupId	number <int32> Campus Group Id
cancelDate	string <date-time> Cancel Date
code	string Code
createdDateTime	string <date-time> Created Date Time
expectedGradDate	string <date-time> Expected Grad Date
externshipStartDate	string <date-time> Externship Start Date
isActive	boolean Is Active
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
maxBudgetStarts	object Max Budget Starts
maxGradDate	string <date-time> Max Grad Date
midPointDate	string <date-time> Mid Point Date
minBudgetStarts	object Min Budget Starts
name	string Name
programVersionId	number <int32> Program Version Id
rowVersion	string
shiftId	number <int32> Shift Id
startDate	string <date-time> Start Date
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"isExcludedCrmIntegration": true,
"id": 0,
"budgetedShow": 0,
"budgetStarts": { },
"budgetTuition": 0,
"campusGroupId": 0,
"cancelDate": "2019-08-24T14:15:22Z",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"expectedGradDate": "2019-08-24T14:15:22Z",
"externshipStartDate": "2019-08-24T14:15:22Z",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"maxBudgetStarts": { },
"maxGradDate": "2019-08-24T14:15:22Z",
"midPointDate": "2019-08-24T14:15:22Z",
"minBudgetStarts": { },
"name": "string",
"programVersionId": 0,
"rowVersion": "string",
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get School Start Date

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-schoolstartdate-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"isExcludedCrmIntegration": true,
"id": 0,
"budgetedShow": 0,
"budgetStarts": { },
"budgetTuition": 0,
"campusGroupId": 0,
"cancelDate": "2019-08-24T14:15:22Z",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"expectedGradDate": "2019-08-24T14:15:22Z",
"externshipStartDate": "2019-08-24T14:15:22Z",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"maxBudgetStarts": { },
"maxGradDate": "2019-08-24T14:15:22Z",
"midPointDate": "2019-08-24T14:15:22Z",
"minBudgetStarts": { },
"name": "string",
"programVersionId": 0,
"rowVersion": "string",
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save School Start Date

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-schoolstartdate-save-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
isExcludedCrmIntegration	boolean
id	number <int32> Id
budgetedShow	number <double> Budgeted Show
budgetStarts	object Budget Starts
budgetTuition	number <double> Budget Tuition
campusGroupId	number <int32> Campus Group Id
cancelDate	string <date-time> Cancel Date
code	string Code
createdDateTime	string <date-time> Created Date Time
expectedGradDate	string <date-time> Expected Grad Date
externshipStartDate	string <date-time> Externship Start Date
isActive	boolean Is Active
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
maxBudgetStarts	object Max Budget Starts
maxGradDate	string <date-time> Max Grad Date
midPointDate	string <date-time> Mid Point Date
minBudgetStarts	object Min Budget Starts
name	string Name
programVersionId	number <int32> Program Version Id
rowVersion	string
shiftId	number <int32> Shift Id
startDate	string <date-time> Start Date
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"isExcludedCrmIntegration": true,
"id": 0,
"budgetedShow": 0,
"budgetStarts": { },
"budgetTuition": 0,
"campusGroupId": 0,
"cancelDate": "2019-08-24T14:15:22Z",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"expectedGradDate": "2019-08-24T14:15:22Z",
"externshipStartDate": "2019-08-24T14:15:22Z",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"maxBudgetStarts": { },
"maxGradDate": "2019-08-24T14:15:22Z",
"midPointDate": "2019-08-24T14:15:22Z",
"minBudgetStarts": { },
"name": "string",
"programVersionId": 0,
"rowVersion": "string",
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"isExcludedCrmIntegration": true,
"id": 0,
"budgetedShow": 0,
"budgetStarts": { },
"budgetTuition": 0,
"campusGroupId": 0,
"cancelDate": "2019-08-24T14:15:22Z",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"expectedGradDate": "2019-08-24T14:15:22Z",
"externshipStartDate": "2019-08-24T14:15:22Z",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"maxBudgetStarts": { },
"maxGradDate": "2019-08-24T14:15:22Z",
"midPointDate": "2019-08-24T14:15:22Z",
"minBudgetStarts": { },
"name": "string",
"programVersionId": 0,
"rowVersion": "string",
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Deactivate Starts Date

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-schoolstartdate-savedeactivatestartsdate-request-payload)

deactivateStartDatesIdList

Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"payload": {"deactivateStartDatesIdList": [0
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New School Start Date

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-schoolstartdate-savenew-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
isExcludedCrmIntegration	boolean
id	number <int32> Id
budgetedShow	number <double> Budgeted Show
budgetStarts	object Budget Starts
budgetTuition	number <double> Budget Tuition
campusGroupId	number <int32> Campus Group Id
cancelDate	string <date-time> Cancel Date
code	string Code
createdDateTime	string <date-time> Created Date Time
expectedGradDate	string <date-time> Expected Grad Date
externshipStartDate	string <date-time> Externship Start Date
isActive	boolean Is Active
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
maxBudgetStarts	object Max Budget Starts
maxGradDate	string <date-time> Max Grad Date
midPointDate	string <date-time> Mid Point Date
minBudgetStarts	object Min Budget Starts
name	string Name
programVersionId	number <int32> Program Version Id
rowVersion	string
shiftId	number <int32> Shift Id
startDate	string <date-time> Start Date
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"isExcludedCrmIntegration": true,
"id": 0,
"budgetedShow": 0,
"budgetStarts": { },
"budgetTuition": 0,
"campusGroupId": 0,
"cancelDate": "2019-08-24T14:15:22Z",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"expectedGradDate": "2019-08-24T14:15:22Z",
"externshipStartDate": "2019-08-24T14:15:22Z",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"maxBudgetStarts": { },
"maxGradDate": "2019-08-24T14:15:22Z",
"midPointDate": "2019-08-24T14:15:22Z",
"minBudgetStarts": { },
"name": "string",
"programVersionId": 0,
"rowVersion": "string",
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"isExcludedCrmIntegration": true,
"id": 0,
"budgetedShow": 0,
"budgetStarts": { },
"budgetTuition": 0,
"campusGroupId": 0,
"cancelDate": "2019-08-24T14:15:22Z",
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"expectedGradDate": "2019-08-24T14:15:22Z",
"externshipStartDate": "2019-08-24T14:15:22Z",
"isActive": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"maxBudgetStarts": { },
"maxGradDate": "2019-08-24T14:15:22Z",
"midPointDate": "2019-08-24T14:15:22Z",
"minBudgetStarts": { },
"name": "string",
"programVersionId": 0,
"rowVersion": "string",
"shiftId": 0,
"startDate": "2019-08-24T14:15:22Z",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Shift

Create Shift

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Shift

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-shift-delete-request-payload)

isExcludedCrmIntegration	boolean
id	number <int32> Id
campusGroupId	number <int32> The campus or campuses to which a person or item is assigned. If there is more than one campus, all the campuses are listed. In lists, if the column contains more than one campus, you cannot sort or filter on that column.
code	string The alpha numeric code assigned to the item by your institution.
createdDateTime	string <date-time> The date when the item or person was added or the status change was entered.
isActive	boolean Specifies whether or not the associated record is active.
isSystemCode	boolean Specifies whether or not the value is system-defined. Yes indicates that the item is defined by CampusNexus student. No indicates that your institution added the item. You cannot edit, delete, or deactivate items that are system-defined.
lastModifiedDateTime	string <date-time> The date that the item was updated or changed.
lastModifiedUserId	number <int32> The last and then first name of the person that changed the item.
name	string Specifies the name of the item or person.
rowVersion	string
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Shift

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-shift-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Shift

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-shift-save-request-payload)

isExcludedCrmIntegration	boolean
id	number <int32> Id
campusGroupId	number <int32> The campus or campuses to which a person or item is assigned. If there is more than one campus, all the campuses are listed. In lists, if the column contains more than one campus, you cannot sort or filter on that column.
code	string The alpha numeric code assigned to the item by your institution.
createdDateTime	string <date-time> The date when the item or person was added or the status change was entered.
isActive	boolean Specifies whether or not the associated record is active.
isSystemCode	boolean Specifies whether or not the value is system-defined. Yes indicates that the item is defined by CampusNexus student. No indicates that your institution added the item. You cannot edit, delete, or deactivate items that are system-defined.
lastModifiedDateTime	string <date-time> The date that the item was updated or changed.
lastModifiedUserId	number <int32> The last and then first name of the person that changed the item.
name	string Specifies the name of the item or person.
rowVersion	string
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Shift

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-shift-savenew-request-payload)

isExcludedCrmIntegration	boolean
id	number <int32> Id
campusGroupId	number <int32> The campus or campuses to which a person or item is assigned. If there is more than one campus, all the campuses are listed. In lists, if the column contains more than one campus, you cannot sort or filter on that column.
code	string The alpha numeric code assigned to the item by your institution.
createdDateTime	string <date-time> The date when the item or person was added or the status change was entered.
isActive	boolean Specifies whether or not the associated record is active.
isSystemCode	boolean Specifies whether or not the value is system-defined. Yes indicates that the item is defined by CampusNexus student. No indicates that your institution added the item. You cannot edit, delete, or deactivate items that are system-defined.
lastModifiedDateTime	string <date-time> The date that the item was updated or changed.
lastModifiedUserId	number <int32> The last and then first name of the person that changed the item.
name	string Specifies the name of the item or person.
rowVersion	string
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

StudentCourse

Associate Student Enrollment

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-associatestudentenrollment-request-payload)

studentEnrollmentScheduleId	number <int32>
currentStudentEnrollmentPeriodId	number <int32>
newStudentEnrollmentPeriodId	number <int32>
isAllowedToAssociateExistingCourse	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentEnrollmentScheduleId": 0,
"currentStudentEnrollmentPeriodId": 0,
"newStudentEnrollmentPeriodId": 0,
"isAllowedToAssociateExistingCourse": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentEnrollmentScheduleId": 0,
"currentStudentEnrollmentPeriodId": 0,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Batch Post Final Grade

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-batchpostfinalgrade-request-payload)

Array of objects (cmc-nexus-academics-services-studentCourseFinalGradeRoster)

Array

studentEnrollmentPeriodId	number <int32>
studentId	number <int32>
studentName	string
studentCourseId required	number <int32>
studentCourseStatus	string
letterGrade	string
numericGrade	number <double>
speed	object
transcriptNote	string
studentEnrollmentPeriodGradeScaleId	number <int32>
isBlindGrading	boolean
bgRndSetIdentifier	number <int32>
ssn	string
schoolStatusCode	string
isAudit	boolean
inProgressGrade	number <double>
expectedDeadlineDate	string <date-time>
isIncompleteGradeReplaced	boolean
finalGradeReasonId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentCourseFinalGradeRosterList": [{"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentName": "string",
"studentCourseId": 0,
"studentCourseStatus": "string",
"letterGrade": "string",
"numericGrade": 0,
"speed": { },
"transcriptNote": "string",
"studentEnrollmentPeriodGradeScaleId": 0,
"isBlindGrading": true,
"bgRndSetIdentifier": 0,
"ssn": "string",
"schoolStatusCode": "string",
"isAudit": true,
"inProgressGrade": 0,
"expectedDeadlineDate": "2019-08-24T14:15:22Z",
"isIncompleteGradeReplaced": true,
"finalGradeReasonId": 0
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Convert To Audit Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-converttoauditcourse-request-payload)

isRetakeOverride	boolean
effectiveDateLaterOverride	boolean
studentCourseId	number <int32>
studentId	number <int32>
effectiveDate	string <date-time>
isAllowedToOverrideRegistrationConflict	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isRetakeOverride": true,
"effectiveDateLaterOverride": true,
"studentCourseId": 0,
"studentId": 0,
"effectiveDate": "2019-08-24T14:15:22Z",
"isAllowedToOverrideRegistrationConflict": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isAllowedRegisterAsAuditClass": true,
"isRetakeOverride": true,
"isAllowedDateTimeConflict": true,
"isAllowedMaxClassSizeRegisterOverride": true,
"isReservedStatus": true,
"isAllowedToWaitListStudent": true,
"allowCompletedLessons": true,
"allowDeletedOnSectionTransfer": true,
"isAddDropPeriodClassSectionAllowed": true,
"isAutoAddMsg": true,
"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"prereqCoreqStatusSummaryInfoMessageList": [{"summaryInfoMessageId": 0,
"classSectionId": 0,
"courseId": 0,
"prereqCheckStatus": 0,
"coreqCheckStatus": 0,
"prereqFailureMessage": "string",
"coreqFailureMessage": "string",
"prereqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"coreqFailureInfoMessagList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"antireqFailureMessage": "string",
"antireqCheckStatus": 0,
"antireqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
]
}
],
"impectedCourseDetails": [{"studentCourseId": 0,
"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"addDropCourseDetails": {"message": "string",
"disable": true
}
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Create Student Course

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"transcripNote": "string",
"isCrsg": true,
"studentEnrollmentPeriodIdList": [0
],
"studentEnrollmentDpaCourseCategoryId": 0,
"campusId": 0,
"studentTransferCreditMultipleCourseAssociationId": 0,
"studentTransferCreditMultipleId": 0,
"id": 0,
"academicYear": { },
"adEnrollRegistrationId": 0,
"advisedDate": "2019-08-24T14:15:22Z",
"appealType": "string",
"auditEffectiveDate": "2019-08-24T14:15:22Z",
"averageBestOfPercentFinal": 0,
"billedDate": "2019-08-24T14:15:22Z",
"classSectionId": 0,
"clockHours": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"collegeId": 0,
"consecutiveMinutesAbsent": 0,
"cost": 0,
"courseAddedFrom": "string",
"courseFeeScheduleId": 0,
"courseId": 0,
"courseName": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"crossReferenceCourseId": 0,
"dateReqMet": "2019-08-24T14:15:22Z",
"dependentClassSectionId": 0,
"dropDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"examRegistrationComments": "string",
"examStatus": "string",
"expectedDeadlineDate": "2019-08-24T14:15:22Z",
"expectedEndDate": "2019-08-24T14:15:22Z",
"facultyPostedLda": "2019-08-24T14:15:22Z",
"faStudentAyPaymentPeriodId": 0,
"finalGradeReasonId": 0,
"gradePoints": 0,
"gradePostedDate": "2019-08-24T14:15:22Z",
"gradeScaleId": 0,
"highSchoolId": 0,
"include": true,
"incompleteGradeNote": "string",
"inProgressGrade": 0,
"isAfterAddDrop": true,
"isAuditCourse": true,
"isAutoDrop": true,
"isCostScheduled": true,
"isCourseRefundPolicyUsed": true,
"isCrossReferencedCourse": true,
"isEnrollmentAdjusted": true,
"isExtended": true,
"isExtensionBilled": "2019-08-24T14:15:22Z",
"isFromPortal": true,
"isGlobalCumulativeIncluded": true,
"isHalfTicketGenerated": true,
"isIncludedInGpaCalc": true,
"isIncompleteGradeReplaced": true,
"isOnlyRateScheduleUsed": true,
"isPassFail": true,
"isSpecialExam": true,
"isStudentDegreePathwayCourse": true,
"isSubstitute": true,
"isTransferCredit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"letterGrade": "string",
"lmsExtractStatus": "string",
"makeUpMinutes": 0,
"midTermGradeNote": "string",
"midTermGradePostedDate": "2019-08-24T14:15:22Z",
"midTermLetterGrade": "string",
"midTermNumericGrade": 0,
"minutesAbsent": 0,
"minutesAttended": 0,
"modFlag": "string",
"note": "string",
"numericGrade": 0,
"outsideCourseWorkHours": 0,
"overrideCourseProgression": "string",
"payStatus": "string",
"previousStatus": "string",
"qualityPoints": 0,
"requiredCourseId": 0,
"retakeFeeWaived": "string",
"retakeFlag": "string",
"retakeOverride": true,
"retakeTiv2CredEarnValue": 0,
"retakeTiv2CredEarnZeroed": true,
"revenueReferenceNumber": "string",
"rosterFlag": "string",
"rowVersion": "string",
"speed": { },
"startDate": "2019-08-24T14:15:22Z",
"status": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentTransferCreditId": 0,
"substituteCourseId": 0,
"supplementaryStatus": "string",
"termId": 0,
"testingScheduleId": 0,
"transcriptNote": "string",
"transferredCourseCode": "string",
"transferredCourseDescrip": "string",
"transferTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Student Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-delete-request-payload)

transcripNote	string
isCrsg	boolean
studentEnrollmentPeriodIdList	Array of numbers <int32> [ items <int32 > ]
studentEnrollmentDpaCourseCategoryId	number <int32>
campusId	number <int32>
studentTransferCreditMultipleCourseAssociationId	number <int32>
studentTransferCreditMultipleId	number <int32>
id	number <int32> Id
academicYear	object Academic Year
adEnrollRegistrationId	number <int32> Ad Enroll Registration Id
advisedDate	string <date-time> Advised Date
appealType	string Appeal Type
auditEffectiveDate	string <date-time> Audit Effective Date
averageBestOfPercentFinal	number <double> Average Best Of Percent Final
billedDate	string <date-time> Billed Date
classSectionId	number <int32> Class Section Id
clockHours	number <double> Clock Hours
clockHoursAttempted	number <double> Clock Hours Attempted
clockHoursEarned	number <double> Clock Hours Earned
collegeId	number <int32> College Id
consecutiveMinutesAbsent	number <double> Consecutive Minutes Absent
cost	number <double> Cost
courseAddedFrom	string Course Added From
courseFeeScheduleId	number <int32> Course Fee Schedule Id
courseId	number <int32> Course Id
courseName	string Course Name
createdDateTime	string <date-time> Created Date Time
creditHours	number <double> Credit Hours
creditHoursAttempted	number <double> Credit Hours Attempted
creditHoursEarned	number <double> Credit Hours Earned
crossReferenceCourseId	number <int32> Cross Reference Course Id
dateReqMet	string <date-time> Date Req Met
dependentClassSectionId	number <int32> Dependent Class Section Id
dropDate	string <date-time> Drop Date
endDate	string <date-time> End Date
enrollmentStatusClockHours	number <double> Enrollment Status Clock Hours
enrollmentStatusCreditHours	number <double> Enrollment Status Credit Hours
examRegistrationComments	string Exam Registration Comments
examStatus	string Exam Status
expectedDeadlineDate	string <date-time> Expected Deadline Date
expectedEndDate	string <date-time> Expected End Date
facultyPostedLda	string <date-time> Faculty Posted Lda
faStudentAyPaymentPeriodId	number <int32> Fa Student Ay Payment Period Id
finalGradeReasonId	number <int32> Final Grade Reason Id
gradePoints	number <double> Grade Points
gradePostedDate	string <date-time> Grade Posted Date
gradeScaleId	number <int32> Grade Scale Id
highSchoolId	number <int32> High School Id
include	boolean Include
incompleteGradeNote	string Incomplete Grade Note
inProgressGrade	number <double> In Progress Grade
isAfterAddDrop	boolean Is After Add Drop
isAuditCourse	boolean Is Audit Course
isAutoDrop	boolean Is Auto Drop
isCostScheduled	boolean Is Cost Scheduled
isCourseRefundPolicyUsed	boolean Is Course Refund Policy Used
isCrossReferencedCourse	boolean Is Cross Referenced Course
isEnrollmentAdjusted	boolean Is Enrollment Adjusted
isExtended	boolean Is Extended
isExtensionBilled	string <date-time> Is Extension Billed
isFromPortal	boolean Is From Portal
isGlobalCumulativeIncluded	boolean Is Global Cumulative Included
isHalfTicketGenerated	boolean Is Half Ticket Generated
isIncludedInGpaCalc	boolean Is Included In Gpa Calc
isIncompleteGradeReplaced	boolean Is Incomplete Grade Replaced
isOnlyRateScheduleUsed	boolean Is Only Rate Schedule Used
isPassFail	boolean Is Pass Fail
isSpecialExam	boolean Is Special Exam
isStudentDegreePathwayCourse	boolean Is Student Degree Pathway Course
isSubstitute	boolean Is Substitute
isTransferCredit	boolean Is Transfer Credit
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
lda	string <date-time> Lda
letterGrade	string Letter Grade
lmsExtractStatus	string Lms Extract Status
makeUpMinutes	number <int32> Make Up Minutes
midTermGradeNote	string Mid Term Grade Note
midTermGradePostedDate	string <date-time> Mid Term Grade Posted Date
midTermLetterGrade	string Mid Term Letter Grade
midTermNumericGrade	number <double> Mid Term Numeric Grade
minutesAbsent	number <int32> Minutes Absent
minutesAttended	number <int32> Minutes Attended
modFlag	string Mod Flag
note	string Note
numericGrade	number <double> Numeric Grade
outsideCourseWorkHours	number <double> Outside Course Work Hours
overrideCourseProgression	string Override Course Progression
payStatus	string Pay Status
previousStatus	string Previous Status
qualityPoints	number <double> Quality Points
requiredCourseId	number <int32> Required Course Id
retakeFeeWaived	string Retake Fee Waived
retakeFlag	string Retake Flag
retakeOverride	boolean Retake Override
retakeTiv2CredEarnValue	number <double> Retake Tiv2Cred Earn Value
retakeTiv2CredEarnZeroed	boolean Retake Tiv2Cred Earn Zeroed
revenueReferenceNumber	string Revenue Reference Number
rosterFlag	string Roster Flag
rowVersion	string
speed	object Speed
startDate	string <date-time> Start Date
status	string Status
studentEnrollmentPeriodId	number <int32> Student Enrollment Period Id
studentId	number <int32> Student Id
studentTransferCreditId	number <int32> Student Transfer Credit Id
substituteCourseId	number <int32> Substitute Course Id
supplementaryStatus	string Supplementary Status
termId	number <int32> Term Id
testingScheduleId	number <int32> Testing Schedule Id
transcriptNote	string Transcript Note
transferredCourseCode	string Transferred Course Code
transferredCourseDescrip	string Transferred Course Descrip
transferTypeId	number <int32> Transfer Type Id
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"transcripNote": "string",
"isCrsg": true,
"studentEnrollmentPeriodIdList": [0
],
"studentEnrollmentDpaCourseCategoryId": 0,
"campusId": 0,
"studentTransferCreditMultipleCourseAssociationId": 0,
"studentTransferCreditMultipleId": 0,
"id": 0,
"academicYear": { },
"adEnrollRegistrationId": 0,
"advisedDate": "2019-08-24T14:15:22Z",
"appealType": "string",
"auditEffectiveDate": "2019-08-24T14:15:22Z",
"averageBestOfPercentFinal": 0,
"billedDate": "2019-08-24T14:15:22Z",
"classSectionId": 0,
"clockHours": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"collegeId": 0,
"consecutiveMinutesAbsent": 0,
"cost": 0,
"courseAddedFrom": "string",
"courseFeeScheduleId": 0,
"courseId": 0,
"courseName": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"crossReferenceCourseId": 0,
"dateReqMet": "2019-08-24T14:15:22Z",
"dependentClassSectionId": 0,
"dropDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"examRegistrationComments": "string",
"examStatus": "string",
"expectedDeadlineDate": "2019-08-24T14:15:22Z",
"expectedEndDate": "2019-08-24T14:15:22Z",
"facultyPostedLda": "2019-08-24T14:15:22Z",
"faStudentAyPaymentPeriodId": 0,
"finalGradeReasonId": 0,
"gradePoints": 0,
"gradePostedDate": "2019-08-24T14:15:22Z",
"gradeScaleId": 0,
"highSchoolId": 0,
"include": true,
"incompleteGradeNote": "string",
"inProgressGrade": 0,
"isAfterAddDrop": true,
"isAuditCourse": true,
"isAutoDrop": true,
"isCostScheduled": true,
"isCourseRefundPolicyUsed": true,
"isCrossReferencedCourse": true,
"isEnrollmentAdjusted": true,
"isExtended": true,
"isExtensionBilled": "2019-08-24T14:15:22Z",
"isFromPortal": true,
"isGlobalCumulativeIncluded": true,
"isHalfTicketGenerated": true,
"isIncludedInGpaCalc": true,
"isIncompleteGradeReplaced": true,
"isOnlyRateScheduleUsed": true,
"isPassFail": true,
"isSpecialExam": true,
"isStudentDegreePathwayCourse": true,
"isSubstitute": true,
"isTransferCredit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"letterGrade": "string",
"lmsExtractStatus": "string",
"makeUpMinutes": 0,
"midTermGradeNote": "string",
"midTermGradePostedDate": "2019-08-24T14:15:22Z",
"midTermLetterGrade": "string",
"midTermNumericGrade": 0,
"minutesAbsent": 0,
"minutesAttended": 0,
"modFlag": "string",
"note": "string",
"numericGrade": 0,
"outsideCourseWorkHours": 0,
"overrideCourseProgression": "string",
"payStatus": "string",
"previousStatus": "string",
"qualityPoints": 0,
"requiredCourseId": 0,
"retakeFeeWaived": "string",
"retakeFlag": "string",
"retakeOverride": true,
"retakeTiv2CredEarnValue": 0,
"retakeTiv2CredEarnZeroed": true,
"revenueReferenceNumber": "string",
"rosterFlag": "string",
"rowVersion": "string",
"speed": { },
"startDate": "2019-08-24T14:15:22Z",
"status": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentTransferCreditId": 0,
"substituteCourseId": 0,
"supplementaryStatus": "string",
"termId": 0,
"testingScheduleId": 0,
"transcriptNote": "string",
"transferredCourseCode": "string",
"transferredCourseDescrip": "string",
"transferTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Student Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-deletestudentcourse-request-payload)

studentCourseId	number <int32>
minutesAttended	number <int32>
minutesAbsent	number <int32>
allowDeleteAttendanceHistory	boolean
allowDeletePendingCharges	boolean
isPendingCharges	boolean
termId	number <int32>
isAllowedToOverrideClosedTerm	boolean
action	number <int32>
isAddDropPeriodClassSectionAllowed	boolean
isAllowedToOverrideRegistrationConflict	boolean
courseStatusChangeReasonId	number <int32>
skipCoreqCheck	boolean
skipPrereqCheck	boolean
failureMessageType	number <int32>
ignoreMultiCourseDependency	boolean
allowOverrideRegistrationPrereqCoreqConflict	boolean
termCode	string
section	string
campusId	number <int32>
notifyStudent	boolean
allowedOnlyParent	boolean
isTermValidationSkipped	boolean
isAntireqCheckSkipped	boolean
currentCourseStatus	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentCourseId": 0,
"minutesAttended": 0,
"minutesAbsent": 0,
"allowDeleteAttendanceHistory": true,
"allowDeletePendingCharges": true,
"isPendingCharges": true,
"termId": 0,
"isAllowedToOverrideClosedTerm": true,
"action": 0,
"isAddDropPeriodClassSectionAllowed": true,
"isAllowedToOverrideRegistrationConflict": true,
"courseStatusChangeReasonId": 0,
"skipCoreqCheck": true,
"skipPrereqCheck": true,
"failureMessageType": 0,
"ignoreMultiCourseDependency": true,
"allowOverrideRegistrationPrereqCoreqConflict": true,
"termCode": "string",
"section": "string",
"campusId": 0,
"notifyStudent": true,
"allowedOnlyParent": true,
"isTermValidationSkipped": true,
"isAntireqCheckSkipped": true,
"currentCourseStatus": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"prereqCoreqStatusSummaryInfoMessageList": [{"summaryInfoMessageId": 0,
"classSectionId": 0,
"courseId": 0,
"prereqCheckStatus": 0,
"coreqCheckStatus": 0,
"prereqFailureMessage": "string",
"coreqFailureMessage": "string",
"prereqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"coreqFailureInfoMessagList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"antireqFailureMessage": "string",
"antireqCheckStatus": 0,
"antireqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
]
}
],
"allowDeleteAttendanceHistory": true,
"allowDeletePendingCharges": true,
"isPendingCharges": true,
"isAllowedToOverrideClosedTerm": true,
"isAddDropPeriodClassSectionAllowed": true,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Drop Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-dropcourse-request-payload)

studentEnrollmentScheduleId	number <int32>
dropDate	string <date-time>
letterGrade	string
dropReasonId	number <int32>
isAllowedToOverrideRegistrationConflict	boolean
skipCoreqCheck	boolean
skipPrereqCheck	boolean
ignoreMultiCourseDependency	boolean
allowOverrideRegistrationPrereqCoreqConflict	boolean
failureMessageType	number <int32>
isAddDropPeriodClassSectionAllowed	boolean
allowOverrideClosedTerm	boolean
allowLdwOverride	boolean
isAuditCourse	boolean
isTermValidationSkipped	boolean
impactedStudentCourseIds	Array of numbers <int32> [ items <int32 > ]
allowedOnlyParent	boolean
isAntireqCheckSkipped	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentEnrollmentScheduleId": 0,
"dropDate": "2019-08-24T14:15:22Z",
"letterGrade": "string",
"dropReasonId": 0,
"isAllowedToOverrideRegistrationConflict": true,
"skipCoreqCheck": true,
"skipPrereqCheck": true,
"ignoreMultiCourseDependency": true,
"allowOverrideRegistrationPrereqCoreqConflict": true,
"failureMessageType": 0,
"isAddDropPeriodClassSectionAllowed": true,
"allowOverrideClosedTerm": true,
"allowLdwOverride": true,
"isAuditCourse": true,
"isTermValidationSkipped": true,
"impactedStudentCourseIds": [0
],
"allowedOnlyParent": true,
"isAntireqCheckSkipped": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isAllowedRegisterAsAuditClass": true,
"isRetakeOverride": true,
"isAllowedDateTimeConflict": true,
"isAllowedMaxClassSizeRegisterOverride": true,
"isReservedStatus": true,
"isAllowedToWaitListStudent": true,
"allowCompletedLessons": true,
"allowDeletedOnSectionTransfer": true,
"isAddDropPeriodClassSectionAllowed": true,
"isAutoAddMsg": true,
"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"prereqCoreqStatusSummaryInfoMessageList": [{"summaryInfoMessageId": 0,
"classSectionId": 0,
"courseId": 0,
"prereqCheckStatus": 0,
"coreqCheckStatus": 0,
"prereqFailureMessage": "string",
"coreqFailureMessage": "string",
"prereqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"coreqFailureInfoMessagList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"antireqFailureMessage": "string",
"antireqCheckStatus": 0,
"antireqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
]
}
],
"impectedCourseDetails": [{"studentCourseId": 0,
"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"addDropCourseDetails": {"message": "string",
"disable": true
}
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Student Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"transcripNote": "string",
"isCrsg": true,
"studentEnrollmentPeriodIdList": [0
],
"studentEnrollmentDpaCourseCategoryId": 0,
"campusId": 0,
"studentTransferCreditMultipleCourseAssociationId": 0,
"studentTransferCreditMultipleId": 0,
"id": 0,
"academicYear": { },
"adEnrollRegistrationId": 0,
"advisedDate": "2019-08-24T14:15:22Z",
"appealType": "string",
"auditEffectiveDate": "2019-08-24T14:15:22Z",
"averageBestOfPercentFinal": 0,
"billedDate": "2019-08-24T14:15:22Z",
"classSectionId": 0,
"clockHours": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"collegeId": 0,
"consecutiveMinutesAbsent": 0,
"cost": 0,
"courseAddedFrom": "string",
"courseFeeScheduleId": 0,
"courseId": 0,
"courseName": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"crossReferenceCourseId": 0,
"dateReqMet": "2019-08-24T14:15:22Z",
"dependentClassSectionId": 0,
"dropDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"examRegistrationComments": "string",
"examStatus": "string",
"expectedDeadlineDate": "2019-08-24T14:15:22Z",
"expectedEndDate": "2019-08-24T14:15:22Z",
"facultyPostedLda": "2019-08-24T14:15:22Z",
"faStudentAyPaymentPeriodId": 0,
"finalGradeReasonId": 0,
"gradePoints": 0,
"gradePostedDate": "2019-08-24T14:15:22Z",
"gradeScaleId": 0,
"highSchoolId": 0,
"include": true,
"incompleteGradeNote": "string",
"inProgressGrade": 0,
"isAfterAddDrop": true,
"isAuditCourse": true,
"isAutoDrop": true,
"isCostScheduled": true,
"isCourseRefundPolicyUsed": true,
"isCrossReferencedCourse": true,
"isEnrollmentAdjusted": true,
"isExtended": true,
"isExtensionBilled": "2019-08-24T14:15:22Z",
"isFromPortal": true,
"isGlobalCumulativeIncluded": true,
"isHalfTicketGenerated": true,
"isIncludedInGpaCalc": true,
"isIncompleteGradeReplaced": true,
"isOnlyRateScheduleUsed": true,
"isPassFail": true,
"isSpecialExam": true,
"isStudentDegreePathwayCourse": true,
"isSubstitute": true,
"isTransferCredit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"letterGrade": "string",
"lmsExtractStatus": "string",
"makeUpMinutes": 0,
"midTermGradeNote": "string",
"midTermGradePostedDate": "2019-08-24T14:15:22Z",
"midTermLetterGrade": "string",
"midTermNumericGrade": 0,
"minutesAbsent": 0,
"minutesAttended": 0,
"modFlag": "string",
"note": "string",
"numericGrade": 0,
"outsideCourseWorkHours": 0,
"overrideCourseProgression": "string",
"payStatus": "string",
"previousStatus": "string",
"qualityPoints": 0,
"requiredCourseId": 0,
"retakeFeeWaived": "string",
"retakeFlag": "string",
"retakeOverride": true,
"retakeTiv2CredEarnValue": 0,
"retakeTiv2CredEarnZeroed": true,
"revenueReferenceNumber": "string",
"rosterFlag": "string",
"rowVersion": "string",
"speed": { },
"startDate": "2019-08-24T14:15:22Z",
"status": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentTransferCreditId": 0,
"substituteCourseId": 0,
"supplementaryStatus": "string",
"termId": 0,
"testingScheduleId": 0,
"transcriptNote": "string",
"transferredCourseCode": "string",
"transferredCourseDescrip": "string",
"transferTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Student Courses Schedule Detail

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-getstudentcoursesscheduledetail-request-payload)

classSectionIdList

Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionIdList": [0
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"courseScheduleDetailList": [{"id": 0,
"day": "string",
"roomName": "string",
"buildingName": "string",
"locationName": "string",
"inOutTime": "string",
"classSectionId": 0
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Student For Future Course List

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-getstudentforfuturecourselist-request-payload)

studentEnrollmentPeriodId	number <int32>
isManualAddCourseRemoved	boolean
campus	Array of numbers <int32> [ items <int32 > ]
programVersion	Array of numbers <int32> [ items <int32 > ]
schoolStatus	Array of numbers <int32> [ items <int32 > ]
lowStartDate	string
highStartDate	string
lowExpStartDate	string
highExpStartDate	string
isUpdateStudentCourseList	boolean
isUpdateRequiredRule	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentEnrollmentPeriodId": 0,
"isManualAddCourseRemoved": true,
"campus": [0
],
"programVersion": [0
],
"schoolStatus": [0
],
"lowStartDate": "string",
"highStartDate": "string",
"lowExpStartDate": "string",
"highExpStartDate": "string",
"isUpdateStudentCourseList": true,
"isUpdateRequiredRule": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentFutureCourseList": [{"lastName": "string",
"firstName": "string",
"syStudentID": 0,
"adEnrollID": 0,
"programVersion": "string",
"schoolStatus": "string",
"campus": "string",
"studentNumber": "string",
"studentName": "string"
}
],
"messages": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Post Final Grade

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-postfinalgrade-request-payload)

	object (cmc-nexus-academics-entities-studentCourseEntity)
postFinalGradeForExistingGrade	boolean
isSudentPaceEvaluation	boolean
allowOverrideExpectedDeadlineDate	boolean
campusId	number <int32>
previousLetterGrade	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentCourse": {"transcripNote": "string",
"isCrsg": true,
"studentEnrollmentPeriodIdList": [0
],
"studentEnrollmentDpaCourseCategoryId": 0,
"campusId": 0,
"studentTransferCreditMultipleCourseAssociationId": 0,
"studentTransferCreditMultipleId": 0,
"id": 0,
"academicYear": { },
"adEnrollRegistrationId": 0,
"advisedDate": "2019-08-24T14:15:22Z",
"appealType": "string",
"auditEffectiveDate": "2019-08-24T14:15:22Z",
"averageBestOfPercentFinal": 0,
"billedDate": "2019-08-24T14:15:22Z",
"classSectionId": 0,
"clockHours": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"collegeId": 0,
"consecutiveMinutesAbsent": 0,
"cost": 0,
"courseAddedFrom": "string",
"courseFeeScheduleId": 0,
"courseId": 0,
"courseName": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"crossReferenceCourseId": 0,
"dateReqMet": "2019-08-24T14:15:22Z",
"dependentClassSectionId": 0,
"dropDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"examRegistrationComments": "string",
"examStatus": "string",
"expectedDeadlineDate": "2019-08-24T14:15:22Z",
"expectedEndDate": "2019-08-24T14:15:22Z",
"facultyPostedLda": "2019-08-24T14:15:22Z",
"faStudentAyPaymentPeriodId": 0,
"finalGradeReasonId": 0,
"gradePoints": 0,
"gradePostedDate": "2019-08-24T14:15:22Z",
"gradeScaleId": 0,
"highSchoolId": 0,
"include": true,
"incompleteGradeNote": "string",
"inProgressGrade": 0,
"isAfterAddDrop": true,
"isAuditCourse": true,
"isAutoDrop": true,
"isCostScheduled": true,
"isCourseRefundPolicyUsed": true,
"isCrossReferencedCourse": true,
"isEnrollmentAdjusted": true,
"isExtended": true,
"isExtensionBilled": "2019-08-24T14:15:22Z",
"isFromPortal": true,
"isGlobalCumulativeIncluded": true,
"isHalfTicketGenerated": true,
"isIncludedInGpaCalc": true,
"isIncompleteGradeReplaced": true,
"isOnlyRateScheduleUsed": true,
"isPassFail": true,
"isSpecialExam": true,
"isStudentDegreePathwayCourse": true,
"isSubstitute": true,
"isTransferCredit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"letterGrade": "string",
"lmsExtractStatus": "string",
"makeUpMinutes": 0,
"midTermGradeNote": "string",
"midTermGradePostedDate": "2019-08-24T14:15:22Z",
"midTermLetterGrade": "string",
"midTermNumericGrade": 0,
"minutesAbsent": 0,
"minutesAttended": 0,
"modFlag": "string",
"note": "string",
"numericGrade": 0,
"outsideCourseWorkHours": 0,
"overrideCourseProgression": "string",
"payStatus": "string",
"previousStatus": "string",
"qualityPoints": 0,
"requiredCourseId": 0,
"retakeFeeWaived": "string",
"retakeFlag": "string",
"retakeOverride": true,
"retakeTiv2CredEarnValue": 0,
"retakeTiv2CredEarnZeroed": true,
"revenueReferenceNumber": "string",
"rosterFlag": "string",
"rowVersion": "string",
"speed": { },
"startDate": "2019-08-24T14:15:22Z",
"status": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentTransferCreditId": 0,
"substituteCourseId": 0,
"supplementaryStatus": "string",
"termId": 0,
"testingScheduleId": 0,
"transcriptNote": "string",
"transferredCourseCode": "string",
"transferredCourseDescrip": "string",
"transferTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"postFinalGradeForExistingGrade": true,
"isSudentPaceEvaluation": true,
"allowOverrideExpectedDeadlineDate": true,
"campusId": 0,
"previousLetterGrade": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentCourse": {"transcripNote": "string",
"isCrsg": true,
"studentEnrollmentPeriodIdList": [0
],
"studentEnrollmentDpaCourseCategoryId": 0,
"campusId": 0,
"studentTransferCreditMultipleCourseAssociationId": 0,
"studentTransferCreditMultipleId": 0,
"id": 0,
"academicYear": { },
"adEnrollRegistrationId": 0,
"advisedDate": "2019-08-24T14:15:22Z",
"appealType": "string",
"auditEffectiveDate": "2019-08-24T14:15:22Z",
"averageBestOfPercentFinal": 0,
"billedDate": "2019-08-24T14:15:22Z",
"classSectionId": 0,
"clockHours": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"collegeId": 0,
"consecutiveMinutesAbsent": 0,
"cost": 0,
"courseAddedFrom": "string",
"courseFeeScheduleId": 0,
"courseId": 0,
"courseName": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"crossReferenceCourseId": 0,
"dateReqMet": "2019-08-24T14:15:22Z",
"dependentClassSectionId": 0,
"dropDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"examRegistrationComments": "string",
"examStatus": "string",
"expectedDeadlineDate": "2019-08-24T14:15:22Z",
"expectedEndDate": "2019-08-24T14:15:22Z",
"facultyPostedLda": "2019-08-24T14:15:22Z",
"faStudentAyPaymentPeriodId": 0,
"finalGradeReasonId": 0,
"gradePoints": 0,
"gradePostedDate": "2019-08-24T14:15:22Z",
"gradeScaleId": 0,
"highSchoolId": 0,
"include": true,
"incompleteGradeNote": "string",
"inProgressGrade": 0,
"isAfterAddDrop": true,
"isAuditCourse": true,
"isAutoDrop": true,
"isCostScheduled": true,
"isCourseRefundPolicyUsed": true,
"isCrossReferencedCourse": true,
"isEnrollmentAdjusted": true,
"isExtended": true,
"isExtensionBilled": "2019-08-24T14:15:22Z",
"isFromPortal": true,
"isGlobalCumulativeIncluded": true,
"isHalfTicketGenerated": true,
"isIncludedInGpaCalc": true,
"isIncompleteGradeReplaced": true,
"isOnlyRateScheduleUsed": true,
"isPassFail": true,
"isSpecialExam": true,
"isStudentDegreePathwayCourse": true,
"isSubstitute": true,
"isTransferCredit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"letterGrade": "string",
"lmsExtractStatus": "string",
"makeUpMinutes": 0,
"midTermGradeNote": "string",
"midTermGradePostedDate": "2019-08-24T14:15:22Z",
"midTermLetterGrade": "string",
"midTermNumericGrade": 0,
"minutesAbsent": 0,
"minutesAttended": 0,
"modFlag": "string",
"note": "string",
"numericGrade": 0,
"outsideCourseWorkHours": 0,
"overrideCourseProgression": "string",
"payStatus": "string",
"previousStatus": "string",
"qualityPoints": 0,
"requiredCourseId": 0,
"retakeFeeWaived": "string",
"retakeFlag": "string",
"retakeOverride": true,
"retakeTiv2CredEarnValue": 0,
"retakeTiv2CredEarnZeroed": true,
"revenueReferenceNumber": "string",
"rosterFlag": "string",
"rowVersion": "string",
"speed": { },
"startDate": "2019-08-24T14:15:22Z",
"status": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentTransferCreditId": 0,
"substituteCourseId": 0,
"supplementaryStatus": "string",
"termId": 0,
"testingScheduleId": 0,
"transcriptNote": "string",
"transferredCourseCode": "string",
"transferredCourseDescrip": "string",
"transferTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Post Mid Term Grade

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-postmidtermgrade-request-payload)

Array of objects (cmc-nexus-academics-services-classSectionRosterMidTerm)

Array

studentEnrollnmentPeriodId	number <int32>
studentId	number <int32>
studentCourseId required	number <int32>
studentCourseStatus	string
midtermLetterGrade	string
midtermNumericGrade	string
speed	object
midtermGradeNote	string
studentEnrollnmentPeriodGradeScaleId	number <int32>
studentName	string
ssn	string
schoolStatusCode	string
isAudit	boolean
midtermGradePostedDate	string <date-time>
gradeScaleId	number <int32>
courseCode	string
sectionCode	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"classSectionRosterMidTermList": [{"studentEnrollnmentPeriodId": 0,
"studentId": 0,
"studentCourseId": 0,
"studentCourseStatus": "string",
"midtermLetterGrade": "string",
"midtermNumericGrade": "string",
"speed": { },
"midtermGradeNote": "string",
"studentEnrollnmentPeriodGradeScaleId": 0,
"studentName": "string",
"ssn": "string",
"schoolStatusCode": "string",
"isAudit": true,
"midtermGradePostedDate": "2019-08-24T14:15:22Z",
"gradeScaleId": 0,
"courseCode": "string",
"sectionCode": "string"
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Reassign Student Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-reassignstudentcourse-request-payload)

originalStudentEnrollmentPeriodId	number <int32>
selectedStudentEnrollmentPeriodId	number <int32>
studentCourseId	number <int32>
termId	number <int32>
classSectionId	number <int32>
overideCourseAssociationExists	boolean
overideCourseAlreadyExists	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"originalStudentEnrollmentPeriodId": 0,
"selectedStudentEnrollmentPeriodId": 0,
"studentCourseId": 0,
"termId": 0,
"classSectionId": 0,
"overideCourseAssociationExists": true,
"overideCourseAlreadyExists": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"courseName": "string",
"originalProgramVersion": "string",
"selectedProgramVersionName": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Reinstate Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-reinstatecourse-request-payload)

studentCourseId	number <int32>
isAllowedToOverrideRegistrationConflict	boolean
skipCoreqCheck	boolean
skipPrereqCheck	boolean
ignoreMultiCourseDependency	boolean
allowOverrideRegistrationPrereqCoreqConflict	boolean
failureMessageType	number <int32>
allowOverrideRegistrationHold	boolean
isAntireqCheckSkipped	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentCourseId": 0,
"isAllowedToOverrideRegistrationConflict": true,
"skipCoreqCheck": true,
"skipPrereqCheck": true,
"ignoreMultiCourseDependency": true,
"allowOverrideRegistrationPrereqCoreqConflict": true,
"failureMessageType": 0,
"allowOverrideRegistrationHold": true,
"isAntireqCheckSkipped": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isAllowedRegisterAsAuditClass": true,
"isRetakeOverride": true,
"isAllowedDateTimeConflict": true,
"isAllowedMaxClassSizeRegisterOverride": true,
"isReservedStatus": true,
"isAllowedToWaitListStudent": true,
"allowCompletedLessons": true,
"allowDeletedOnSectionTransfer": true,
"isAddDropPeriodClassSectionAllowed": true,
"isAutoAddMsg": true,
"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"prereqCoreqStatusSummaryInfoMessageList": [{"summaryInfoMessageId": 0,
"classSectionId": 0,
"courseId": 0,
"prereqCheckStatus": 0,
"coreqCheckStatus": 0,
"prereqFailureMessage": "string",
"coreqFailureMessage": "string",
"prereqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"coreqFailureInfoMessagList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"antireqFailureMessage": "string",
"antireqCheckStatus": 0,
"antireqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
]
}
],
"impectedCourseDetails": [{"studentCourseId": 0,
"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"addDropCourseDetails": {"message": "string",
"disable": true
}
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Remove Waitlist

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-removewaitlist-request-payload)

studentCourseId	number <int32>
isWaitListed	boolean
campusId	number <int32>
adEnrollRegistrationId	number <int32>
notifyStudent	boolean
termId	number <int32>
classSectionId	number <int32>
studentEnrollmentPeriodId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentCourseId": 0,
"isWaitListed": true,
"campusId": 0,
"adEnrollRegistrationId": 0,
"notifyStudent": true,
"termId": 0,
"classSectionId": 0,
"studentEnrollmentPeriodId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"classSectionId": 0,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Student Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-save-request-payload)

transcripNote	string
isCrsg	boolean
studentEnrollmentPeriodIdList	Array of numbers <int32> [ items <int32 > ]
studentEnrollmentDpaCourseCategoryId	number <int32>
campusId	number <int32>
studentTransferCreditMultipleCourseAssociationId	number <int32>
studentTransferCreditMultipleId	number <int32>
id	number <int32> Id
academicYear	object Academic Year
adEnrollRegistrationId	number <int32> Ad Enroll Registration Id
advisedDate	string <date-time> Advised Date
appealType	string Appeal Type
auditEffectiveDate	string <date-time> Audit Effective Date
averageBestOfPercentFinal	number <double> Average Best Of Percent Final
billedDate	string <date-time> Billed Date
classSectionId	number <int32> Class Section Id
clockHours	number <double> Clock Hours
clockHoursAttempted	number <double> Clock Hours Attempted
clockHoursEarned	number <double> Clock Hours Earned
collegeId	number <int32> College Id
consecutiveMinutesAbsent	number <double> Consecutive Minutes Absent
cost	number <double> Cost
courseAddedFrom	string Course Added From
courseFeeScheduleId	number <int32> Course Fee Schedule Id
courseId	number <int32> Course Id
courseName	string Course Name
createdDateTime	string <date-time> Created Date Time
creditHours	number <double> Credit Hours
creditHoursAttempted	number <double> Credit Hours Attempted
creditHoursEarned	number <double> Credit Hours Earned
crossReferenceCourseId	number <int32> Cross Reference Course Id
dateReqMet	string <date-time> Date Req Met
dependentClassSectionId	number <int32> Dependent Class Section Id
dropDate	string <date-time> Drop Date
endDate	string <date-time> End Date
enrollmentStatusClockHours	number <double> Enrollment Status Clock Hours
enrollmentStatusCreditHours	number <double> Enrollment Status Credit Hours
examRegistrationComments	string Exam Registration Comments
examStatus	string Exam Status
expectedDeadlineDate	string <date-time> Expected Deadline Date
expectedEndDate	string <date-time> Expected End Date
facultyPostedLda	string <date-time> Faculty Posted Lda
faStudentAyPaymentPeriodId	number <int32> Fa Student Ay Payment Period Id
finalGradeReasonId	number <int32> Final Grade Reason Id
gradePoints	number <double> Grade Points
gradePostedDate	string <date-time> Grade Posted Date
gradeScaleId	number <int32> Grade Scale Id
highSchoolId	number <int32> High School Id
include	boolean Include
incompleteGradeNote	string Incomplete Grade Note
inProgressGrade	number <double> In Progress Grade
isAfterAddDrop	boolean Is After Add Drop
isAuditCourse	boolean Is Audit Course
isAutoDrop	boolean Is Auto Drop
isCostScheduled	boolean Is Cost Scheduled
isCourseRefundPolicyUsed	boolean Is Course Refund Policy Used
isCrossReferencedCourse	boolean Is Cross Referenced Course
isEnrollmentAdjusted	boolean Is Enrollment Adjusted
isExtended	boolean Is Extended
isExtensionBilled	string <date-time> Is Extension Billed
isFromPortal	boolean Is From Portal
isGlobalCumulativeIncluded	boolean Is Global Cumulative Included
isHalfTicketGenerated	boolean Is Half Ticket Generated
isIncludedInGpaCalc	boolean Is Included In Gpa Calc
isIncompleteGradeReplaced	boolean Is Incomplete Grade Replaced
isOnlyRateScheduleUsed	boolean Is Only Rate Schedule Used
isPassFail	boolean Is Pass Fail
isSpecialExam	boolean Is Special Exam
isStudentDegreePathwayCourse	boolean Is Student Degree Pathway Course
isSubstitute	boolean Is Substitute
isTransferCredit	boolean Is Transfer Credit
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
lda	string <date-time> Lda
letterGrade	string Letter Grade
lmsExtractStatus	string Lms Extract Status
makeUpMinutes	number <int32> Make Up Minutes
midTermGradeNote	string Mid Term Grade Note
midTermGradePostedDate	string <date-time> Mid Term Grade Posted Date
midTermLetterGrade	string Mid Term Letter Grade
midTermNumericGrade	number <double> Mid Term Numeric Grade
minutesAbsent	number <int32> Minutes Absent
minutesAttended	number <int32> Minutes Attended
modFlag	string Mod Flag
note	string Note
numericGrade	number <double> Numeric Grade
outsideCourseWorkHours	number <double> Outside Course Work Hours
overrideCourseProgression	string Override Course Progression
payStatus	string Pay Status
previousStatus	string Previous Status
qualityPoints	number <double> Quality Points
requiredCourseId	number <int32> Required Course Id
retakeFeeWaived	string Retake Fee Waived
retakeFlag	string Retake Flag
retakeOverride	boolean Retake Override
retakeTiv2CredEarnValue	number <double> Retake Tiv2Cred Earn Value
retakeTiv2CredEarnZeroed	boolean Retake Tiv2Cred Earn Zeroed
revenueReferenceNumber	string Revenue Reference Number
rosterFlag	string Roster Flag
rowVersion	string
speed	object Speed
startDate	string <date-time> Start Date
status	string Status
studentEnrollmentPeriodId	number <int32> Student Enrollment Period Id
studentId	number <int32> Student Id
studentTransferCreditId	number <int32> Student Transfer Credit Id
substituteCourseId	number <int32> Substitute Course Id
supplementaryStatus	string Supplementary Status
termId	number <int32> Term Id
testingScheduleId	number <int32> Testing Schedule Id
transcriptNote	string Transcript Note
transferredCourseCode	string Transferred Course Code
transferredCourseDescrip	string Transferred Course Descrip
transferTypeId	number <int32> Transfer Type Id
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"transcripNote": "string",
"isCrsg": true,
"studentEnrollmentPeriodIdList": [0
],
"studentEnrollmentDpaCourseCategoryId": 0,
"campusId": 0,
"studentTransferCreditMultipleCourseAssociationId": 0,
"studentTransferCreditMultipleId": 0,
"id": 0,
"academicYear": { },
"adEnrollRegistrationId": 0,
"advisedDate": "2019-08-24T14:15:22Z",
"appealType": "string",
"auditEffectiveDate": "2019-08-24T14:15:22Z",
"averageBestOfPercentFinal": 0,
"billedDate": "2019-08-24T14:15:22Z",
"classSectionId": 0,
"clockHours": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"collegeId": 0,
"consecutiveMinutesAbsent": 0,
"cost": 0,
"courseAddedFrom": "string",
"courseFeeScheduleId": 0,
"courseId": 0,
"courseName": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"crossReferenceCourseId": 0,
"dateReqMet": "2019-08-24T14:15:22Z",
"dependentClassSectionId": 0,
"dropDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"examRegistrationComments": "string",
"examStatus": "string",
"expectedDeadlineDate": "2019-08-24T14:15:22Z",
"expectedEndDate": "2019-08-24T14:15:22Z",
"facultyPostedLda": "2019-08-24T14:15:22Z",
"faStudentAyPaymentPeriodId": 0,
"finalGradeReasonId": 0,
"gradePoints": 0,
"gradePostedDate": "2019-08-24T14:15:22Z",
"gradeScaleId": 0,
"highSchoolId": 0,
"include": true,
"incompleteGradeNote": "string",
"inProgressGrade": 0,
"isAfterAddDrop": true,
"isAuditCourse": true,
"isAutoDrop": true,
"isCostScheduled": true,
"isCourseRefundPolicyUsed": true,
"isCrossReferencedCourse": true,
"isEnrollmentAdjusted": true,
"isExtended": true,
"isExtensionBilled": "2019-08-24T14:15:22Z",
"isFromPortal": true,
"isGlobalCumulativeIncluded": true,
"isHalfTicketGenerated": true,
"isIncludedInGpaCalc": true,
"isIncompleteGradeReplaced": true,
"isOnlyRateScheduleUsed": true,
"isPassFail": true,
"isSpecialExam": true,
"isStudentDegreePathwayCourse": true,
"isSubstitute": true,
"isTransferCredit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"letterGrade": "string",
"lmsExtractStatus": "string",
"makeUpMinutes": 0,
"midTermGradeNote": "string",
"midTermGradePostedDate": "2019-08-24T14:15:22Z",
"midTermLetterGrade": "string",
"midTermNumericGrade": 0,
"minutesAbsent": 0,
"minutesAttended": 0,
"modFlag": "string",
"note": "string",
"numericGrade": 0,
"outsideCourseWorkHours": 0,
"overrideCourseProgression": "string",
"payStatus": "string",
"previousStatus": "string",
"qualityPoints": 0,
"requiredCourseId": 0,
"retakeFeeWaived": "string",
"retakeFlag": "string",
"retakeOverride": true,
"retakeTiv2CredEarnValue": 0,
"retakeTiv2CredEarnZeroed": true,
"revenueReferenceNumber": "string",
"rosterFlag": "string",
"rowVersion": "string",
"speed": { },
"startDate": "2019-08-24T14:15:22Z",
"status": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentTransferCreditId": 0,
"substituteCourseId": 0,
"supplementaryStatus": "string",
"termId": 0,
"testingScheduleId": 0,
"transcriptNote": "string",
"transferredCourseCode": "string",
"transferredCourseDescrip": "string",
"transferTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"transcripNote": "string",
"isCrsg": true,
"studentEnrollmentPeriodIdList": [0
],
"studentEnrollmentDpaCourseCategoryId": 0,
"campusId": 0,
"studentTransferCreditMultipleCourseAssociationId": 0,
"studentTransferCreditMultipleId": 0,
"id": 0,
"academicYear": { },
"adEnrollRegistrationId": 0,
"advisedDate": "2019-08-24T14:15:22Z",
"appealType": "string",
"auditEffectiveDate": "2019-08-24T14:15:22Z",
"averageBestOfPercentFinal": 0,
"billedDate": "2019-08-24T14:15:22Z",
"classSectionId": 0,
"clockHours": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"collegeId": 0,
"consecutiveMinutesAbsent": 0,
"cost": 0,
"courseAddedFrom": "string",
"courseFeeScheduleId": 0,
"courseId": 0,
"courseName": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"crossReferenceCourseId": 0,
"dateReqMet": "2019-08-24T14:15:22Z",
"dependentClassSectionId": 0,
"dropDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"examRegistrationComments": "string",
"examStatus": "string",
"expectedDeadlineDate": "2019-08-24T14:15:22Z",
"expectedEndDate": "2019-08-24T14:15:22Z",
"facultyPostedLda": "2019-08-24T14:15:22Z",
"faStudentAyPaymentPeriodId": 0,
"finalGradeReasonId": 0,
"gradePoints": 0,
"gradePostedDate": "2019-08-24T14:15:22Z",
"gradeScaleId": 0,
"highSchoolId": 0,
"include": true,
"incompleteGradeNote": "string",
"inProgressGrade": 0,
"isAfterAddDrop": true,
"isAuditCourse": true,
"isAutoDrop": true,
"isCostScheduled": true,
"isCourseRefundPolicyUsed": true,
"isCrossReferencedCourse": true,
"isEnrollmentAdjusted": true,
"isExtended": true,
"isExtensionBilled": "2019-08-24T14:15:22Z",
"isFromPortal": true,
"isGlobalCumulativeIncluded": true,
"isHalfTicketGenerated": true,
"isIncludedInGpaCalc": true,
"isIncompleteGradeReplaced": true,
"isOnlyRateScheduleUsed": true,
"isPassFail": true,
"isSpecialExam": true,
"isStudentDegreePathwayCourse": true,
"isSubstitute": true,
"isTransferCredit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"letterGrade": "string",
"lmsExtractStatus": "string",
"makeUpMinutes": 0,
"midTermGradeNote": "string",
"midTermGradePostedDate": "2019-08-24T14:15:22Z",
"midTermLetterGrade": "string",
"midTermNumericGrade": 0,
"minutesAbsent": 0,
"minutesAttended": 0,
"modFlag": "string",
"note": "string",
"numericGrade": 0,
"outsideCourseWorkHours": 0,
"overrideCourseProgression": "string",
"payStatus": "string",
"previousStatus": "string",
"qualityPoints": 0,
"requiredCourseId": 0,
"retakeFeeWaived": "string",
"retakeFlag": "string",
"retakeOverride": true,
"retakeTiv2CredEarnValue": 0,
"retakeTiv2CredEarnZeroed": true,
"revenueReferenceNumber": "string",
"rosterFlag": "string",
"rowVersion": "string",
"speed": { },
"startDate": "2019-08-24T14:15:22Z",
"status": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentTransferCreditId": 0,
"substituteCourseId": 0,
"supplementaryStatus": "string",
"termId": 0,
"testingScheduleId": 0,
"transcriptNote": "string",
"transferredCourseCode": "string",
"transferredCourseDescrip": "string",
"transferTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Student Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-savenew-request-payload)

transcripNote	string
isCrsg	boolean
studentEnrollmentPeriodIdList	Array of numbers <int32> [ items <int32 > ]
studentEnrollmentDpaCourseCategoryId	number <int32>
campusId	number <int32>
studentTransferCreditMultipleCourseAssociationId	number <int32>
studentTransferCreditMultipleId	number <int32>
id	number <int32> Id
academicYear	object Academic Year
adEnrollRegistrationId	number <int32> Ad Enroll Registration Id
advisedDate	string <date-time> Advised Date
appealType	string Appeal Type
auditEffectiveDate	string <date-time> Audit Effective Date
averageBestOfPercentFinal	number <double> Average Best Of Percent Final
billedDate	string <date-time> Billed Date
classSectionId	number <int32> Class Section Id
clockHours	number <double> Clock Hours
clockHoursAttempted	number <double> Clock Hours Attempted
clockHoursEarned	number <double> Clock Hours Earned
collegeId	number <int32> College Id
consecutiveMinutesAbsent	number <double> Consecutive Minutes Absent
cost	number <double> Cost
courseAddedFrom	string Course Added From
courseFeeScheduleId	number <int32> Course Fee Schedule Id
courseId	number <int32> Course Id
courseName	string Course Name
createdDateTime	string <date-time> Created Date Time
creditHours	number <double> Credit Hours
creditHoursAttempted	number <double> Credit Hours Attempted
creditHoursEarned	number <double> Credit Hours Earned
crossReferenceCourseId	number <int32> Cross Reference Course Id
dateReqMet	string <date-time> Date Req Met
dependentClassSectionId	number <int32> Dependent Class Section Id
dropDate	string <date-time> Drop Date
endDate	string <date-time> End Date
enrollmentStatusClockHours	number <double> Enrollment Status Clock Hours
enrollmentStatusCreditHours	number <double> Enrollment Status Credit Hours
examRegistrationComments	string Exam Registration Comments
examStatus	string Exam Status
expectedDeadlineDate	string <date-time> Expected Deadline Date
expectedEndDate	string <date-time> Expected End Date
facultyPostedLda	string <date-time> Faculty Posted Lda
faStudentAyPaymentPeriodId	number <int32> Fa Student Ay Payment Period Id
finalGradeReasonId	number <int32> Final Grade Reason Id
gradePoints	number <double> Grade Points
gradePostedDate	string <date-time> Grade Posted Date
gradeScaleId	number <int32> Grade Scale Id
highSchoolId	number <int32> High School Id
include	boolean Include
incompleteGradeNote	string Incomplete Grade Note
inProgressGrade	number <double> In Progress Grade
isAfterAddDrop	boolean Is After Add Drop
isAuditCourse	boolean Is Audit Course
isAutoDrop	boolean Is Auto Drop
isCostScheduled	boolean Is Cost Scheduled
isCourseRefundPolicyUsed	boolean Is Course Refund Policy Used
isCrossReferencedCourse	boolean Is Cross Referenced Course
isEnrollmentAdjusted	boolean Is Enrollment Adjusted
isExtended	boolean Is Extended
isExtensionBilled	string <date-time> Is Extension Billed
isFromPortal	boolean Is From Portal
isGlobalCumulativeIncluded	boolean Is Global Cumulative Included
isHalfTicketGenerated	boolean Is Half Ticket Generated
isIncludedInGpaCalc	boolean Is Included In Gpa Calc
isIncompleteGradeReplaced	boolean Is Incomplete Grade Replaced
isOnlyRateScheduleUsed	boolean Is Only Rate Schedule Used
isPassFail	boolean Is Pass Fail
isSpecialExam	boolean Is Special Exam
isStudentDegreePathwayCourse	boolean Is Student Degree Pathway Course
isSubstitute	boolean Is Substitute
isTransferCredit	boolean Is Transfer Credit
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
lda	string <date-time> Lda
letterGrade	string Letter Grade
lmsExtractStatus	string Lms Extract Status
makeUpMinutes	number <int32> Make Up Minutes
midTermGradeNote	string Mid Term Grade Note
midTermGradePostedDate	string <date-time> Mid Term Grade Posted Date
midTermLetterGrade	string Mid Term Letter Grade
midTermNumericGrade	number <double> Mid Term Numeric Grade
minutesAbsent	number <int32> Minutes Absent
minutesAttended	number <int32> Minutes Attended
modFlag	string Mod Flag
note	string Note
numericGrade	number <double> Numeric Grade
outsideCourseWorkHours	number <double> Outside Course Work Hours
overrideCourseProgression	string Override Course Progression
payStatus	string Pay Status
previousStatus	string Previous Status
qualityPoints	number <double> Quality Points
requiredCourseId	number <int32> Required Course Id
retakeFeeWaived	string Retake Fee Waived
retakeFlag	string Retake Flag
retakeOverride	boolean Retake Override
retakeTiv2CredEarnValue	number <double> Retake Tiv2Cred Earn Value
retakeTiv2CredEarnZeroed	boolean Retake Tiv2Cred Earn Zeroed
revenueReferenceNumber	string Revenue Reference Number
rosterFlag	string Roster Flag
rowVersion	string
speed	object Speed
startDate	string <date-time> Start Date
status	string Status
studentEnrollmentPeriodId	number <int32> Student Enrollment Period Id
studentId	number <int32> Student Id
studentTransferCreditId	number <int32> Student Transfer Credit Id
substituteCourseId	number <int32> Substitute Course Id
supplementaryStatus	string Supplementary Status
termId	number <int32> Term Id
testingScheduleId	number <int32> Testing Schedule Id
transcriptNote	string Transcript Note
transferredCourseCode	string Transferred Course Code
transferredCourseDescrip	string Transferred Course Descrip
transferTypeId	number <int32> Transfer Type Id
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"transcripNote": "string",
"isCrsg": true,
"studentEnrollmentPeriodIdList": [0
],
"studentEnrollmentDpaCourseCategoryId": 0,
"campusId": 0,
"studentTransferCreditMultipleCourseAssociationId": 0,
"studentTransferCreditMultipleId": 0,
"id": 0,
"academicYear": { },
"adEnrollRegistrationId": 0,
"advisedDate": "2019-08-24T14:15:22Z",
"appealType": "string",
"auditEffectiveDate": "2019-08-24T14:15:22Z",
"averageBestOfPercentFinal": 0,
"billedDate": "2019-08-24T14:15:22Z",
"classSectionId": 0,
"clockHours": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"collegeId": 0,
"consecutiveMinutesAbsent": 0,
"cost": 0,
"courseAddedFrom": "string",
"courseFeeScheduleId": 0,
"courseId": 0,
"courseName": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"crossReferenceCourseId": 0,
"dateReqMet": "2019-08-24T14:15:22Z",
"dependentClassSectionId": 0,
"dropDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"examRegistrationComments": "string",
"examStatus": "string",
"expectedDeadlineDate": "2019-08-24T14:15:22Z",
"expectedEndDate": "2019-08-24T14:15:22Z",
"facultyPostedLda": "2019-08-24T14:15:22Z",
"faStudentAyPaymentPeriodId": 0,
"finalGradeReasonId": 0,
"gradePoints": 0,
"gradePostedDate": "2019-08-24T14:15:22Z",
"gradeScaleId": 0,
"highSchoolId": 0,
"include": true,
"incompleteGradeNote": "string",
"inProgressGrade": 0,
"isAfterAddDrop": true,
"isAuditCourse": true,
"isAutoDrop": true,
"isCostScheduled": true,
"isCourseRefundPolicyUsed": true,
"isCrossReferencedCourse": true,
"isEnrollmentAdjusted": true,
"isExtended": true,
"isExtensionBilled": "2019-08-24T14:15:22Z",
"isFromPortal": true,
"isGlobalCumulativeIncluded": true,
"isHalfTicketGenerated": true,
"isIncludedInGpaCalc": true,
"isIncompleteGradeReplaced": true,
"isOnlyRateScheduleUsed": true,
"isPassFail": true,
"isSpecialExam": true,
"isStudentDegreePathwayCourse": true,
"isSubstitute": true,
"isTransferCredit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"letterGrade": "string",
"lmsExtractStatus": "string",
"makeUpMinutes": 0,
"midTermGradeNote": "string",
"midTermGradePostedDate": "2019-08-24T14:15:22Z",
"midTermLetterGrade": "string",
"midTermNumericGrade": 0,
"minutesAbsent": 0,
"minutesAttended": 0,
"modFlag": "string",
"note": "string",
"numericGrade": 0,
"outsideCourseWorkHours": 0,
"overrideCourseProgression": "string",
"payStatus": "string",
"previousStatus": "string",
"qualityPoints": 0,
"requiredCourseId": 0,
"retakeFeeWaived": "string",
"retakeFlag": "string",
"retakeOverride": true,
"retakeTiv2CredEarnValue": 0,
"retakeTiv2CredEarnZeroed": true,
"revenueReferenceNumber": "string",
"rosterFlag": "string",
"rowVersion": "string",
"speed": { },
"startDate": "2019-08-24T14:15:22Z",
"status": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentTransferCreditId": 0,
"substituteCourseId": 0,
"supplementaryStatus": "string",
"termId": 0,
"testingScheduleId": 0,
"transcriptNote": "string",
"transferredCourseCode": "string",
"transferredCourseDescrip": "string",
"transferTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"transcripNote": "string",
"isCrsg": true,
"studentEnrollmentPeriodIdList": [0
],
"studentEnrollmentDpaCourseCategoryId": 0,
"campusId": 0,
"studentTransferCreditMultipleCourseAssociationId": 0,
"studentTransferCreditMultipleId": 0,
"id": 0,
"academicYear": { },
"adEnrollRegistrationId": 0,
"advisedDate": "2019-08-24T14:15:22Z",
"appealType": "string",
"auditEffectiveDate": "2019-08-24T14:15:22Z",
"averageBestOfPercentFinal": 0,
"billedDate": "2019-08-24T14:15:22Z",
"classSectionId": 0,
"clockHours": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"collegeId": 0,
"consecutiveMinutesAbsent": 0,
"cost": 0,
"courseAddedFrom": "string",
"courseFeeScheduleId": 0,
"courseId": 0,
"courseName": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"crossReferenceCourseId": 0,
"dateReqMet": "2019-08-24T14:15:22Z",
"dependentClassSectionId": 0,
"dropDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"examRegistrationComments": "string",
"examStatus": "string",
"expectedDeadlineDate": "2019-08-24T14:15:22Z",
"expectedEndDate": "2019-08-24T14:15:22Z",
"facultyPostedLda": "2019-08-24T14:15:22Z",
"faStudentAyPaymentPeriodId": 0,
"finalGradeReasonId": 0,
"gradePoints": 0,
"gradePostedDate": "2019-08-24T14:15:22Z",
"gradeScaleId": 0,
"highSchoolId": 0,
"include": true,
"incompleteGradeNote": "string",
"inProgressGrade": 0,
"isAfterAddDrop": true,
"isAuditCourse": true,
"isAutoDrop": true,
"isCostScheduled": true,
"isCourseRefundPolicyUsed": true,
"isCrossReferencedCourse": true,
"isEnrollmentAdjusted": true,
"isExtended": true,
"isExtensionBilled": "2019-08-24T14:15:22Z",
"isFromPortal": true,
"isGlobalCumulativeIncluded": true,
"isHalfTicketGenerated": true,
"isIncludedInGpaCalc": true,
"isIncompleteGradeReplaced": true,
"isOnlyRateScheduleUsed": true,
"isPassFail": true,
"isSpecialExam": true,
"isStudentDegreePathwayCourse": true,
"isSubstitute": true,
"isTransferCredit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"letterGrade": "string",
"lmsExtractStatus": "string",
"makeUpMinutes": 0,
"midTermGradeNote": "string",
"midTermGradePostedDate": "2019-08-24T14:15:22Z",
"midTermLetterGrade": "string",
"midTermNumericGrade": 0,
"minutesAbsent": 0,
"minutesAttended": 0,
"modFlag": "string",
"note": "string",
"numericGrade": 0,
"outsideCourseWorkHours": 0,
"overrideCourseProgression": "string",
"payStatus": "string",
"previousStatus": "string",
"qualityPoints": 0,
"requiredCourseId": 0,
"retakeFeeWaived": "string",
"retakeFlag": "string",
"retakeOverride": true,
"retakeTiv2CredEarnValue": 0,
"retakeTiv2CredEarnZeroed": true,
"revenueReferenceNumber": "string",
"rosterFlag": "string",
"rowVersion": "string",
"speed": { },
"startDate": "2019-08-24T14:15:22Z",
"status": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentTransferCreditId": 0,
"substituteCourseId": 0,
"supplementaryStatus": "string",
"termId": 0,
"testingScheduleId": 0,
"transcriptNote": "string",
"transferredCourseCode": "string",
"transferredCourseDescrip": "string",
"transferTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Student Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-savestudentcourse-request-payload)

studentCourseId	number <int32>
studentEnrollmentPeriodId	number <int32>
campusId	number <int32>
classSectionId	number <int32>
courseId	number <int32>
requiredCourseId	number <int32>
parentTermId	number <int32>
termId	number <int32>
academicYearId	number <int32>
hours	number <double>
comments	string
credits	number <double>
action	number <int32>
allowOverrideRegistrationHold	boolean
isAllowedToOverrideRetakeAttempts	boolean
isAllowedToAuditCourse	boolean
isAllowedCourse	boolean
isAllowedToOverrideLockedTermSequence	boolean
isAllowedMaxClassSizeRegisterOverride	boolean
isAllowedToWaitListStudent	boolean
isAllowedPostCourseStartDateRegistration	boolean
isWaitlistStudentNotified	boolean
isSubstituteCourse	boolean
substituteCourseId	number <int32>
isAudit	boolean
studentCourseFeeScheduleId	number <int32>
isCrossReferencedCourse	boolean
crossReferenceCourseId	number <int32>
description	string
startDate	string <date-time>
endDate	string <date-time>
isRetakeOverride	boolean
retakeID	number <int32>
returnCode	number <int32>
isPassFail	number <int32>
useFeeSchedule	boolean
retakeFee	object
classCount	number <int32>
isAllowStudentAcademicYearPaymentPeriod	boolean
isAllowedDateTimeConflict	boolean
status	string
isAllowedToOverrideRegistrationConflict	boolean
allowOverrideRegistrationPrereqCoreqConflict	boolean
allowOverrideRegistrationAntireqConflict	boolean
skipPrereqCheck	boolean
skipCoreqCheck	boolean
failureMessageType	number <int32>
ignoreMultiCourseDependency	boolean
isReservedStatus	boolean
isAllowedToOverrideStudentIntoCourse	boolean
isAllowedToWaitlistAvailableStudentIntoCourse	boolean
isAllowedToWaitlistStudentIntoCourse	boolean
isRetake	boolean
isAddDropPeriodClassSectionAllowed	boolean
isAllowedToOverrideClosedTerm	boolean
isAllowedToOverrideRegistrationGroup	boolean
isOverlapWithParentTermAllowed	boolean
isAllowedRegisterAsAuditClass	boolean
isCrsg	boolean
isPreCoRequisiteValidationSkipped	boolean
isTermValidationSkipped	boolean
isAllowedToWaitListForDifferentSection	boolean
isWaitListBlockedForDifferentSection	boolean
isAllowedToOverrideCourseStatus	boolean
isRetakeValidationDisplayed	boolean
isRegistrationRetake	boolean
isAntireqCheckSkipped	boolean
isSupplementaryCourse	boolean
isEnrollmentAdjusted	boolean
catalogYearId	number <int32>
requiredCourseCategoryId	number <int32>
studentEnrollmentDpaCourseCategoryId	number <int32>
enrollmentTotalCredits	number <double>
enrollmenTotaltHours	number <double>
isOverlapTermConflict	boolean
isAlreadyTakingConflict	boolean
isCourseToRegister	boolean
isRegisterExceedingCourseElectivePoolLimit	boolean
isGlobalCumulativeIncluded	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"campusId": 0,
"classSectionId": 0,
"courseId": 0,
"requiredCourseId": 0,
"parentTermId": 0,
"termId": 0,
"academicYearId": 0,
"hours": 0,
"comments": "string",
"credits": 0,
"action": 0,
"allowOverrideRegistrationHold": true,
"isAllowedToOverrideRetakeAttempts": true,
"isAllowedToAuditCourse": true,
"isAllowedCourse": true,
"isAllowedToOverrideLockedTermSequence": true,
"isAllowedMaxClassSizeRegisterOverride": true,
"isAllowedToWaitListStudent": true,
"isAllowedPostCourseStartDateRegistration": true,
"isWaitlistStudentNotified": true,
"isSubstituteCourse": true,
"substituteCourseId": 0,
"isAudit": true,
"studentCourseFeeScheduleId": 0,
"isCrossReferencedCourse": true,
"crossReferenceCourseId": 0,
"description": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"isRetakeOverride": true,
"retakeID": 0,
"returnCode": 0,
"isPassFail": 0,
"useFeeSchedule": true,
"retakeFee": { },
"classCount": 0,
"isAllowStudentAcademicYearPaymentPeriod": true,
"isAllowedDateTimeConflict": true,
"status": "string",
"isAllowedToOverrideRegistrationConflict": true,
"allowOverrideRegistrationPrereqCoreqConflict": true,
"allowOverrideRegistrationAntireqConflict": true,
"skipPrereqCheck": true,
"skipCoreqCheck": true,
"failureMessageType": 0,
"ignoreMultiCourseDependency": true,
"isReservedStatus": true,
"isAllowedToOverrideStudentIntoCourse": true,
"isAllowedToWaitlistAvailableStudentIntoCourse": true,
"isAllowedToWaitlistStudentIntoCourse": true,
"isRetake": true,
"isAddDropPeriodClassSectionAllowed": true,
"isAllowedToOverrideClosedTerm": true,
"isAllowedToOverrideRegistrationGroup": true,
"isOverlapWithParentTermAllowed": true,
"isAllowedRegisterAsAuditClass": true,
"isCrsg": true,
"isPreCoRequisiteValidationSkipped": true,
"isTermValidationSkipped": true,
"isAllowedToWaitListForDifferentSection": true,
"isWaitListBlockedForDifferentSection": true,
"isAllowedToOverrideCourseStatus": true,
"isRetakeValidationDisplayed": true,
"isRegistrationRetake": true,
"isAntireqCheckSkipped": true,
"isSupplementaryCourse": true,
"isEnrollmentAdjusted": true,
"catalogYearId": 0,
"requiredCourseCategoryId": 0,
"studentEnrollmentDpaCourseCategoryId": 0,
"enrollmentTotalCredits": 0,
"enrollmenTotaltHours": 0,
"isOverlapTermConflict": true,
"isAlreadyTakingConflict": true,
"isCourseToRegister": true,
"isRegisterExceedingCourseElectivePoolLimit": true,
"isGlobalCumulativeIncluded": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"entity": {"transcripNote": "string",
"isCrsg": true,
"studentEnrollmentPeriodIdList": [0
],
"studentEnrollmentDpaCourseCategoryId": 0,
"campusId": 0,
"studentTransferCreditMultipleCourseAssociationId": 0,
"studentTransferCreditMultipleId": 0,
"id": 0,
"academicYear": { },
"adEnrollRegistrationId": 0,
"advisedDate": "2019-08-24T14:15:22Z",
"appealType": "string",
"auditEffectiveDate": "2019-08-24T14:15:22Z",
"averageBestOfPercentFinal": 0,
"billedDate": "2019-08-24T14:15:22Z",
"classSectionId": 0,
"clockHours": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"collegeId": 0,
"consecutiveMinutesAbsent": 0,
"cost": 0,
"courseAddedFrom": "string",
"courseFeeScheduleId": 0,
"courseId": 0,
"courseName": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"crossReferenceCourseId": 0,
"dateReqMet": "2019-08-24T14:15:22Z",
"dependentClassSectionId": 0,
"dropDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"examRegistrationComments": "string",
"examStatus": "string",
"expectedDeadlineDate": "2019-08-24T14:15:22Z",
"expectedEndDate": "2019-08-24T14:15:22Z",
"facultyPostedLda": "2019-08-24T14:15:22Z",
"faStudentAyPaymentPeriodId": 0,
"finalGradeReasonId": 0,
"gradePoints": 0,
"gradePostedDate": "2019-08-24T14:15:22Z",
"gradeScaleId": 0,
"highSchoolId": 0,
"include": true,
"incompleteGradeNote": "string",
"inProgressGrade": 0,
"isAfterAddDrop": true,
"isAuditCourse": true,
"isAutoDrop": true,
"isCostScheduled": true,
"isCourseRefundPolicyUsed": true,
"isCrossReferencedCourse": true,
"isEnrollmentAdjusted": true,
"isExtended": true,
"isExtensionBilled": "2019-08-24T14:15:22Z",
"isFromPortal": true,
"isGlobalCumulativeIncluded": true,
"isHalfTicketGenerated": true,
"isIncludedInGpaCalc": true,
"isIncompleteGradeReplaced": true,
"isOnlyRateScheduleUsed": true,
"isPassFail": true,
"isSpecialExam": true,
"isStudentDegreePathwayCourse": true,
"isSubstitute": true,
"isTransferCredit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"letterGrade": "string",
"lmsExtractStatus": "string",
"makeUpMinutes": 0,
"midTermGradeNote": "string",
"midTermGradePostedDate": "2019-08-24T14:15:22Z",
"midTermLetterGrade": "string",
"midTermNumericGrade": 0,
"minutesAbsent": 0,
"minutesAttended": 0,
"modFlag": "string",
"note": "string",
"numericGrade": 0,
"outsideCourseWorkHours": 0,
"overrideCourseProgression": "string",
"payStatus": "string",
"previousStatus": "string",
"qualityPoints": 0,
"requiredCourseId": 0,
"retakeFeeWaived": "string",
"retakeFlag": "string",
"retakeOverride": true,
"retakeTiv2CredEarnValue": 0,
"retakeTiv2CredEarnZeroed": true,
"revenueReferenceNumber": "string",
"rosterFlag": "string",
"rowVersion": "string",
"speed": { },
"startDate": "2019-08-24T14:15:22Z",
"status": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentTransferCreditId": 0,
"substituteCourseId": 0,
"supplementaryStatus": "string",
"termId": 0,
"testingScheduleId": 0,
"transcriptNote": "string",
"transferredCourseCode": "string",
"transferredCourseDescrip": "string",
"transferTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"prereqCoreqStatusSummaryInfoMessageList": [{"summaryInfoMessageId": 0,
"classSectionId": 0,
"courseId": 0,
"prereqCheckStatus": 0,
"coreqCheckStatus": 0,
"prereqFailureMessage": "string",
"coreqFailureMessage": "string",
"prereqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"coreqFailureInfoMessagList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"antireqFailureMessage": "string",
"antireqCheckStatus": 0,
"antireqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
]
}
],
"conflictMessageList": [{"type": "string",
"conflictType": "string",
"conflictDetail": "string"
}
],
"isAllowedToOverrideRegistrationGroup": true,
"allowOverrideRegistrationHold": true,
"isAllowedToOverrideClosedTerm": true,
"isOverlapWithParentTermAllowed": true,
"isAllowedToWaitListStudent": true,
"isAllowedPostCourseStartDateRegistration": true,
"isAllowedToOverrideLockedTermSequence": true,
"isAllowedToOverrideRegistrationConflict": true,
"isAddDropPeriodClassSectionAllowed": true,
"isAllowStudentAcademicYearPaymentPeriod": true,
"isAllowedToOverrideStudentIntoCourse": true,
"isAllowedToWaitlistAvailableStudentIntoCourse": true,
"isAllowedToWaitlistStudentIntoCourse": true,
"isAllowedToOverrideRetakeAttempts": true,
"isAllowedToAuditCourse": true,
"isAllowedCourse": true,
"isAllowedRegisterAsAuditClass": true,
"isRetakeOverride": true,
"isAllowedDateTimeConflict": true,
"isAllowedMaxClassSizeRegisterOverride": true,
"isWaitlistStudentNotified": true,
"isAllowedToWaitListForDifferentSection": true,
"isWaitListBlockedForDifferentSection": true,
"isWaitlistBlockedForStudent": true,
"isReservedStudentBlocked": true,
"isAllowedToOverrideCourseStatus": true,
"isAutoAddMsg": true,
"isRetakeValidationDisplayed": true,
"isClassInScheduledState": true,
"courseName": "string",
"statuses": "string",
"isAuditCourse": true,
"isAvailableSeats": true,
"isAllowedToWaitlist": true,
"isRegistrationGroupPermission": true,
"groupDescrip": "string",
"registrationShortDate": "string",
"registrationShortTime": "string",
"isOverlapTermConflict": true,
"isAlreadyTakingConflict": true,
"isWaitListCourseCreditsExceeded": true,
"isCourseCreditsHoursExceededElectivePoolCredits": true,
"numberOfCreditsHoursExceedingElectivePoolCreditsHours": 0,
"numberOfElectivePoolCreditsHours": 0,
"electivePoolLimitDetail": {"programVersionCreditHourType": "string",
"electivePoolName": "string"
},
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Student Course Transfer Section

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-studentcoursetransfersection-request-payload)

studentCourseId	number <int32>
newClassSectionId	number <int32>
isAllowedToOverrideRegistrationConflict	boolean
skipCoreqCheck	boolean
skipPrereqCheck	boolean
ignoreMultiCourseDependency	boolean
allowOverrideRegistrationPrereqCoreqConflict	boolean
failureMessageType	number <int32>
isAddDropPeriodClassSectionAllowed	boolean
campusId	number <int32>
isReservedStatus	boolean
isAllowedMaxClassSizeRegisterOverride	boolean
isAllowedDateTimeConflict	boolean
isRetakeOverride	boolean
isAllowedRegisterAsAuditClass	boolean
isAllowedToWaitListStudent	boolean
allowCompletedLessons	boolean
allowDeletedOnSectionTransfer	boolean
hours	number <double>
credits	number <double>
isTermValidationSkipped	boolean
isAntireqCheckSkipped	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentCourseId": 0,
"newClassSectionId": 0,
"isAllowedToOverrideRegistrationConflict": true,
"skipCoreqCheck": true,
"skipPrereqCheck": true,
"ignoreMultiCourseDependency": true,
"allowOverrideRegistrationPrereqCoreqConflict": true,
"failureMessageType": 0,
"isAddDropPeriodClassSectionAllowed": true,
"campusId": 0,
"isReservedStatus": true,
"isAllowedMaxClassSizeRegisterOverride": true,
"isAllowedDateTimeConflict": true,
"isRetakeOverride": true,
"isAllowedRegisterAsAuditClass": true,
"isAllowedToWaitListStudent": true,
"allowCompletedLessons": true,
"allowDeletedOnSectionTransfer": true,
"hours": 0,
"credits": 0,
"isTermValidationSkipped": true,
"isAntireqCheckSkipped": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isAllowedRegisterAsAuditClass": true,
"isRetakeOverride": true,
"isAllowedDateTimeConflict": true,
"isAllowedMaxClassSizeRegisterOverride": true,
"isReservedStatus": true,
"isAllowedToWaitListStudent": true,
"allowCompletedLessons": true,
"allowDeletedOnSectionTransfer": true,
"isAddDropPeriodClassSectionAllowed": true,
"isAutoAddMsg": true,
"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"prereqCoreqStatusSummaryInfoMessageList": [{"summaryInfoMessageId": 0,
"classSectionId": 0,
"courseId": 0,
"prereqCheckStatus": 0,
"coreqCheckStatus": 0,
"prereqFailureMessage": "string",
"coreqFailureMessage": "string",
"prereqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"coreqFailureInfoMessagList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"antireqFailureMessage": "string",
"antireqCheckStatus": 0,
"antireqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
]
}
],
"impectedCourseDetails": [{"studentCourseId": 0,
"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"addDropCourseDetails": {"message": "string",
"disable": true
}
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Unassociate Student Enrollment

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-unassociatestudentenrollment-request-payload)

studentEnrollmentScheduleId	number <int32>
studentEnrollmentPeriodId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentEnrollmentScheduleId": 0,
"studentEnrollmentPeriodId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentEnrollmentScheduleId": 0,
"studentEnrollmentPeriodId": 0,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Unregister Class Section Roster

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-unregisterclasssectionroster-request-payload)

isOnlyParentAllowed	boolean
classSectionId	number <int32>
isAllowedToOverrideClosedTerm	boolean
impactedStudentCourseIdList	Array of numbers <int32> [ items <int32 > ]
courseStatusChangeReasonId	number <int32>
hours	number <double>
isMultiCourseDependencyIgnored	boolean
isCoreqCheckSkipped	boolean
isPrereqCheckSkipped	boolean
isTermValidationSkipped	boolean
isOverrideRegistrationPrereqCoreqConflictAllowed	boolean
isClassSectionAllowed	boolean
status	string
description	string
crossReferenceCourseId	number <int32>
isCrossReferencedCourse	boolean
credits	number <double>
note	string
isAddDropPeriodClassSectionAllowed	boolean
studentCourseIdList	Array of numbers <int32> [ items <int32 > ]
	Array of objects (cmc-nexus-academics-services-studentCourseDetails)
isOverrideRegistrationConflictAllowed	boolean
isAntireqCheckSkipped	boolean
failureMessageType	number <int32>
isAllConflictOverridden	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isOnlyParentAllowed": true,
"classSectionId": 0,
"isAllowedToOverrideClosedTerm": true,
"impactedStudentCourseIdList": [0
],
"courseStatusChangeReasonId": 0,
"hours": 0,
"isMultiCourseDependencyIgnored": true,
"isCoreqCheckSkipped": true,
"isPrereqCheckSkipped": true,
"isTermValidationSkipped": true,
"isOverrideRegistrationPrereqCoreqConflictAllowed": true,
"isClassSectionAllowed": true,
"status": "string",
"description": "string",
"crossReferenceCourseId": 0,
"isCrossReferencedCourse": true,
"credits": 0,
"note": "string",
"isAddDropPeriodClassSectionAllowed": true,
"studentCourseIdList": [0
],
"studentCourseDetailList": [{"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"isAuditCourse": true,
"isCrossReferencedCourse": true,
"crossReferenceCourseId": 0,
"courseId": 0,
"classSectionId": 0,
"startDate": "2019-08-24T14:15:22Z",
"termId": 0,
"campusId": 0,
"courseStatus": "string"
}
],
"isOverrideRegistrationConflictAllowed": true,
"isAntireqCheckSkipped": true,
"failureMessageType": 0,
"isAllConflictOverridden": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"prereqCoreqStatusSummaryInfoMessageList": [{"summaryInfoMessageId": 0,
"classSectionId": 0,
"courseId": 0,
"prereqCheckStatus": 0,
"coreqCheckStatus": 0,
"prereqFailureMessage": "string",
"coreqFailureMessage": "string",
"prereqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"coreqFailureInfoMessagList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"antireqFailureMessage": "string",
"antireqCheckStatus": 0,
"antireqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
]
}
],
"impactedCourseDetails": [{"studentCourseId": 0,
"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"addDropCourseDetails": {"message": "string",
"disable": true
}
}
],
"isAllowedToOverrideClosedTerm": true,
"studentCourseDetailsList": [{"studentCourseId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"isAuditCourse": true,
"isCrossReferencedCourse": true,
"crossReferenceCourseId": 0,
"courseId": 0,
"classSectionId": 0,
"startDate": "2019-08-24T14:15:22Z",
"termId": 0,
"campusId": 0,
"courseStatus": "string"
}
],
"conflictMessageList": [{"type": "string",
"conflictType": "string",
"conflictDetail": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Unregister Student Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-unregisterstudentcourse-request-payload)

studentCourseId	number <int32>
isAddDropPeriodClassSectionAllowed	boolean
comments	string
credits	number <double>
isCrossReferencedCourse	boolean
crossReferenceCourseId	number <int32>
description	string
status	string
allowClassSection	boolean
isAllowedToOverrideRegistrationConflict	boolean
allowOverrideRegistrationPrereqCoreqConflict	boolean
skipPrereqCheck	boolean
skipCoreqCheck	boolean
failureMessageType	number <int32>
ignoreMultiCourseDependency	boolean
hours	number <double>
courseStatusChangeReasonId	number <int32>
impactedStudentCourseIds	Array of numbers <int32> [ items <int32 > ]
isAllowedToOverrideClosedTerm	boolean
allowedOnlyParent	boolean
isTermValidationSkipped	boolean
isAntireqCheckSkipped	boolean
isMultipleUnregisterEnabled	boolean
isUnregisterCall	boolean
	Array of objects (cmc-nexus-academics-services-prereqCoreqStatusSummaryInfoMessage)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentCourseId": 0,
"isAddDropPeriodClassSectionAllowed": true,
"comments": "string",
"credits": 0,
"isCrossReferencedCourse": true,
"crossReferenceCourseId": 0,
"description": "string",
"status": "string",
"allowClassSection": true,
"isAllowedToOverrideRegistrationConflict": true,
"allowOverrideRegistrationPrereqCoreqConflict": true,
"skipPrereqCheck": true,
"skipCoreqCheck": true,
"failureMessageType": 0,
"ignoreMultiCourseDependency": true,
"hours": 0,
"courseStatusChangeReasonId": 0,
"impactedStudentCourseIds": [0
],
"isAllowedToOverrideClosedTerm": true,
"allowedOnlyParent": true,
"isTermValidationSkipped": true,
"isAntireqCheckSkipped": true,
"isMultipleUnregisterEnabled": true,
"isUnregisterCall": true,
"prereqCoreqStatusSummaryInfoMessageListForAudit": [{"summaryInfoMessageId": 0,
"classSectionId": 0,
"courseId": 0,
"prereqCheckStatus": 0,
"coreqCheckStatus": 0,
"prereqFailureMessage": "string",
"coreqFailureMessage": "string",
"prereqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": "string",
"failureMessage": "string",
"creditsEarned": 0,
"minCreditsRequired": 0,
"minGradeLevelId": 0,
"earnedGradeLevelId": 0,
"minGradeLevelDescrip": "string",
"earnedGradeLevelDescrip": "string",
"hoursEarned": 0,
"minHoursRequired": 0,
"numberRemainingRequiredCredits": 0,
"remainingProgramRequiredCreditHours": 0
},
"ruleInfoMessageList": [{"ruleInfoMessageId": null,
"ruleId": null,
"parentRuleId": null,
"rule": null,
"passed": null,
"ruleType": null,
"failureMessage": null,
"numberOfComponents": null,
"numberOfMinmumRequiredComponents": null,
"numberOfFailedComponents": null,
"ruleComponentInfoMessageList": [ ]
}
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"coreqFailureInfoMessagList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": "string",
"failureMessage": "string",
"creditsEarned": 0,
"minCreditsRequired": 0,
"minGradeLevelId": 0,
"earnedGradeLevelId": 0,
"minGradeLevelDescrip": "string",
"earnedGradeLevelDescrip": "string",
"hoursEarned": 0,
"minHoursRequired": 0,
"numberRemainingRequiredCredits": 0,
"remainingProgramRequiredCreditHours": 0
},
"ruleInfoMessageList": [{"ruleInfoMessageId": null,
"ruleId": null,
"parentRuleId": null,
"rule": null,
"passed": null,
"ruleType": null,
"failureMessage": null,
"numberOfComponents": null,
"numberOfMinmumRequiredComponents": null,
"numberOfFailedComponents": null,
"ruleComponentInfoMessageList": [ ]
}
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"antireqFailureMessage": "string",
"antireqCheckStatus": 0,
"antireqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": "string",
"failureMessage": "string",
"creditsEarned": 0,
"minCreditsRequired": 0,
"minGradeLevelId": 0,
"earnedGradeLevelId": 0,
"minGradeLevelDescrip": "string",
"earnedGradeLevelDescrip": "string",
"hoursEarned": 0,
"minHoursRequired": 0,
"numberRemainingRequiredCredits": 0,
"remainingProgramRequiredCreditHours": 0
},
"ruleInfoMessageList": [{"ruleInfoMessageId": null,
"ruleId": null,
"parentRuleId": null,
"rule": null,
"passed": null,
"ruleType": null,
"failureMessage": null,
"numberOfComponents": null,
"numberOfMinmumRequiredComponents": null,
"numberOfFailedComponents": null,
"ruleComponentInfoMessageList": [ ]
}
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
]
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"prereqCoreqStatusSummaryInfoMessageList": [{"summaryInfoMessageId": 0,
"classSectionId": 0,
"courseId": 0,
"prereqCheckStatus": 0,
"coreqCheckStatus": 0,
"prereqFailureMessage": "string",
"coreqFailureMessage": "string",
"prereqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"coreqFailureInfoMessagList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"antireqFailureMessage": "string",
"antireqCheckStatus": 0,
"antireqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
]
}
],
"prereqCoreqStatusSummaryInfoMessageListForAudit": [{"summaryInfoMessageId": 0,
"classSectionId": 0,
"courseId": 0,
"prereqCheckStatus": 0,
"coreqCheckStatus": 0,
"prereqFailureMessage": "string",
"coreqFailureMessage": "string",
"prereqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"coreqFailureInfoMessagList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
],
"antireqFailureMessage": "string",
"antireqCheckStatus": 0,
"antireqFailureInfoMessageList": [{"failureInfoMessageId": 0,
"summaryInfoMessageId": 0,
"impactedCourseId": 0,
"impactedClassSectionId": 0,
"impactedCourseCode": "string",
"impactedCourseDescription": "string",
"impactedCourseTermCode": "string",
"prereqCoreqType": "string",
"failureMessage": "string",
"rule": "string",
"numberOfMandatoryNodes": 0,
"numberOfFailedMandatoryNodes": 0,
"numberOfOptionalNodes": 0,
"numberOfFailedOptionalNodes": 0,
"nodeInfoMessageList": [{"nodeInfoMessageId": 0,
"failureInfoMessageId": 0,
"nodeType": "string",
"isMandatory": true,
"passed": true,
"failureMessage": "string",
"rule": "string",
"code": "string",
"creditsHoursGradeInfoMessage": {"rule": null,
"failureMessage": null,
"creditsEarned": null,
"minCreditsRequired": null,
"minGradeLevelId": null,
"earnedGradeLevelId": null,
"minGradeLevelDescrip": null,
"earnedGradeLevelDescrip": null,
"hoursEarned": null,
"minHoursRequired": null,
"numberRemainingRequiredCredits": null,
"remainingProgramRequiredCreditHours": null
},
"ruleInfoMessageList": [null
]
}
],
"impactedDegreeCourseStatusType": 0,
"impactedDegreeCourseId": 0
}
]
}
],
"conflictMessageList": [{"type": "string",
"conflictType": "string",
"conflictDetail": "string"
}
],
"impectedCourseDetails": [{"studentCourseId": 0,
"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"addDropCourseDetails": {"message": "string",
"disable": true
}
}
],
"isAllowedToOverrideClosedTerm": true,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Update Advise Status

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-updateadvisestatus-request-payload)

studentCourseId	number <int32>
studentId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentCourseId": 0,
"studentId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Update Student Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-updatestudentcourse-request-payload)

previousCourseEndDate	string <date-time>
newCourseEndDate	string <date-time>
statusDate	string <date-time>
campusId	number <int32>
isAllowedToOverrideRegistrationConflict	boolean
overrideClosedTerm	boolean
isTermValidationSkipped	boolean
isAllowedCourse	boolean
isAllowedToOverrideRetakeAttempts	boolean
isAllowedToAuditCourse	boolean
	object (cmc-nexus-academics-entities-studentCourseEntity)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"previousCourseEndDate": "2019-08-24T14:15:22Z",
"newCourseEndDate": "2019-08-24T14:15:22Z",
"statusDate": "2019-08-24T14:15:22Z",
"campusId": 0,
"isAllowedToOverrideRegistrationConflict": true,
"overrideClosedTerm": true,
"isTermValidationSkipped": true,
"isAllowedCourse": true,
"isAllowedToOverrideRetakeAttempts": true,
"isAllowedToAuditCourse": true,
"entity": {"transcripNote": "string",
"isCrsg": true,
"studentEnrollmentPeriodIdList": [0
],
"studentEnrollmentDpaCourseCategoryId": 0,
"campusId": 0,
"studentTransferCreditMultipleCourseAssociationId": 0,
"studentTransferCreditMultipleId": 0,
"id": 0,
"academicYear": { },
"adEnrollRegistrationId": 0,
"advisedDate": "2019-08-24T14:15:22Z",
"appealType": "string",
"auditEffectiveDate": "2019-08-24T14:15:22Z",
"averageBestOfPercentFinal": 0,
"billedDate": "2019-08-24T14:15:22Z",
"classSectionId": 0,
"clockHours": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"collegeId": 0,
"consecutiveMinutesAbsent": 0,
"cost": 0,
"courseAddedFrom": "string",
"courseFeeScheduleId": 0,
"courseId": 0,
"courseName": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"crossReferenceCourseId": 0,
"dateReqMet": "2019-08-24T14:15:22Z",
"dependentClassSectionId": 0,
"dropDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"examRegistrationComments": "string",
"examStatus": "string",
"expectedDeadlineDate": "2019-08-24T14:15:22Z",
"expectedEndDate": "2019-08-24T14:15:22Z",
"facultyPostedLda": "2019-08-24T14:15:22Z",
"faStudentAyPaymentPeriodId": 0,
"finalGradeReasonId": 0,
"gradePoints": 0,
"gradePostedDate": "2019-08-24T14:15:22Z",
"gradeScaleId": 0,
"highSchoolId": 0,
"include": true,
"incompleteGradeNote": "string",
"inProgressGrade": 0,
"isAfterAddDrop": true,
"isAuditCourse": true,
"isAutoDrop": true,
"isCostScheduled": true,
"isCourseRefundPolicyUsed": true,
"isCrossReferencedCourse": true,
"isEnrollmentAdjusted": true,
"isExtended": true,
"isExtensionBilled": "2019-08-24T14:15:22Z",
"isFromPortal": true,
"isGlobalCumulativeIncluded": true,
"isHalfTicketGenerated": true,
"isIncludedInGpaCalc": true,
"isIncompleteGradeReplaced": true,
"isOnlyRateScheduleUsed": true,
"isPassFail": true,
"isSpecialExam": true,
"isStudentDegreePathwayCourse": true,
"isSubstitute": true,
"isTransferCredit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"letterGrade": "string",
"lmsExtractStatus": "string",
"makeUpMinutes": 0,
"midTermGradeNote": "string",
"midTermGradePostedDate": "2019-08-24T14:15:22Z",
"midTermLetterGrade": "string",
"midTermNumericGrade": 0,
"minutesAbsent": 0,
"minutesAttended": 0,
"modFlag": "string",
"note": "string",
"numericGrade": 0,
"outsideCourseWorkHours": 0,
"overrideCourseProgression": "string",
"payStatus": "string",
"previousStatus": "string",
"qualityPoints": 0,
"requiredCourseId": 0,
"retakeFeeWaived": "string",
"retakeFlag": "string",
"retakeOverride": true,
"retakeTiv2CredEarnValue": 0,
"retakeTiv2CredEarnZeroed": true,
"revenueReferenceNumber": "string",
"rosterFlag": "string",
"rowVersion": "string",
"speed": { },
"startDate": "2019-08-24T14:15:22Z",
"status": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentTransferCreditId": 0,
"substituteCourseId": 0,
"supplementaryStatus": "string",
"termId": 0,
"testingScheduleId": 0,
"transcriptNote": "string",
"transferredCourseCode": "string",
"transferredCourseDescrip": "string",
"transferTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}
}

Response samples

Content type

application/json

{"payload": {"data": {"entity": {"transcripNote": "string",
"isCrsg": true,
"studentEnrollmentPeriodIdList": [0
],
"studentEnrollmentDpaCourseCategoryId": 0,
"campusId": 0,
"studentTransferCreditMultipleCourseAssociationId": 0,
"studentTransferCreditMultipleId": 0,
"id": 0,
"academicYear": { },
"adEnrollRegistrationId": 0,
"advisedDate": "2019-08-24T14:15:22Z",
"appealType": "string",
"auditEffectiveDate": "2019-08-24T14:15:22Z",
"averageBestOfPercentFinal": 0,
"billedDate": "2019-08-24T14:15:22Z",
"classSectionId": 0,
"clockHours": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"collegeId": 0,
"consecutiveMinutesAbsent": 0,
"cost": 0,
"courseAddedFrom": "string",
"courseFeeScheduleId": 0,
"courseId": 0,
"courseName": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"crossReferenceCourseId": 0,
"dateReqMet": "2019-08-24T14:15:22Z",
"dependentClassSectionId": 0,
"dropDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"enrollmentStatusClockHours": 0,
"enrollmentStatusCreditHours": 0,
"examRegistrationComments": "string",
"examStatus": "string",
"expectedDeadlineDate": "2019-08-24T14:15:22Z",
"expectedEndDate": "2019-08-24T14:15:22Z",
"facultyPostedLda": "2019-08-24T14:15:22Z",
"faStudentAyPaymentPeriodId": 0,
"finalGradeReasonId": 0,
"gradePoints": 0,
"gradePostedDate": "2019-08-24T14:15:22Z",
"gradeScaleId": 0,
"highSchoolId": 0,
"include": true,
"incompleteGradeNote": "string",
"inProgressGrade": 0,
"isAfterAddDrop": true,
"isAuditCourse": true,
"isAutoDrop": true,
"isCostScheduled": true,
"isCourseRefundPolicyUsed": true,
"isCrossReferencedCourse": true,
"isEnrollmentAdjusted": true,
"isExtended": true,
"isExtensionBilled": "2019-08-24T14:15:22Z",
"isFromPortal": true,
"isGlobalCumulativeIncluded": true,
"isHalfTicketGenerated": true,
"isIncludedInGpaCalc": true,
"isIncompleteGradeReplaced": true,
"isOnlyRateScheduleUsed": true,
"isPassFail": true,
"isSpecialExam": true,
"isStudentDegreePathwayCourse": true,
"isSubstitute": true,
"isTransferCredit": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"letterGrade": "string",
"lmsExtractStatus": "string",
"makeUpMinutes": 0,
"midTermGradeNote": "string",
"midTermGradePostedDate": "2019-08-24T14:15:22Z",
"midTermLetterGrade": "string",
"midTermNumericGrade": 0,
"minutesAbsent": 0,
"minutesAttended": 0,
"modFlag": "string",
"note": "string",
"numericGrade": 0,
"outsideCourseWorkHours": 0,
"overrideCourseProgression": "string",
"payStatus": "string",
"previousStatus": "string",
"qualityPoints": 0,
"requiredCourseId": 0,
"retakeFeeWaived": "string",
"retakeFlag": "string",
"retakeOverride": true,
"retakeTiv2CredEarnValue": 0,
"retakeTiv2CredEarnZeroed": true,
"revenueReferenceNumber": "string",
"rosterFlag": "string",
"rowVersion": "string",
"speed": { },
"startDate": "2019-08-24T14:15:22Z",
"status": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentTransferCreditId": 0,
"substituteCourseId": 0,
"supplementaryStatus": "string",
"termId": 0,
"testingScheduleId": 0,
"transcriptNote": "string",
"transferredCourseCode": "string",
"transferredCourseDescrip": "string",
"transferTypeId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lockEvaluationOutputList": [{"registrationRuleId": 0,
"failedLockType": "string",
"limit": 0,
"actual": 0,
"unitType": "string",
"isIncludedDropCourses": true,
"isIncludedLoaCourses": true
}
],
"isStaffHasPermissionToOverrideClosedTerm": true,
"isAllowedCourse": true,
"isAllowedToOverrideRetakeAttempts": true,
"isAllowedToAuditCourse": true,
"statusList": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Update Student Course Progress

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-updatestudentcourseprogress-request-payload)

adEnrollSchedId	number <int32>
overrideCourseProgressionCode	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"adEnrollSchedId": 0,
"overrideCourseProgressionCode": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"adEnrollSchedId": 0,
"overrideCourseProgressionCode": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Update Student Future Course List

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-updatestudentfuturecourselist-request-payload)

studentEnrollmentPeriodId	number <int32>
isManualAddCourseRemoved	boolean
campus	Array of numbers <int32> [ items <int32 > ]
programVersion	Array of numbers <int32> [ items <int32 > ]
schoolStatus	Array of numbers <int32> [ items <int32 > ]
lowStartDate	string
highStartDate	string
lowExpStartDate	string
highExpStartDate	string
isUpdateStudentCourseList	boolean
isUpdateRequiredRule	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentEnrollmentPeriodId": 0,
"isManualAddCourseRemoved": true,
"campus": [0
],
"programVersion": [0
],
"schoolStatus": [0
],
"lowStartDate": "string",
"highStartDate": "string",
"lowExpStartDate": "string",
"highExpStartDate": "string",
"isUpdateStudentCourseList": true,
"isUpdateRequiredRule": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentFutureCourseList": [{"lastName": "string",
"firstName": "string",
"syStudentID": 0,
"adEnrollID": 0,
"programVersion": "string",
"schoolStatus": "string",
"campus": "string",
"studentNumber": "string",
"studentName": "string"
}
],
"messages": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Validate Student Course Term

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentcourse-validatestudentcourseterm-request-payload)

studentId	number <int32>
termId	number <int32>
studentEnrollmentPeriodId	number <int32>
classSectionIds	object
campusId	number <int32>
isOverrideClosedTermAllowed	boolean
isAddDropPeriodClassSectionAllowed	boolean
isTermValidationSkipped	boolean
isOverrideRegistrationGroupAllowed	boolean
isOverrideLockedTermSequenceAllowed	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentId": 0,
"termId": 0,
"studentEnrollmentPeriodId": 0,
"classSectionIds": { },
"campusId": 0,
"isOverrideClosedTermAllowed": true,
"isAddDropPeriodClassSectionAllowed": true,
"isTermValidationSkipped": true,
"isOverrideRegistrationGroupAllowed": true,
"isOverrideLockedTermSequenceAllowed": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isOverrideClosedTermAllowed": true,
"isAddDropPeriodClassSectionAllowed": true,
"isOverrideRegistrationGroupAllowed": true,
"isOverrideLockedTermSequenceAllowed": true,
"lockedTermSequenceCourseList": "string",
"isRegistrationGroupPermission": true,
"groupDescrip": "string",
"registrationShortDate": "string",
"registrationShortTime": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

StudentEnrollmentDpaCourse

Create Student Enrollment Dpa Course

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"studentId": 0,
"isStudentEnrollmentPeriodCreditHoursAdjusted": true,
"isRetakeOverrideAllowed": true,
"numberRequired": 0,
"minimumCredits": 0,
"maximumCredits": 0,
"id": 0,
"clockHours": 0,
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"electiveClockHours": 0,
"electiveCreditHours": 0,
"electiveNote": "string",
"electivePoolName": "string",
"isAdvisementRequired": true,
"isDropExcluded": true,
"isEnrollmentAdjusted": true,
"isManualAdd": true,
"isSubstituteAllowed": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"maxNumberRepeats": 0,
"minimumGpa": 0,
"note": "string",
"requiredCourseId": 0,
"rowVersion": "string",
"studentEnrollmentDpaCourseCategoryId": 0,
"studentEnrollmentPeriodId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Student Enrollment Dpa Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentdpacourse-delete-request-payload)

studentId	number <int32>
isStudentEnrollmentPeriodCreditHoursAdjusted	boolean
isRetakeOverrideAllowed	boolean
numberRequired	number <int32>
minimumCredits	number <double>
maximumCredits	number <double>
id	number <int32> Id
clockHours	number <double> Clock Hours
courseId	number <int32> Course Id
createdDateTime	string <date-time> Created Date Time
creditHours	number <double> Credit Hours
electiveClockHours	number <double> Elective Clock Hours
electiveCreditHours	number <double> Elective Credit Hours
electiveNote	string Elective Note
electivePoolName	string Elective Pool Name
isAdvisementRequired	boolean Is Advisement Required
isDropExcluded	boolean Is Drop Excluded
isEnrollmentAdjusted	boolean Is Enrollment Adjusted
isManualAdd	boolean Is Manual Add
isSubstituteAllowed	boolean Is Substitute Allowed
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
maxNumberRepeats	number <int32> Max Number Repeats
minimumGpa	number <double> Minimum Gpa
note	string Note
requiredCourseId	number <int32> Required Course Id
rowVersion	string
studentEnrollmentDpaCourseCategoryId	number <int32> Student Enrollment Dpa Course Category Id
studentEnrollmentPeriodId	number <int32> Student Enrollment Period Id
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentId": 0,
"isStudentEnrollmentPeriodCreditHoursAdjusted": true,
"isRetakeOverrideAllowed": true,
"numberRequired": 0,
"minimumCredits": 0,
"maximumCredits": 0,
"id": 0,
"clockHours": 0,
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"electiveClockHours": 0,
"electiveCreditHours": 0,
"electiveNote": "string",
"electivePoolName": "string",
"isAdvisementRequired": true,
"isDropExcluded": true,
"isEnrollmentAdjusted": true,
"isManualAdd": true,
"isSubstituteAllowed": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"maxNumberRepeats": 0,
"minimumGpa": 0,
"note": "string",
"requiredCourseId": 0,
"rowVersion": "string",
"studentEnrollmentDpaCourseCategoryId": 0,
"studentEnrollmentPeriodId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Student Enrollment Dpa Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentdpacourse-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentId": 0,
"isStudentEnrollmentPeriodCreditHoursAdjusted": true,
"isRetakeOverrideAllowed": true,
"numberRequired": 0,
"minimumCredits": 0,
"maximumCredits": 0,
"id": 0,
"clockHours": 0,
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"electiveClockHours": 0,
"electiveCreditHours": 0,
"electiveNote": "string",
"electivePoolName": "string",
"isAdvisementRequired": true,
"isDropExcluded": true,
"isEnrollmentAdjusted": true,
"isManualAdd": true,
"isSubstituteAllowed": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"maxNumberRepeats": 0,
"minimumGpa": 0,
"note": "string",
"requiredCourseId": 0,
"rowVersion": "string",
"studentEnrollmentDpaCourseCategoryId": 0,
"studentEnrollmentPeriodId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Student Enrollment Dpa Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentdpacourse-save-request-payload)

studentId	number <int32>
isStudentEnrollmentPeriodCreditHoursAdjusted	boolean
isRetakeOverrideAllowed	boolean
numberRequired	number <int32>
minimumCredits	number <double>
maximumCredits	number <double>
id	number <int32> Id
clockHours	number <double> Clock Hours
courseId	number <int32> Course Id
createdDateTime	string <date-time> Created Date Time
creditHours	number <double> Credit Hours
electiveClockHours	number <double> Elective Clock Hours
electiveCreditHours	number <double> Elective Credit Hours
electiveNote	string Elective Note
electivePoolName	string Elective Pool Name
isAdvisementRequired	boolean Is Advisement Required
isDropExcluded	boolean Is Drop Excluded
isEnrollmentAdjusted	boolean Is Enrollment Adjusted
isManualAdd	boolean Is Manual Add
isSubstituteAllowed	boolean Is Substitute Allowed
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
maxNumberRepeats	number <int32> Max Number Repeats
minimumGpa	number <double> Minimum Gpa
note	string Note
requiredCourseId	number <int32> Required Course Id
rowVersion	string
studentEnrollmentDpaCourseCategoryId	number <int32> Student Enrollment Dpa Course Category Id
studentEnrollmentPeriodId	number <int32> Student Enrollment Period Id
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentId": 0,
"isStudentEnrollmentPeriodCreditHoursAdjusted": true,
"isRetakeOverrideAllowed": true,
"numberRequired": 0,
"minimumCredits": 0,
"maximumCredits": 0,
"id": 0,
"clockHours": 0,
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"electiveClockHours": 0,
"electiveCreditHours": 0,
"electiveNote": "string",
"electivePoolName": "string",
"isAdvisementRequired": true,
"isDropExcluded": true,
"isEnrollmentAdjusted": true,
"isManualAdd": true,
"isSubstituteAllowed": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"maxNumberRepeats": 0,
"minimumGpa": 0,
"note": "string",
"requiredCourseId": 0,
"rowVersion": "string",
"studentEnrollmentDpaCourseCategoryId": 0,
"studentEnrollmentPeriodId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentId": 0,
"isStudentEnrollmentPeriodCreditHoursAdjusted": true,
"isRetakeOverrideAllowed": true,
"numberRequired": 0,
"minimumCredits": 0,
"maximumCredits": 0,
"id": 0,
"clockHours": 0,
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"electiveClockHours": 0,
"electiveCreditHours": 0,
"electiveNote": "string",
"electivePoolName": "string",
"isAdvisementRequired": true,
"isDropExcluded": true,
"isEnrollmentAdjusted": true,
"isManualAdd": true,
"isSubstituteAllowed": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"maxNumberRepeats": 0,
"minimumGpa": 0,
"note": "string",
"requiredCourseId": 0,
"rowVersion": "string",
"studentEnrollmentDpaCourseCategoryId": 0,
"studentEnrollmentPeriodId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Student Enrollment Dpa Course

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentdpacourse-savenew-request-payload)

studentId	number <int32>
isStudentEnrollmentPeriodCreditHoursAdjusted	boolean
isRetakeOverrideAllowed	boolean
numberRequired	number <int32>
minimumCredits	number <double>
maximumCredits	number <double>
id	number <int32> Id
clockHours	number <double> Clock Hours
courseId	number <int32> Course Id
createdDateTime	string <date-time> Created Date Time
creditHours	number <double> Credit Hours
electiveClockHours	number <double> Elective Clock Hours
electiveCreditHours	number <double> Elective Credit Hours
electiveNote	string Elective Note
electivePoolName	string Elective Pool Name
isAdvisementRequired	boolean Is Advisement Required
isDropExcluded	boolean Is Drop Excluded
isEnrollmentAdjusted	boolean Is Enrollment Adjusted
isManualAdd	boolean Is Manual Add
isSubstituteAllowed	boolean Is Substitute Allowed
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
maxNumberRepeats	number <int32> Max Number Repeats
minimumGpa	number <double> Minimum Gpa
note	string Note
requiredCourseId	number <int32> Required Course Id
rowVersion	string
studentEnrollmentDpaCourseCategoryId	number <int32> Student Enrollment Dpa Course Category Id
studentEnrollmentPeriodId	number <int32> Student Enrollment Period Id
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentId": 0,
"isStudentEnrollmentPeriodCreditHoursAdjusted": true,
"isRetakeOverrideAllowed": true,
"numberRequired": 0,
"minimumCredits": 0,
"maximumCredits": 0,
"id": 0,
"clockHours": 0,
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"electiveClockHours": 0,
"electiveCreditHours": 0,
"electiveNote": "string",
"electivePoolName": "string",
"isAdvisementRequired": true,
"isDropExcluded": true,
"isEnrollmentAdjusted": true,
"isManualAdd": true,
"isSubstituteAllowed": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"maxNumberRepeats": 0,
"minimumGpa": 0,
"note": "string",
"requiredCourseId": 0,
"rowVersion": "string",
"studentEnrollmentDpaCourseCategoryId": 0,
"studentEnrollmentPeriodId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentId": 0,
"isStudentEnrollmentPeriodCreditHoursAdjusted": true,
"isRetakeOverrideAllowed": true,
"numberRequired": 0,
"minimumCredits": 0,
"maximumCredits": 0,
"id": 0,
"clockHours": 0,
"courseId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHours": 0,
"electiveClockHours": 0,
"electiveCreditHours": 0,
"electiveNote": "string",
"electivePoolName": "string",
"isAdvisementRequired": true,
"isDropExcluded": true,
"isEnrollmentAdjusted": true,
"isManualAdd": true,
"isSubstituteAllowed": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"maxNumberRepeats": 0,
"minimumGpa": 0,
"note": "string",
"requiredCourseId": 0,
"rowVersion": "string",
"studentEnrollmentDpaCourseCategoryId": 0,
"studentEnrollmentPeriodId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Waive Course Requirement

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentdpacourse-waivecourserequirement-request-payload)

studentEnrollmentDpaCourseId	number <int32>
studentEnrollmentPeriodId	number <int32>
studentId	number <int32>
isEnrollmentCreditHoursAdjusted	boolean
isRequirementUnitsAdjusted	boolean
electiveCreditHours	number <double>
electiveClockHours	number <double>
electiveNote	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentEnrollmentDpaCourseId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"isEnrollmentCreditHoursAdjusted": true,
"isRequirementUnitsAdjusted": true,
"electiveCreditHours": 0,
"electiveClockHours": 0,
"electiveNote": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

StudentEnrollmentPeriod

Create Student Enrollment Period

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"statusColor": "string",
"systemStatusCategory": "string",
"registeredCreditHours": 0,
"registeredClockHours": 0,
"nsldsStatusName": "string",
"isLastStatusTransfer": true,
"isTermAggregateRegisteredCredits": true,
"previousTransferStudentEnrollmentPeriodId": 0,
"previousSchoolStatusId": 0,
"studentAdvisorList": [{"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"academicAdvisor": {"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"isBatchCatalogAssignment": true,
"isUpdateStudentEnrollmentPeriod": true,
"message": "string",
"isDocumentDelete": true,
"id": 0,
"academicAdvisorId": 0,
"accountReceivableBalance": 0,
"actualStartDate": "2019-08-24T14:15:22Z",
"admissionsRegionId": 0,
"agencyBranchId": 0,
"aosTransferDate": "2019-08-24T14:15:22Z",
"applicantProgress": 0,
"applicantTypeId": 0,
"applicationReceivedDate": "2019-08-24T14:15:22Z",
"assignedAdmissionsRepId": 0,
"autoChargesTermId": 0,
"billedDate": "2019-08-24T14:15:22Z",
"billingMethodId": 0,
"campusId": 0,
"catalogYearId": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"clockHoursRequired": 0,
"clockHoursScheduled": 0,
"coreCreditHoursAttempted": 0,
"coreCreditHoursEarned": 0,
"coreGpa": 0,
"coreNumericAvg": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"creditHoursRequired": 0,
"creditHoursScheduled": 0,
"cumGpaPoints": 0,
"daysAbsent": 0,
"degreeAudit": "string",
"dropDate": "2019-08-24T14:15:22Z",
"dropEarn": 0,
"dropType": "string",
"enrollmentDate": "2019-08-24T14:15:22Z",
"enrollmentNumber": "string",
"enrollmentStatusId": 0,
"expectedCreditsHoursPerTerm": 0,
"expectedHoursPerWeekForExternship": 0,
"expectedRefundProcessDate": "2019-08-24T14:15:22Z",
"expectedStartDate": "2019-08-24T14:15:22Z",
"externshipBeginDate": "2019-08-24T14:15:22Z",
"faEntranceInterviewDate": "2019-08-24T14:15:22Z",
"faExitInterviewDate": "2019-08-24T14:15:22Z",
"financialAidCredits": 0,
"gpa": 0,
"gpaCreditHours": 0,
"gradeLevelId": 0,
"gradeScaleId": 0,
"graduationDate": "2019-08-24T14:15:22Z",
"ipedsState": "string",
"isApplicant": true,
"isAttendanceArchived": true,
"isIpedsTransfer": true,
"isReenrollment": { },
"isTransfer": true,
"isUiUpdate": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"linkedSapStudentEnrollmentPeriodId": 0,
"midpointDate": "2019-08-24T14:15:22Z",
"minutesAbsent": 0,
"minutesAttended": 0,
"minutesMakeUp": 0,
"note": "string",
"nsldsWithdrawalDate": "2019-08-24T14:15:22Z",
"numericAverage": 0,
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalGraduationDate": "2019-08-24T14:15:22Z",
"outsideCourseWorkHours": 0,
"previousEducationId": 0,
"previousGradDate": "2019-08-24T14:15:22Z",
"programId": 0,
"programVersionId": 0,
"programVersionName": "string",
"recalculateTermSequence": true,
"reenrollDate": "2019-08-24T14:15:22Z",
"reentryAfter180Date": "2019-08-24T14:15:22Z",
"rightsResponsibilitiesAck": true,
"rowVersion": "string",
"sapCheckpoint": { },
"sapFlag": "string",
"sapStatusId": 0,
"schoolStatusChangeDate": "2019-08-24T14:15:22Z",
"schoolStatusChangeReasonId": 0,
"schoolStatusId": 0,
"shiftId": 0,
"speProgression": 0,
"startDateId": 0,
"startTermId": 0,
"statusChangeType": 0,
"studentId": 0,
"transcriptIssued": "2019-08-24T14:15:22Z",
"transferCreditHours": 0,
"transferInDate": "2019-08-24T14:15:22Z",
"student": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Student Enrollment Period

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentperiod-delete-request-payload)

isExcludedCrmIntegration	boolean
statusColor	string
systemStatusCategory	string
registeredCreditHours	number <double>
registeredClockHours	number <double>
nsldsStatusName	string
isLastStatusTransfer	boolean
isTermAggregateRegisteredCredits	boolean
previousTransferStudentEnrollmentPeriodId	number <int32>
previousSchoolStatusId	number <int32>
	Array of objects (cmc-nexus-common-entities-studentAdvisorEntity)
	object (cmc-nexus-common-entities-studentAdvisorEntity)
isBatchCatalogAssignment	boolean
isUpdateStudentEnrollmentPeriod	boolean
message	string
isDocumentDelete	boolean
id	number <int32> Id
academicAdvisorId	number <int32> Academic Advisor Id
accountReceivableBalance	number <double> Account Receivable Balance
actualStartDate	string <date-time> The start date of the program version for the campus that the student is enrolling in.
admissionsRegionId	number <int32> Admissions Region Id
agencyBranchId	number <int32> Agency Branch Id
aosTransferDate	string <date-time> Aos Transfer Date
applicantProgress	number <int32> Applicant Progress
applicantTypeId	number <int32> The type of application. The application types are configured by your organization.
applicationReceivedDate	string <date-time> The date when the student applied for internship training (either CPT or OPT).
assignedAdmissionsRepId	number <int32> The Admissions Representative for the student. If a staff member is removed from an Admissions Representative group after having been assigned to a student, CampusNexus Student retains the name of the former representative on the student record.
autoChargesTermId	number <int32> Auto Charges Term Id
billedDate	string <date-time> The date the student was billed using the billing method configured for the program version.
billingMethodId	number <int32> The method used to bill the student, for example, monthly, term, course, and so on. They are configured by your institution.
campusId	number <int32> The campus or campuses to which a person or item is assigned. If there is more than one campus, all the campuses are listed. In lists, if the column contains more than one campus, you cannot sort or filter on that column.
catalogYearId	number <int32> Displays the catalog associated with the program version that you select for a student. The catalog contains the courses required for a program version or area of study. They are configured by your institution.
clockHoursAttempted	number <double> Clock Hours Attempted
clockHoursEarned	number <double> Clock Hours Earned
clockHoursRequired	number <double> Clock Hours Required
clockHoursScheduled	number <double> The total number of credits or hours that are in a scheduled or current status at the time of enrollment.
coreCreditHoursAttempted	number <double> Core Credit Hours Attempted
coreCreditHoursEarned	number <double> Core Credit Hours Earned
coreGpa	number <double> Core Gpa
coreNumericAvg	number <double> Core Numeric Avg
createdDateTime	string <date-time> The date when the item or person was added or the status change was entered.
creditHoursAttempted	number <double> Credit Hours Attempted
creditHoursEarned	number <double> The number of credits earned by the student to date.
creditHoursRequired	number <double> The number of credits or hours required for the course or enrollment.
creditHoursScheduled	number <double> Credit Hours Scheduled
cumGpaPoints	number <double> Cum Gpa Points
daysAbsent	number <double> The number of complete days that the student was absent from the campus or institution.
degreeAudit	string Degree Audit
dropDate	string <date-time> The date when the student dropped the enrollment.
dropEarn	number <double> Drop Earn
dropType	string Drop Type
enrollmentDate	string <date-time> The date that the student enrolled at the institution.
enrollmentNumber	string The number assigned during the enrollment based on the parameters specified by the institution.
enrollmentStatusId	number <int32> The enrollment status included in the student's Enrollment record. For example, Full Time.
expectedCreditsHoursPerTerm	number <double> The total number of credits the student is expected to complete per term.
expectedHoursPerWeekForExternship	number <double> The number of hours per week that the student is expected to complete in the training or externship. The number of hours specified must be less than the Total Hours for Externship.
expectedRefundProcessDate	string <date-time> The date when the refund was processed.
expectedStartDate	string <date-time> The expected start date for the student at your institution.
externshipBeginDate	string <date-time> The start date of the training or externship.
faEntranceInterviewDate	string <date-time> The date of the financial aid interview. If the field contains a value, the source of this date depends on your institution. The date can be the date from the Direct Loan Entrance Counseling (CRECMYOP) or Direct Loan Plus Application Acknowledgment (CRSPyyOP) files imported from COD. If you institution has configured an entrance interview document, the date from the document can be used when the document has an approved and on file status. You can also manually specify the date.
faExitInterviewDate	string <date-time> The date when the Financial Aid Exit Interview was conducted with the student.
financialAidCredits	number <double> Financial Aid Credits
gpa	number <double> The overall GPA for the current enrollment the student is registered for.
gpaCreditHours	number <double> Gpa Credit Hours
gradeLevelId	number <int32> The grade level for the student. Grade levels are configured by your institution and do not have to correspond to the option on the FAFSA or Stafford Loan forms. For a student to qualify for a Graduate PLUS loan, the grade level must be configured with the Department of Education ID 7 (Graduate/Professional or beyond).
gradeScaleId	number <int32> The grading parameters used by your institution uses to evaluate the academic achievements of the students.
graduationDate	string <date-time> The date that student graduated from the program.
ipedsState	string The state included in the permanent address submitted by the student at the time of application.
isApplicant	boolean Is Applicant
isAttendanceArchived	boolean Is Attendance Archived
isIpedsTransfer	boolean The check box is selected only if the student has transfer credits with a transfer type set to "Include as Transfer Student (for IPEDS reporting).
isReenrollment	object Is Reenrollment
isTransfer	boolean Is Transfer
isUiUpdate	boolean Is Ui Update
lastActivityDate	string <date-time> Last Activity Date
lastModifiedDateTime	string <date-time> The date that the item was updated or changed.
lastModifiedUserId	number <int32> The last and then first name of the person that changed the item.
lda	string <date-time> The day the student last attended a class in this program version.
linkedSapStudentEnrollmentPeriodId	number <int32> The program version description of the linked SAP enrollment.
midpointDate	string <date-time> The estimated midpoint date for students who enter the program version based on the program version start date.
minutesAbsent	number <int32> Minutes Absent
minutesAttended	number <double> Minutes Attended
minutesMakeUp	number <int32> The number of makeup hours accumulated by the student.
note	string Note
nsldsWithdrawalDate	string <date-time> The effective date, stored in SSCR and Clearinghouse records, when a student withdrew from the institution.
numericAverage	number <double> The current numeric average of class sections graded for the specified student. If the institution does not use numeric grading, this value will be zero.
originalAssignedAdmissionsRepId	number <int32> The last and then first name of the admissions representative initially assigned to the student.
originalExpectedStartDate	string <date-time> The date when the student was expected to start the enrollment. The date is determined at the time of the student's first enrollment and cannot be edited.
originalGraduationDate	string <date-time> The original expected graduation date at the time of enrollment. This date cannot be edited.
outsideCourseWorkHours	number <double> Outside Course Work Hours
previousEducationId	number <int32> The previous education history of the student.
previousGradDate	string <date-time> Previous Grad Date
programId	number <int32> The name of the program. Programs are configured by your institution.
programVersionId	number <int32> The version of the program. Program versions are configured by your institution to distinguish between variations of a program.
programVersionName	string Program Version Name
recalculateTermSequence	boolean Recalculate Term Sequence
reenrollDate	string <date-time> The date when the student reentered the program version.
reentryAfter180Date	string <date-time> Reentry After180Date
rightsResponsibilitiesAck	boolean The acknowledgement of rigths and responsibilities. If you import the DECFyyOP file that contains entrance counsleing results, the check box is selected or not selected based on the setting for the student in the file.
rowVersion	string
sapCheckpoint	object Sap Checkpoint
sapFlag	string Sap Flag
sapStatusId	number <int32> The student's academic progress.
schoolStatusChangeDate	string <date-time> The date that the student status was last changed.
schoolStatusChangeReasonId	number <int32> Reasons why students change from student status to another student status. The reasons are configured by your institution.
schoolStatusId	number <int32> Specifies the status of the prospect or student at your institution. Statuses vary by institution. They are configured by your institution. If you change the status for a student, a dialog is displayed so that you can confirm the change. If there are also tasks associated with the previous status, CampusNexus Student displays a dialog that you can use to select the tasks to keep and the tasks to close with the result of canceled.
shiftId	number <int32> The shift that the student will attend classes (such as day or evenings). They are configured by your institution.
speProgression	number <double> Spe Progression
startDateId	number <int32> Start Date Id
startTermId	number <int32> The Code, Name, and dates (start and end dates) for available terms.
statusChangeType	number <int32> Status Change Type
studentId	number <int32> Student Id
transcriptIssued	string <date-time> Transcript Issued
transferCreditHours	number <double> Number of clock hours to transfer.
transferInDate	string <date-time> The date when the student was transferred out of the program version.
	object (cmc-nexus-common-entities-studentEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"statusColor": "string",
"systemStatusCategory": "string",
"registeredCreditHours": 0,
"registeredClockHours": 0,
"nsldsStatusName": "string",
"isLastStatusTransfer": true,
"isTermAggregateRegisteredCredits": true,
"previousTransferStudentEnrollmentPeriodId": 0,
"previousSchoolStatusId": 0,
"studentAdvisorList": [{"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"academicAdvisor": {"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"isBatchCatalogAssignment": true,
"isUpdateStudentEnrollmentPeriod": true,
"message": "string",
"isDocumentDelete": true,
"id": 0,
"academicAdvisorId": 0,
"accountReceivableBalance": 0,
"actualStartDate": "2019-08-24T14:15:22Z",
"admissionsRegionId": 0,
"agencyBranchId": 0,
"aosTransferDate": "2019-08-24T14:15:22Z",
"applicantProgress": 0,
"applicantTypeId": 0,
"applicationReceivedDate": "2019-08-24T14:15:22Z",
"assignedAdmissionsRepId": 0,
"autoChargesTermId": 0,
"billedDate": "2019-08-24T14:15:22Z",
"billingMethodId": 0,
"campusId": 0,
"catalogYearId": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"clockHoursRequired": 0,
"clockHoursScheduled": 0,
"coreCreditHoursAttempted": 0,
"coreCreditHoursEarned": 0,
"coreGpa": 0,
"coreNumericAvg": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"creditHoursRequired": 0,
"creditHoursScheduled": 0,
"cumGpaPoints": 0,
"daysAbsent": 0,
"degreeAudit": "string",
"dropDate": "2019-08-24T14:15:22Z",
"dropEarn": 0,
"dropType": "string",
"enrollmentDate": "2019-08-24T14:15:22Z",
"enrollmentNumber": "string",
"enrollmentStatusId": 0,
"expectedCreditsHoursPerTerm": 0,
"expectedHoursPerWeekForExternship": 0,
"expectedRefundProcessDate": "2019-08-24T14:15:22Z",
"expectedStartDate": "2019-08-24T14:15:22Z",
"externshipBeginDate": "2019-08-24T14:15:22Z",
"faEntranceInterviewDate": "2019-08-24T14:15:22Z",
"faExitInterviewDate": "2019-08-24T14:15:22Z",
"financialAidCredits": 0,
"gpa": 0,
"gpaCreditHours": 0,
"gradeLevelId": 0,
"gradeScaleId": 0,
"graduationDate": "2019-08-24T14:15:22Z",
"ipedsState": "string",
"isApplicant": true,
"isAttendanceArchived": true,
"isIpedsTransfer": true,
"isReenrollment": { },
"isTransfer": true,
"isUiUpdate": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"linkedSapStudentEnrollmentPeriodId": 0,
"midpointDate": "2019-08-24T14:15:22Z",
"minutesAbsent": 0,
"minutesAttended": 0,
"minutesMakeUp": 0,
"note": "string",
"nsldsWithdrawalDate": "2019-08-24T14:15:22Z",
"numericAverage": 0,
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalGraduationDate": "2019-08-24T14:15:22Z",
"outsideCourseWorkHours": 0,
"previousEducationId": 0,
"previousGradDate": "2019-08-24T14:15:22Z",
"programId": 0,
"programVersionId": 0,
"programVersionName": "string",
"recalculateTermSequence": true,
"reenrollDate": "2019-08-24T14:15:22Z",
"reentryAfter180Date": "2019-08-24T14:15:22Z",
"rightsResponsibilitiesAck": true,
"rowVersion": "string",
"sapCheckpoint": { },
"sapFlag": "string",
"sapStatusId": 0,
"schoolStatusChangeDate": "2019-08-24T14:15:22Z",
"schoolStatusChangeReasonId": 0,
"schoolStatusId": 0,
"shiftId": 0,
"speProgression": 0,
"startDateId": 0,
"startTermId": 0,
"statusChangeType": 0,
"studentId": 0,
"transcriptIssued": "2019-08-24T14:15:22Z",
"transferCreditHours": 0,
"transferInDate": "2019-08-24T14:15:22Z",
"student": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Enrollment Status Change

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentperiod-enrollmentstatuschange-request-payload)

studentEnrollmentPeriodId	number <int32>
newSchoolStatusId	number <int32>
schoolStatusChangeReasonId	number <int32>
effectiveDate	string <date-time>
graduationDate	string <date-time>
beginDate	string <date-time>
returnDate	string <date-time>
lastAttendedDate	string <date-time>
determinationDate	string <date-time>
withdrawalDate	string <date-time>
note	string
useEnrollmentGraduationDate	boolean
deletePendingChanges	boolean
deleteCourseAssociation	boolean
overrideStatusChangeDays	boolean
isOfficialWithdrawal	boolean
removeAttendanceBackToLastAttendedDate	boolean
overrideSapEnrollmentLinking	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentEnrollmentPeriodId": 0,
"newSchoolStatusId": 0,
"schoolStatusChangeReasonId": 0,
"effectiveDate": "2019-08-24T14:15:22Z",
"graduationDate": "2019-08-24T14:15:22Z",
"beginDate": "2019-08-24T14:15:22Z",
"returnDate": "2019-08-24T14:15:22Z",
"lastAttendedDate": "2019-08-24T14:15:22Z",
"determinationDate": "2019-08-24T14:15:22Z",
"withdrawalDate": "2019-08-24T14:15:22Z",
"note": "string",
"useEnrollmentGraduationDate": true,
"deletePendingChanges": true,
"deleteCourseAssociation": true,
"overrideStatusChangeDays": true,
"isOfficialWithdrawal": true,
"removeAttendanceBackToLastAttendedDate": true,
"overrideSapEnrollmentLinking": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Enroll Student

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentperiod-enrollstudent-request-payload)

isDegreeProgramType	boolean
isChangeDateApplicable	boolean
isReEntryApplicable	boolean
	Array of objects (cmc-nexus-academics-services-savedProgramVersionAreaOfStudyConfigList)
isOverriddeEnrollmentStatusCategory	boolean
isBudgetApplicable	boolean
isBillMethodChange	boolean
loaStart	string <date-time>
loaReturn	string <date-time>
isCatalogYearChanged	boolean
isGraduationDateChanged	boolean
previousGraduationDate	string <date-time>
loaPreviousSchoolStatusId	number <int32>
previousProgramVersionId	number <int32>
previousSchoolStatusId	number <int32>
previousSystemSchoolStatusId	number <int32>
faaNotificationStaffId	number <int32>
faaNotificationMessage	string
previousBillingMethodId	number <int32>
previousStudentEnrollmentPeriodId	number <int32>
	object (cmc-nexus-academics-entities-studentEnrollmentPeriodEntity)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isDegreeProgramType": true,
"isChangeDateApplicable": true,
"isReEntryApplicable": true,
"programVersionAreaOfStudyConfigList": [{"pkId": 0,
"adConcentrationId": 0,
"code": "string",
"descrip": "string",
"adMajorId": 0,
"adMajorCode": "string",
"selListId": 0,
"typeId": 0,
"typeCode": "string",
"typeDescrip": "string",
"mode": 0,
"adProgramVersionId": 0,
"adCatalogYearId": 0,
"effectiveDate": "2019-08-24T14:15:22Z"
}
],
"isOverriddeEnrollmentStatusCategory": true,
"isBudgetApplicable": true,
"isBillMethodChange": true,
"loaStart": "2019-08-24T14:15:22Z",
"loaReturn": "2019-08-24T14:15:22Z",
"isCatalogYearChanged": true,
"isGraduationDateChanged": true,
"previousGraduationDate": "2019-08-24T14:15:22Z",
"loaPreviousSchoolStatusId": 0,
"previousProgramVersionId": 0,
"previousSchoolStatusId": 0,
"previousSystemSchoolStatusId": 0,
"faaNotificationStaffId": 0,
"faaNotificationMessage": "string",
"previousBillingMethodId": 0,
"previousStudentEnrollmentPeriodId": 0,
"entity": {"isExcludedCrmIntegration": true,
"statusColor": "string",
"systemStatusCategory": "string",
"registeredCreditHours": 0,
"registeredClockHours": 0,
"nsldsStatusName": "string",
"isLastStatusTransfer": true,
"isTermAggregateRegisteredCredits": true,
"previousTransferStudentEnrollmentPeriodId": 0,
"previousSchoolStatusId": 0,
"studentAdvisorList": [{"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"academicAdvisor": {"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"isBatchCatalogAssignment": true,
"isUpdateStudentEnrollmentPeriod": true,
"message": "string",
"isDocumentDelete": true,
"id": 0,
"academicAdvisorId": 0,
"accountReceivableBalance": 0,
"actualStartDate": "2019-08-24T14:15:22Z",
"admissionsRegionId": 0,
"agencyBranchId": 0,
"aosTransferDate": "2019-08-24T14:15:22Z",
"applicantProgress": 0,
"applicantTypeId": 0,
"applicationReceivedDate": "2019-08-24T14:15:22Z",
"assignedAdmissionsRepId": 0,
"autoChargesTermId": 0,
"billedDate": "2019-08-24T14:15:22Z",
"billingMethodId": 0,
"campusId": 0,
"catalogYearId": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"clockHoursRequired": 0,
"clockHoursScheduled": 0,
"coreCreditHoursAttempted": 0,
"coreCreditHoursEarned": 0,
"coreGpa": 0,
"coreNumericAvg": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"creditHoursRequired": 0,
"creditHoursScheduled": 0,
"cumGpaPoints": 0,
"daysAbsent": 0,
"degreeAudit": "string",
"dropDate": "2019-08-24T14:15:22Z",
"dropEarn": 0,
"dropType": "string",
"enrollmentDate": "2019-08-24T14:15:22Z",
"enrollmentNumber": "string",
"enrollmentStatusId": 0,
"expectedCreditsHoursPerTerm": 0,
"expectedHoursPerWeekForExternship": 0,
"expectedRefundProcessDate": "2019-08-24T14:15:22Z",
"expectedStartDate": "2019-08-24T14:15:22Z",
"externshipBeginDate": "2019-08-24T14:15:22Z",
"faEntranceInterviewDate": "2019-08-24T14:15:22Z",
"faExitInterviewDate": "2019-08-24T14:15:22Z",
"financialAidCredits": 0,
"gpa": 0,
"gpaCreditHours": 0,
"gradeLevelId": 0,
"gradeScaleId": 0,
"graduationDate": "2019-08-24T14:15:22Z",
"ipedsState": "string",
"isApplicant": true,
"isAttendanceArchived": true,
"isIpedsTransfer": true,
"isReenrollment": { },
"isTransfer": true,
"isUiUpdate": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"linkedSapStudentEnrollmentPeriodId": 0,
"midpointDate": "2019-08-24T14:15:22Z",
"minutesAbsent": 0,
"minutesAttended": 0,
"minutesMakeUp": 0,
"note": "string",
"nsldsWithdrawalDate": "2019-08-24T14:15:22Z",
"numericAverage": 0,
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalGraduationDate": "2019-08-24T14:15:22Z",
"outsideCourseWorkHours": 0,
"previousEducationId": 0,
"previousGradDate": "2019-08-24T14:15:22Z",
"programId": 0,
"programVersionId": 0,
"programVersionName": "string",
"recalculateTermSequence": true,
"reenrollDate": "2019-08-24T14:15:22Z",
"reentryAfter180Date": "2019-08-24T14:15:22Z",
"rightsResponsibilitiesAck": true,
"rowVersion": "string",
"sapCheckpoint": { },
"sapFlag": "string",
"sapStatusId": 0,
"schoolStatusChangeDate": "2019-08-24T14:15:22Z",
"schoolStatusChangeReasonId": 0,
"schoolStatusId": 0,
"shiftId": 0,
"speProgression": 0,
"startDateId": 0,
"startTermId": 0,
"statusChangeType": 0,
"studentId": 0,
"transcriptIssued": "2019-08-24T14:15:22Z",
"transferCreditHours": 0,
"transferInDate": "2019-08-24T14:15:22Z",
"student": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}
}

Response samples

Content type

application/json

{"payload": {"data": {"entity": {"isExcludedCrmIntegration": true,
"statusColor": "string",
"systemStatusCategory": "string",
"registeredCreditHours": 0,
"registeredClockHours": 0,
"nsldsStatusName": "string",
"isLastStatusTransfer": true,
"isTermAggregateRegisteredCredits": true,
"previousTransferStudentEnrollmentPeriodId": 0,
"previousSchoolStatusId": 0,
"studentAdvisorList": [{"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"academicAdvisor": {"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"isBatchCatalogAssignment": true,
"isUpdateStudentEnrollmentPeriod": true,
"message": "string",
"isDocumentDelete": true,
"id": 0,
"academicAdvisorId": 0,
"accountReceivableBalance": 0,
"actualStartDate": "2019-08-24T14:15:22Z",
"admissionsRegionId": 0,
"agencyBranchId": 0,
"aosTransferDate": "2019-08-24T14:15:22Z",
"applicantProgress": 0,
"applicantTypeId": 0,
"applicationReceivedDate": "2019-08-24T14:15:22Z",
"assignedAdmissionsRepId": 0,
"autoChargesTermId": 0,
"billedDate": "2019-08-24T14:15:22Z",
"billingMethodId": 0,
"campusId": 0,
"catalogYearId": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"clockHoursRequired": 0,
"clockHoursScheduled": 0,
"coreCreditHoursAttempted": 0,
"coreCreditHoursEarned": 0,
"coreGpa": 0,
"coreNumericAvg": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"creditHoursRequired": 0,
"creditHoursScheduled": 0,
"cumGpaPoints": 0,
"daysAbsent": 0,
"degreeAudit": "string",
"dropDate": "2019-08-24T14:15:22Z",
"dropEarn": 0,
"dropType": "string",
"enrollmentDate": "2019-08-24T14:15:22Z",
"enrollmentNumber": "string",
"enrollmentStatusId": 0,
"expectedCreditsHoursPerTerm": 0,
"expectedHoursPerWeekForExternship": 0,
"expectedRefundProcessDate": "2019-08-24T14:15:22Z",
"expectedStartDate": "2019-08-24T14:15:22Z",
"externshipBeginDate": "2019-08-24T14:15:22Z",
"faEntranceInterviewDate": "2019-08-24T14:15:22Z",
"faExitInterviewDate": "2019-08-24T14:15:22Z",
"financialAidCredits": 0,
"gpa": 0,
"gpaCreditHours": 0,
"gradeLevelId": 0,
"gradeScaleId": 0,
"graduationDate": "2019-08-24T14:15:22Z",
"ipedsState": "string",
"isApplicant": true,
"isAttendanceArchived": true,
"isIpedsTransfer": true,
"isReenrollment": { },
"isTransfer": true,
"isUiUpdate": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"linkedSapStudentEnrollmentPeriodId": 0,
"midpointDate": "2019-08-24T14:15:22Z",
"minutesAbsent": 0,
"minutesAttended": 0,
"minutesMakeUp": 0,
"note": "string",
"nsldsWithdrawalDate": "2019-08-24T14:15:22Z",
"numericAverage": 0,
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalGraduationDate": "2019-08-24T14:15:22Z",
"outsideCourseWorkHours": 0,
"previousEducationId": 0,
"previousGradDate": "2019-08-24T14:15:22Z",
"programId": 0,
"programVersionId": 0,
"programVersionName": "string",
"recalculateTermSequence": true,
"reenrollDate": "2019-08-24T14:15:22Z",
"reentryAfter180Date": "2019-08-24T14:15:22Z",
"rightsResponsibilitiesAck": true,
"rowVersion": "string",
"sapCheckpoint": { },
"sapFlag": "string",
"sapStatusId": 0,
"schoolStatusChangeDate": "2019-08-24T14:15:22Z",
"schoolStatusChangeReasonId": 0,
"schoolStatusId": 0,
"shiftId": 0,
"speProgression": 0,
"startDateId": 0,
"startTermId": 0,
"statusChangeType": 0,
"studentId": 0,
"transcriptIssued": "2019-08-24T14:15:22Z",
"transferCreditHours": 0,
"transferInDate": "2019-08-24T14:15:22Z",
"student": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Student Enrollment Period

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentperiod-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"statusColor": "string",
"systemStatusCategory": "string",
"registeredCreditHours": 0,
"registeredClockHours": 0,
"nsldsStatusName": "string",
"isLastStatusTransfer": true,
"isTermAggregateRegisteredCredits": true,
"previousTransferStudentEnrollmentPeriodId": 0,
"previousSchoolStatusId": 0,
"studentAdvisorList": [{"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"academicAdvisor": {"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"isBatchCatalogAssignment": true,
"isUpdateStudentEnrollmentPeriod": true,
"message": "string",
"isDocumentDelete": true,
"id": 0,
"academicAdvisorId": 0,
"accountReceivableBalance": 0,
"actualStartDate": "2019-08-24T14:15:22Z",
"admissionsRegionId": 0,
"agencyBranchId": 0,
"aosTransferDate": "2019-08-24T14:15:22Z",
"applicantProgress": 0,
"applicantTypeId": 0,
"applicationReceivedDate": "2019-08-24T14:15:22Z",
"assignedAdmissionsRepId": 0,
"autoChargesTermId": 0,
"billedDate": "2019-08-24T14:15:22Z",
"billingMethodId": 0,
"campusId": 0,
"catalogYearId": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"clockHoursRequired": 0,
"clockHoursScheduled": 0,
"coreCreditHoursAttempted": 0,
"coreCreditHoursEarned": 0,
"coreGpa": 0,
"coreNumericAvg": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"creditHoursRequired": 0,
"creditHoursScheduled": 0,
"cumGpaPoints": 0,
"daysAbsent": 0,
"degreeAudit": "string",
"dropDate": "2019-08-24T14:15:22Z",
"dropEarn": 0,
"dropType": "string",
"enrollmentDate": "2019-08-24T14:15:22Z",
"enrollmentNumber": "string",
"enrollmentStatusId": 0,
"expectedCreditsHoursPerTerm": 0,
"expectedHoursPerWeekForExternship": 0,
"expectedRefundProcessDate": "2019-08-24T14:15:22Z",
"expectedStartDate": "2019-08-24T14:15:22Z",
"externshipBeginDate": "2019-08-24T14:15:22Z",
"faEntranceInterviewDate": "2019-08-24T14:15:22Z",
"faExitInterviewDate": "2019-08-24T14:15:22Z",
"financialAidCredits": 0,
"gpa": 0,
"gpaCreditHours": 0,
"gradeLevelId": 0,
"gradeScaleId": 0,
"graduationDate": "2019-08-24T14:15:22Z",
"ipedsState": "string",
"isApplicant": true,
"isAttendanceArchived": true,
"isIpedsTransfer": true,
"isReenrollment": { },
"isTransfer": true,
"isUiUpdate": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"linkedSapStudentEnrollmentPeriodId": 0,
"midpointDate": "2019-08-24T14:15:22Z",
"minutesAbsent": 0,
"minutesAttended": 0,
"minutesMakeUp": 0,
"note": "string",
"nsldsWithdrawalDate": "2019-08-24T14:15:22Z",
"numericAverage": 0,
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalGraduationDate": "2019-08-24T14:15:22Z",
"outsideCourseWorkHours": 0,
"previousEducationId": 0,
"previousGradDate": "2019-08-24T14:15:22Z",
"programId": 0,
"programVersionId": 0,
"programVersionName": "string",
"recalculateTermSequence": true,
"reenrollDate": "2019-08-24T14:15:22Z",
"reentryAfter180Date": "2019-08-24T14:15:22Z",
"rightsResponsibilitiesAck": true,
"rowVersion": "string",
"sapCheckpoint": { },
"sapFlag": "string",
"sapStatusId": 0,
"schoolStatusChangeDate": "2019-08-24T14:15:22Z",
"schoolStatusChangeReasonId": 0,
"schoolStatusId": 0,
"shiftId": 0,
"speProgression": 0,
"startDateId": 0,
"startTermId": 0,
"statusChangeType": 0,
"studentId": 0,
"transcriptIssued": "2019-08-24T14:15:22Z",
"transferCreditHours": 0,
"transferInDate": "2019-08-24T14:15:22Z",
"student": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Rebuild Term Relationships

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentperiod-rebuildtermrelationships-request-payload)

studentEnrollmentPeriodId

number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentEnrollmentPeriodId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isRunSap": true,
"isTermRelationshipChanged": true,
"isMissingNewParentTerm": true,
"isProcessSuccess": true,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Reverse Transfer

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentperiod-reversetransfer-request-payload)

studentEnrollmentPeriodId

number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentEnrollmentPeriodId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Student Enrollment Period

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentperiod-save-request-payload)

isExcludedCrmIntegration	boolean
statusColor	string
systemStatusCategory	string
registeredCreditHours	number <double>
registeredClockHours	number <double>
nsldsStatusName	string
isLastStatusTransfer	boolean
isTermAggregateRegisteredCredits	boolean
previousTransferStudentEnrollmentPeriodId	number <int32>
previousSchoolStatusId	number <int32>
	Array of objects (cmc-nexus-common-entities-studentAdvisorEntity)
	object (cmc-nexus-common-entities-studentAdvisorEntity)
isBatchCatalogAssignment	boolean
isUpdateStudentEnrollmentPeriod	boolean
message	string
isDocumentDelete	boolean
id	number <int32> Id
academicAdvisorId	number <int32> Academic Advisor Id
accountReceivableBalance	number <double> Account Receivable Balance
actualStartDate	string <date-time> The start date of the program version for the campus that the student is enrolling in.
admissionsRegionId	number <int32> Admissions Region Id
agencyBranchId	number <int32> Agency Branch Id
aosTransferDate	string <date-time> Aos Transfer Date
applicantProgress	number <int32> Applicant Progress
applicantTypeId	number <int32> The type of application. The application types are configured by your organization.
applicationReceivedDate	string <date-time> The date when the student applied for internship training (either CPT or OPT).
assignedAdmissionsRepId	number <int32> The Admissions Representative for the student. If a staff member is removed from an Admissions Representative group after having been assigned to a student, CampusNexus Student retains the name of the former representative on the student record.
autoChargesTermId	number <int32> Auto Charges Term Id
billedDate	string <date-time> The date the student was billed using the billing method configured for the program version.
billingMethodId	number <int32> The method used to bill the student, for example, monthly, term, course, and so on. They are configured by your institution.
campusId	number <int32> The campus or campuses to which a person or item is assigned. If there is more than one campus, all the campuses are listed. In lists, if the column contains more than one campus, you cannot sort or filter on that column.
catalogYearId	number <int32> Displays the catalog associated with the program version that you select for a student. The catalog contains the courses required for a program version or area of study. They are configured by your institution.
clockHoursAttempted	number <double> Clock Hours Attempted
clockHoursEarned	number <double> Clock Hours Earned
clockHoursRequired	number <double> Clock Hours Required
clockHoursScheduled	number <double> The total number of credits or hours that are in a scheduled or current status at the time of enrollment.
coreCreditHoursAttempted	number <double> Core Credit Hours Attempted
coreCreditHoursEarned	number <double> Core Credit Hours Earned
coreGpa	number <double> Core Gpa
coreNumericAvg	number <double> Core Numeric Avg
createdDateTime	string <date-time> The date when the item or person was added or the status change was entered.
creditHoursAttempted	number <double> Credit Hours Attempted
creditHoursEarned	number <double> The number of credits earned by the student to date.
creditHoursRequired	number <double> The number of credits or hours required for the course or enrollment.
creditHoursScheduled	number <double> Credit Hours Scheduled
cumGpaPoints	number <double> Cum Gpa Points
daysAbsent	number <double> The number of complete days that the student was absent from the campus or institution.
degreeAudit	string Degree Audit
dropDate	string <date-time> The date when the student dropped the enrollment.
dropEarn	number <double> Drop Earn
dropType	string Drop Type
enrollmentDate	string <date-time> The date that the student enrolled at the institution.
enrollmentNumber	string The number assigned during the enrollment based on the parameters specified by the institution.
enrollmentStatusId	number <int32> The enrollment status included in the student's Enrollment record. For example, Full Time.
expectedCreditsHoursPerTerm	number <double> The total number of credits the student is expected to complete per term.
expectedHoursPerWeekForExternship	number <double> The number of hours per week that the student is expected to complete in the training or externship. The number of hours specified must be less than the Total Hours for Externship.
expectedRefundProcessDate	string <date-time> The date when the refund was processed.
expectedStartDate	string <date-time> The expected start date for the student at your institution.
externshipBeginDate	string <date-time> The start date of the training or externship.
faEntranceInterviewDate	string <date-time> The date of the financial aid interview. If the field contains a value, the source of this date depends on your institution. The date can be the date from the Direct Loan Entrance Counseling (CRECMYOP) or Direct Loan Plus Application Acknowledgment (CRSPyyOP) files imported from COD. If you institution has configured an entrance interview document, the date from the document can be used when the document has an approved and on file status. You can also manually specify the date.
faExitInterviewDate	string <date-time> The date when the Financial Aid Exit Interview was conducted with the student.
financialAidCredits	number <double> Financial Aid Credits
gpa	number <double> The overall GPA for the current enrollment the student is registered for.
gpaCreditHours	number <double> Gpa Credit Hours
gradeLevelId	number <int32> The grade level for the student. Grade levels are configured by your institution and do not have to correspond to the option on the FAFSA or Stafford Loan forms. For a student to qualify for a Graduate PLUS loan, the grade level must be configured with the Department of Education ID 7 (Graduate/Professional or beyond).
gradeScaleId	number <int32> The grading parameters used by your institution uses to evaluate the academic achievements of the students.
graduationDate	string <date-time> The date that student graduated from the program.
ipedsState	string The state included in the permanent address submitted by the student at the time of application.
isApplicant	boolean Is Applicant
isAttendanceArchived	boolean Is Attendance Archived
isIpedsTransfer	boolean The check box is selected only if the student has transfer credits with a transfer type set to "Include as Transfer Student (for IPEDS reporting).
isReenrollment	object Is Reenrollment
isTransfer	boolean Is Transfer
isUiUpdate	boolean Is Ui Update
lastActivityDate	string <date-time> Last Activity Date
lastModifiedDateTime	string <date-time> The date that the item was updated or changed.
lastModifiedUserId	number <int32> The last and then first name of the person that changed the item.
lda	string <date-time> The day the student last attended a class in this program version.
linkedSapStudentEnrollmentPeriodId	number <int32> The program version description of the linked SAP enrollment.
midpointDate	string <date-time> The estimated midpoint date for students who enter the program version based on the program version start date.
minutesAbsent	number <int32> Minutes Absent
minutesAttended	number <double> Minutes Attended
minutesMakeUp	number <int32> The number of makeup hours accumulated by the student.
note	string Note
nsldsWithdrawalDate	string <date-time> The effective date, stored in SSCR and Clearinghouse records, when a student withdrew from the institution.
numericAverage	number <double> The current numeric average of class sections graded for the specified student. If the institution does not use numeric grading, this value will be zero.
originalAssignedAdmissionsRepId	number <int32> The last and then first name of the admissions representative initially assigned to the student.
originalExpectedStartDate	string <date-time> The date when the student was expected to start the enrollment. The date is determined at the time of the student's first enrollment and cannot be edited.
originalGraduationDate	string <date-time> The original expected graduation date at the time of enrollment. This date cannot be edited.
outsideCourseWorkHours	number <double> Outside Course Work Hours
previousEducationId	number <int32> The previous education history of the student.
previousGradDate	string <date-time> Previous Grad Date
programId	number <int32> The name of the program. Programs are configured by your institution.
programVersionId	number <int32> The version of the program. Program versions are configured by your institution to distinguish between variations of a program.
programVersionName	string Program Version Name
recalculateTermSequence	boolean Recalculate Term Sequence
reenrollDate	string <date-time> The date when the student reentered the program version.
reentryAfter180Date	string <date-time> Reentry After180Date
rightsResponsibilitiesAck	boolean The acknowledgement of rigths and responsibilities. If you import the DECFyyOP file that contains entrance counsleing results, the check box is selected or not selected based on the setting for the student in the file.
rowVersion	string
sapCheckpoint	object Sap Checkpoint
sapFlag	string Sap Flag
sapStatusId	number <int32> The student's academic progress.
schoolStatusChangeDate	string <date-time> The date that the student status was last changed.
schoolStatusChangeReasonId	number <int32> Reasons why students change from student status to another student status. The reasons are configured by your institution.
schoolStatusId	number <int32> Specifies the status of the prospect or student at your institution. Statuses vary by institution. They are configured by your institution. If you change the status for a student, a dialog is displayed so that you can confirm the change. If there are also tasks associated with the previous status, CampusNexus Student displays a dialog that you can use to select the tasks to keep and the tasks to close with the result of canceled.
shiftId	number <int32> The shift that the student will attend classes (such as day or evenings). They are configured by your institution.
speProgression	number <double> Spe Progression
startDateId	number <int32> Start Date Id
startTermId	number <int32> The Code, Name, and dates (start and end dates) for available terms.
statusChangeType	number <int32> Status Change Type
studentId	number <int32> Student Id
transcriptIssued	string <date-time> Transcript Issued
transferCreditHours	number <double> Number of clock hours to transfer.
transferInDate	string <date-time> The date when the student was transferred out of the program version.
	object (cmc-nexus-common-entities-studentEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"statusColor": "string",
"systemStatusCategory": "string",
"registeredCreditHours": 0,
"registeredClockHours": 0,
"nsldsStatusName": "string",
"isLastStatusTransfer": true,
"isTermAggregateRegisteredCredits": true,
"previousTransferStudentEnrollmentPeriodId": 0,
"previousSchoolStatusId": 0,
"studentAdvisorList": [{"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"academicAdvisor": {"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"isBatchCatalogAssignment": true,
"isUpdateStudentEnrollmentPeriod": true,
"message": "string",
"isDocumentDelete": true,
"id": 0,
"academicAdvisorId": 0,
"accountReceivableBalance": 0,
"actualStartDate": "2019-08-24T14:15:22Z",
"admissionsRegionId": 0,
"agencyBranchId": 0,
"aosTransferDate": "2019-08-24T14:15:22Z",
"applicantProgress": 0,
"applicantTypeId": 0,
"applicationReceivedDate": "2019-08-24T14:15:22Z",
"assignedAdmissionsRepId": 0,
"autoChargesTermId": 0,
"billedDate": "2019-08-24T14:15:22Z",
"billingMethodId": 0,
"campusId": 0,
"catalogYearId": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"clockHoursRequired": 0,
"clockHoursScheduled": 0,
"coreCreditHoursAttempted": 0,
"coreCreditHoursEarned": 0,
"coreGpa": 0,
"coreNumericAvg": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"creditHoursRequired": 0,
"creditHoursScheduled": 0,
"cumGpaPoints": 0,
"daysAbsent": 0,
"degreeAudit": "string",
"dropDate": "2019-08-24T14:15:22Z",
"dropEarn": 0,
"dropType": "string",
"enrollmentDate": "2019-08-24T14:15:22Z",
"enrollmentNumber": "string",
"enrollmentStatusId": 0,
"expectedCreditsHoursPerTerm": 0,
"expectedHoursPerWeekForExternship": 0,
"expectedRefundProcessDate": "2019-08-24T14:15:22Z",
"expectedStartDate": "2019-08-24T14:15:22Z",
"externshipBeginDate": "2019-08-24T14:15:22Z",
"faEntranceInterviewDate": "2019-08-24T14:15:22Z",
"faExitInterviewDate": "2019-08-24T14:15:22Z",
"financialAidCredits": 0,
"gpa": 0,
"gpaCreditHours": 0,
"gradeLevelId": 0,
"gradeScaleId": 0,
"graduationDate": "2019-08-24T14:15:22Z",
"ipedsState": "string",
"isApplicant": true,
"isAttendanceArchived": true,
"isIpedsTransfer": true,
"isReenrollment": { },
"isTransfer": true,
"isUiUpdate": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"linkedSapStudentEnrollmentPeriodId": 0,
"midpointDate": "2019-08-24T14:15:22Z",
"minutesAbsent": 0,
"minutesAttended": 0,
"minutesMakeUp": 0,
"note": "string",
"nsldsWithdrawalDate": "2019-08-24T14:15:22Z",
"numericAverage": 0,
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalGraduationDate": "2019-08-24T14:15:22Z",
"outsideCourseWorkHours": 0,
"previousEducationId": 0,
"previousGradDate": "2019-08-24T14:15:22Z",
"programId": 0,
"programVersionId": 0,
"programVersionName": "string",
"recalculateTermSequence": true,
"reenrollDate": "2019-08-24T14:15:22Z",
"reentryAfter180Date": "2019-08-24T14:15:22Z",
"rightsResponsibilitiesAck": true,
"rowVersion": "string",
"sapCheckpoint": { },
"sapFlag": "string",
"sapStatusId": 0,
"schoolStatusChangeDate": "2019-08-24T14:15:22Z",
"schoolStatusChangeReasonId": 0,
"schoolStatusId": 0,
"shiftId": 0,
"speProgression": 0,
"startDateId": 0,
"startTermId": 0,
"statusChangeType": 0,
"studentId": 0,
"transcriptIssued": "2019-08-24T14:15:22Z",
"transferCreditHours": 0,
"transferInDate": "2019-08-24T14:15:22Z",
"student": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"statusColor": "string",
"systemStatusCategory": "string",
"registeredCreditHours": 0,
"registeredClockHours": 0,
"nsldsStatusName": "string",
"isLastStatusTransfer": true,
"isTermAggregateRegisteredCredits": true,
"previousTransferStudentEnrollmentPeriodId": 0,
"previousSchoolStatusId": 0,
"studentAdvisorList": [{"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"academicAdvisor": {"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"isBatchCatalogAssignment": true,
"isUpdateStudentEnrollmentPeriod": true,
"message": "string",
"isDocumentDelete": true,
"id": 0,
"academicAdvisorId": 0,
"accountReceivableBalance": 0,
"actualStartDate": "2019-08-24T14:15:22Z",
"admissionsRegionId": 0,
"agencyBranchId": 0,
"aosTransferDate": "2019-08-24T14:15:22Z",
"applicantProgress": 0,
"applicantTypeId": 0,
"applicationReceivedDate": "2019-08-24T14:15:22Z",
"assignedAdmissionsRepId": 0,
"autoChargesTermId": 0,
"billedDate": "2019-08-24T14:15:22Z",
"billingMethodId": 0,
"campusId": 0,
"catalogYearId": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"clockHoursRequired": 0,
"clockHoursScheduled": 0,
"coreCreditHoursAttempted": 0,
"coreCreditHoursEarned": 0,
"coreGpa": 0,
"coreNumericAvg": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"creditHoursRequired": 0,
"creditHoursScheduled": 0,
"cumGpaPoints": 0,
"daysAbsent": 0,
"degreeAudit": "string",
"dropDate": "2019-08-24T14:15:22Z",
"dropEarn": 0,
"dropType": "string",
"enrollmentDate": "2019-08-24T14:15:22Z",
"enrollmentNumber": "string",
"enrollmentStatusId": 0,
"expectedCreditsHoursPerTerm": 0,
"expectedHoursPerWeekForExternship": 0,
"expectedRefundProcessDate": "2019-08-24T14:15:22Z",
"expectedStartDate": "2019-08-24T14:15:22Z",
"externshipBeginDate": "2019-08-24T14:15:22Z",
"faEntranceInterviewDate": "2019-08-24T14:15:22Z",
"faExitInterviewDate": "2019-08-24T14:15:22Z",
"financialAidCredits": 0,
"gpa": 0,
"gpaCreditHours": 0,
"gradeLevelId": 0,
"gradeScaleId": 0,
"graduationDate": "2019-08-24T14:15:22Z",
"ipedsState": "string",
"isApplicant": true,
"isAttendanceArchived": true,
"isIpedsTransfer": true,
"isReenrollment": { },
"isTransfer": true,
"isUiUpdate": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"linkedSapStudentEnrollmentPeriodId": 0,
"midpointDate": "2019-08-24T14:15:22Z",
"minutesAbsent": 0,
"minutesAttended": 0,
"minutesMakeUp": 0,
"note": "string",
"nsldsWithdrawalDate": "2019-08-24T14:15:22Z",
"numericAverage": 0,
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalGraduationDate": "2019-08-24T14:15:22Z",
"outsideCourseWorkHours": 0,
"previousEducationId": 0,
"previousGradDate": "2019-08-24T14:15:22Z",
"programId": 0,
"programVersionId": 0,
"programVersionName": "string",
"recalculateTermSequence": true,
"reenrollDate": "2019-08-24T14:15:22Z",
"reentryAfter180Date": "2019-08-24T14:15:22Z",
"rightsResponsibilitiesAck": true,
"rowVersion": "string",
"sapCheckpoint": { },
"sapFlag": "string",
"sapStatusId": 0,
"schoolStatusChangeDate": "2019-08-24T14:15:22Z",
"schoolStatusChangeReasonId": 0,
"schoolStatusId": 0,
"shiftId": 0,
"speProgression": 0,
"startDateId": 0,
"startTermId": 0,
"statusChangeType": 0,
"studentId": 0,
"transcriptIssued": "2019-08-24T14:15:22Z",
"transferCreditHours": 0,
"transferInDate": "2019-08-24T14:15:22Z",
"student": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Student Enrollment Period

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentperiod-savenew-request-payload)

isExcludedCrmIntegration	boolean
statusColor	string
systemStatusCategory	string
registeredCreditHours	number <double>
registeredClockHours	number <double>
nsldsStatusName	string
isLastStatusTransfer	boolean
isTermAggregateRegisteredCredits	boolean
previousTransferStudentEnrollmentPeriodId	number <int32>
previousSchoolStatusId	number <int32>
	Array of objects (cmc-nexus-common-entities-studentAdvisorEntity)
	object (cmc-nexus-common-entities-studentAdvisorEntity)
isBatchCatalogAssignment	boolean
isUpdateStudentEnrollmentPeriod	boolean
message	string
isDocumentDelete	boolean
id	number <int32> Id
academicAdvisorId	number <int32> Academic Advisor Id
accountReceivableBalance	number <double> Account Receivable Balance
actualStartDate	string <date-time> The start date of the program version for the campus that the student is enrolling in.
admissionsRegionId	number <int32> Admissions Region Id
agencyBranchId	number <int32> Agency Branch Id
aosTransferDate	string <date-time> Aos Transfer Date
applicantProgress	number <int32> Applicant Progress
applicantTypeId	number <int32> The type of application. The application types are configured by your organization.
applicationReceivedDate	string <date-time> The date when the student applied for internship training (either CPT or OPT).
assignedAdmissionsRepId	number <int32> The Admissions Representative for the student. If a staff member is removed from an Admissions Representative group after having been assigned to a student, CampusNexus Student retains the name of the former representative on the student record.
autoChargesTermId	number <int32> Auto Charges Term Id
billedDate	string <date-time> The date the student was billed using the billing method configured for the program version.
billingMethodId	number <int32> The method used to bill the student, for example, monthly, term, course, and so on. They are configured by your institution.
campusId	number <int32> The campus or campuses to which a person or item is assigned. If there is more than one campus, all the campuses are listed. In lists, if the column contains more than one campus, you cannot sort or filter on that column.
catalogYearId	number <int32> Displays the catalog associated with the program version that you select for a student. The catalog contains the courses required for a program version or area of study. They are configured by your institution.
clockHoursAttempted	number <double> Clock Hours Attempted
clockHoursEarned	number <double> Clock Hours Earned
clockHoursRequired	number <double> Clock Hours Required
clockHoursScheduled	number <double> The total number of credits or hours that are in a scheduled or current status at the time of enrollment.
coreCreditHoursAttempted	number <double> Core Credit Hours Attempted
coreCreditHoursEarned	number <double> Core Credit Hours Earned
coreGpa	number <double> Core Gpa
coreNumericAvg	number <double> Core Numeric Avg
createdDateTime	string <date-time> The date when the item or person was added or the status change was entered.
creditHoursAttempted	number <double> Credit Hours Attempted
creditHoursEarned	number <double> The number of credits earned by the student to date.
creditHoursRequired	number <double> The number of credits or hours required for the course or enrollment.
creditHoursScheduled	number <double> Credit Hours Scheduled
cumGpaPoints	number <double> Cum Gpa Points
daysAbsent	number <double> The number of complete days that the student was absent from the campus or institution.
degreeAudit	string Degree Audit
dropDate	string <date-time> The date when the student dropped the enrollment.
dropEarn	number <double> Drop Earn
dropType	string Drop Type
enrollmentDate	string <date-time> The date that the student enrolled at the institution.
enrollmentNumber	string The number assigned during the enrollment based on the parameters specified by the institution.
enrollmentStatusId	number <int32> The enrollment status included in the student's Enrollment record. For example, Full Time.
expectedCreditsHoursPerTerm	number <double> The total number of credits the student is expected to complete per term.
expectedHoursPerWeekForExternship	number <double> The number of hours per week that the student is expected to complete in the training or externship. The number of hours specified must be less than the Total Hours for Externship.
expectedRefundProcessDate	string <date-time> The date when the refund was processed.
expectedStartDate	string <date-time> The expected start date for the student at your institution.
externshipBeginDate	string <date-time> The start date of the training or externship.
faEntranceInterviewDate	string <date-time> The date of the financial aid interview. If the field contains a value, the source of this date depends on your institution. The date can be the date from the Direct Loan Entrance Counseling (CRECMYOP) or Direct Loan Plus Application Acknowledgment (CRSPyyOP) files imported from COD. If you institution has configured an entrance interview document, the date from the document can be used when the document has an approved and on file status. You can also manually specify the date.
faExitInterviewDate	string <date-time> The date when the Financial Aid Exit Interview was conducted with the student.
financialAidCredits	number <double> Financial Aid Credits
gpa	number <double> The overall GPA for the current enrollment the student is registered for.
gpaCreditHours	number <double> Gpa Credit Hours
gradeLevelId	number <int32> The grade level for the student. Grade levels are configured by your institution and do not have to correspond to the option on the FAFSA or Stafford Loan forms. For a student to qualify for a Graduate PLUS loan, the grade level must be configured with the Department of Education ID 7 (Graduate/Professional or beyond).
gradeScaleId	number <int32> The grading parameters used by your institution uses to evaluate the academic achievements of the students.
graduationDate	string <date-time> The date that student graduated from the program.
ipedsState	string The state included in the permanent address submitted by the student at the time of application.
isApplicant	boolean Is Applicant
isAttendanceArchived	boolean Is Attendance Archived
isIpedsTransfer	boolean The check box is selected only if the student has transfer credits with a transfer type set to "Include as Transfer Student (for IPEDS reporting).
isReenrollment	object Is Reenrollment
isTransfer	boolean Is Transfer
isUiUpdate	boolean Is Ui Update
lastActivityDate	string <date-time> Last Activity Date
lastModifiedDateTime	string <date-time> The date that the item was updated or changed.
lastModifiedUserId	number <int32> The last and then first name of the person that changed the item.
lda	string <date-time> The day the student last attended a class in this program version.
linkedSapStudentEnrollmentPeriodId	number <int32> The program version description of the linked SAP enrollment.
midpointDate	string <date-time> The estimated midpoint date for students who enter the program version based on the program version start date.
minutesAbsent	number <int32> Minutes Absent
minutesAttended	number <double> Minutes Attended
minutesMakeUp	number <int32> The number of makeup hours accumulated by the student.
note	string Note
nsldsWithdrawalDate	string <date-time> The effective date, stored in SSCR and Clearinghouse records, when a student withdrew from the institution.
numericAverage	number <double> The current numeric average of class sections graded for the specified student. If the institution does not use numeric grading, this value will be zero.
originalAssignedAdmissionsRepId	number <int32> The last and then first name of the admissions representative initially assigned to the student.
originalExpectedStartDate	string <date-time> The date when the student was expected to start the enrollment. The date is determined at the time of the student's first enrollment and cannot be edited.
originalGraduationDate	string <date-time> The original expected graduation date at the time of enrollment. This date cannot be edited.
outsideCourseWorkHours	number <double> Outside Course Work Hours
previousEducationId	number <int32> The previous education history of the student.
previousGradDate	string <date-time> Previous Grad Date
programId	number <int32> The name of the program. Programs are configured by your institution.
programVersionId	number <int32> The version of the program. Program versions are configured by your institution to distinguish between variations of a program.
programVersionName	string Program Version Name
recalculateTermSequence	boolean Recalculate Term Sequence
reenrollDate	string <date-time> The date when the student reentered the program version.
reentryAfter180Date	string <date-time> Reentry After180Date
rightsResponsibilitiesAck	boolean The acknowledgement of rigths and responsibilities. If you import the DECFyyOP file that contains entrance counsleing results, the check box is selected or not selected based on the setting for the student in the file.
rowVersion	string
sapCheckpoint	object Sap Checkpoint
sapFlag	string Sap Flag
sapStatusId	number <int32> The student's academic progress.
schoolStatusChangeDate	string <date-time> The date that the student status was last changed.
schoolStatusChangeReasonId	number <int32> Reasons why students change from student status to another student status. The reasons are configured by your institution.
schoolStatusId	number <int32> Specifies the status of the prospect or student at your institution. Statuses vary by institution. They are configured by your institution. If you change the status for a student, a dialog is displayed so that you can confirm the change. If there are also tasks associated with the previous status, CampusNexus Student displays a dialog that you can use to select the tasks to keep and the tasks to close with the result of canceled.
shiftId	number <int32> The shift that the student will attend classes (such as day or evenings). They are configured by your institution.
speProgression	number <double> Spe Progression
startDateId	number <int32> Start Date Id
startTermId	number <int32> The Code, Name, and dates (start and end dates) for available terms.
statusChangeType	number <int32> Status Change Type
studentId	number <int32> Student Id
transcriptIssued	string <date-time> Transcript Issued
transferCreditHours	number <double> Number of clock hours to transfer.
transferInDate	string <date-time> The date when the student was transferred out of the program version.
	object (cmc-nexus-common-entities-studentEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"statusColor": "string",
"systemStatusCategory": "string",
"registeredCreditHours": 0,
"registeredClockHours": 0,
"nsldsStatusName": "string",
"isLastStatusTransfer": true,
"isTermAggregateRegisteredCredits": true,
"previousTransferStudentEnrollmentPeriodId": 0,
"previousSchoolStatusId": 0,
"studentAdvisorList": [{"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"academicAdvisor": {"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"isBatchCatalogAssignment": true,
"isUpdateStudentEnrollmentPeriod": true,
"message": "string",
"isDocumentDelete": true,
"id": 0,
"academicAdvisorId": 0,
"accountReceivableBalance": 0,
"actualStartDate": "2019-08-24T14:15:22Z",
"admissionsRegionId": 0,
"agencyBranchId": 0,
"aosTransferDate": "2019-08-24T14:15:22Z",
"applicantProgress": 0,
"applicantTypeId": 0,
"applicationReceivedDate": "2019-08-24T14:15:22Z",
"assignedAdmissionsRepId": 0,
"autoChargesTermId": 0,
"billedDate": "2019-08-24T14:15:22Z",
"billingMethodId": 0,
"campusId": 0,
"catalogYearId": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"clockHoursRequired": 0,
"clockHoursScheduled": 0,
"coreCreditHoursAttempted": 0,
"coreCreditHoursEarned": 0,
"coreGpa": 0,
"coreNumericAvg": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"creditHoursRequired": 0,
"creditHoursScheduled": 0,
"cumGpaPoints": 0,
"daysAbsent": 0,
"degreeAudit": "string",
"dropDate": "2019-08-24T14:15:22Z",
"dropEarn": 0,
"dropType": "string",
"enrollmentDate": "2019-08-24T14:15:22Z",
"enrollmentNumber": "string",
"enrollmentStatusId": 0,
"expectedCreditsHoursPerTerm": 0,
"expectedHoursPerWeekForExternship": 0,
"expectedRefundProcessDate": "2019-08-24T14:15:22Z",
"expectedStartDate": "2019-08-24T14:15:22Z",
"externshipBeginDate": "2019-08-24T14:15:22Z",
"faEntranceInterviewDate": "2019-08-24T14:15:22Z",
"faExitInterviewDate": "2019-08-24T14:15:22Z",
"financialAidCredits": 0,
"gpa": 0,
"gpaCreditHours": 0,
"gradeLevelId": 0,
"gradeScaleId": 0,
"graduationDate": "2019-08-24T14:15:22Z",
"ipedsState": "string",
"isApplicant": true,
"isAttendanceArchived": true,
"isIpedsTransfer": true,
"isReenrollment": { },
"isTransfer": true,
"isUiUpdate": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"linkedSapStudentEnrollmentPeriodId": 0,
"midpointDate": "2019-08-24T14:15:22Z",
"minutesAbsent": 0,
"minutesAttended": 0,
"minutesMakeUp": 0,
"note": "string",
"nsldsWithdrawalDate": "2019-08-24T14:15:22Z",
"numericAverage": 0,
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalGraduationDate": "2019-08-24T14:15:22Z",
"outsideCourseWorkHours": 0,
"previousEducationId": 0,
"previousGradDate": "2019-08-24T14:15:22Z",
"programId": 0,
"programVersionId": 0,
"programVersionName": "string",
"recalculateTermSequence": true,
"reenrollDate": "2019-08-24T14:15:22Z",
"reentryAfter180Date": "2019-08-24T14:15:22Z",
"rightsResponsibilitiesAck": true,
"rowVersion": "string",
"sapCheckpoint": { },
"sapFlag": "string",
"sapStatusId": 0,
"schoolStatusChangeDate": "2019-08-24T14:15:22Z",
"schoolStatusChangeReasonId": 0,
"schoolStatusId": 0,
"shiftId": 0,
"speProgression": 0,
"startDateId": 0,
"startTermId": 0,
"statusChangeType": 0,
"studentId": 0,
"transcriptIssued": "2019-08-24T14:15:22Z",
"transferCreditHours": 0,
"transferInDate": "2019-08-24T14:15:22Z",
"student": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"statusColor": "string",
"systemStatusCategory": "string",
"registeredCreditHours": 0,
"registeredClockHours": 0,
"nsldsStatusName": "string",
"isLastStatusTransfer": true,
"isTermAggregateRegisteredCredits": true,
"previousTransferStudentEnrollmentPeriodId": 0,
"previousSchoolStatusId": 0,
"studentAdvisorList": [{"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"academicAdvisor": {"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"isBatchCatalogAssignment": true,
"isUpdateStudentEnrollmentPeriod": true,
"message": "string",
"isDocumentDelete": true,
"id": 0,
"academicAdvisorId": 0,
"accountReceivableBalance": 0,
"actualStartDate": "2019-08-24T14:15:22Z",
"admissionsRegionId": 0,
"agencyBranchId": 0,
"aosTransferDate": "2019-08-24T14:15:22Z",
"applicantProgress": 0,
"applicantTypeId": 0,
"applicationReceivedDate": "2019-08-24T14:15:22Z",
"assignedAdmissionsRepId": 0,
"autoChargesTermId": 0,
"billedDate": "2019-08-24T14:15:22Z",
"billingMethodId": 0,
"campusId": 0,
"catalogYearId": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"clockHoursRequired": 0,
"clockHoursScheduled": 0,
"coreCreditHoursAttempted": 0,
"coreCreditHoursEarned": 0,
"coreGpa": 0,
"coreNumericAvg": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"creditHoursRequired": 0,
"creditHoursScheduled": 0,
"cumGpaPoints": 0,
"daysAbsent": 0,
"degreeAudit": "string",
"dropDate": "2019-08-24T14:15:22Z",
"dropEarn": 0,
"dropType": "string",
"enrollmentDate": "2019-08-24T14:15:22Z",
"enrollmentNumber": "string",
"enrollmentStatusId": 0,
"expectedCreditsHoursPerTerm": 0,
"expectedHoursPerWeekForExternship": 0,
"expectedRefundProcessDate": "2019-08-24T14:15:22Z",
"expectedStartDate": "2019-08-24T14:15:22Z",
"externshipBeginDate": "2019-08-24T14:15:22Z",
"faEntranceInterviewDate": "2019-08-24T14:15:22Z",
"faExitInterviewDate": "2019-08-24T14:15:22Z",
"financialAidCredits": 0,
"gpa": 0,
"gpaCreditHours": 0,
"gradeLevelId": 0,
"gradeScaleId": 0,
"graduationDate": "2019-08-24T14:15:22Z",
"ipedsState": "string",
"isApplicant": true,
"isAttendanceArchived": true,
"isIpedsTransfer": true,
"isReenrollment": { },
"isTransfer": true,
"isUiUpdate": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"linkedSapStudentEnrollmentPeriodId": 0,
"midpointDate": "2019-08-24T14:15:22Z",
"minutesAbsent": 0,
"minutesAttended": 0,
"minutesMakeUp": 0,
"note": "string",
"nsldsWithdrawalDate": "2019-08-24T14:15:22Z",
"numericAverage": 0,
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalGraduationDate": "2019-08-24T14:15:22Z",
"outsideCourseWorkHours": 0,
"previousEducationId": 0,
"previousGradDate": "2019-08-24T14:15:22Z",
"programId": 0,
"programVersionId": 0,
"programVersionName": "string",
"recalculateTermSequence": true,
"reenrollDate": "2019-08-24T14:15:22Z",
"reentryAfter180Date": "2019-08-24T14:15:22Z",
"rightsResponsibilitiesAck": true,
"rowVersion": "string",
"sapCheckpoint": { },
"sapFlag": "string",
"sapStatusId": 0,
"schoolStatusChangeDate": "2019-08-24T14:15:22Z",
"schoolStatusChangeReasonId": 0,
"schoolStatusId": 0,
"shiftId": 0,
"speProgression": 0,
"startDateId": 0,
"startTermId": 0,
"statusChangeType": 0,
"studentId": 0,
"transcriptIssued": "2019-08-24T14:15:22Z",
"transferCreditHours": 0,
"transferInDate": "2019-08-24T14:15:22Z",
"student": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Update Catalog Year For Student For Batch Catalog Assignment

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentperiod-updatecatalogyearforstudentforbatchcatalogassignment-request-payload)

fromCatalogYearId	number <int32>
toCatalogYearId	number <int32>
programVersionId	number <int32>
	Array of objects (cmc-nexus-academics-services-batchCatalogAssignmentStudentDetailList)
userId	number <int32>
catalogYearId	number <int32>
enrollId	number <int32>
studentId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"fromCatalogYearId": 0,
"toCatalogYearId": 0,
"programVersionId": 0,
"batchCatalogAssignmentStudentDetailList": [{"studentId": 0,
"studentName": "string",
"studentNumber": "string",
"studentEnrollmentPeriodId": 0
}
],
"userId": 0,
"catalogYearId": 0,
"enrollId": 0,
"studentId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"processedStudentReasonList": [{"studentId": 0,
"studentName": "string",
"reason": "string",
"programVersionId": 0,
"programVersion": "string",
"fromCatalogYear": "string",
"toCatalogYear": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Update Student Enrollment Area Of Study

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentperiod-updatestudentenrollmentareaofstudy-request-payload)

enrollId	number <int32>
campusId	number <int32>
programVersionId	number <int32>
schoolStartDateId	number <int32>
filterTypes	Array of numbers <int32> [ items <int32 > ]
catalogYearId	number <int32>
isUpdateAreaOfStudy	boolean
	Array of objects (cmc-nexus-academics-services-savedProgramVersionAreaOfStudyConfigList)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"enrollId": 0,
"campusId": 0,
"programVersionId": 0,
"schoolStartDateId": 0,
"filterTypes": [0
],
"catalogYearId": 0,
"isUpdateAreaOfStudy": true,
"programVersionAreaOfStudyConfigList": [{"pkId": 0,
"adConcentrationId": 0,
"code": "string",
"descrip": "string",
"adMajorId": 0,
"adMajorCode": "string",
"selListId": 0,
"typeId": 0,
"typeCode": "string",
"typeDescrip": "string",
"mode": 0,
"adProgramVersionId": 0,
"adCatalogYearId": 0,
"effectiveDate": "2019-08-24T14:15:22Z"
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isDataSaved": true,
"xmlResponse": "string",
"programVersionAreaOfStudyConfigList": [{"pkId": 0,
"adConcentrationId": 0,
"code": "string",
"descrip": "string",
"adMajorId": 0,
"adMajorCode": "string",
"selListId": 0,
"typeId": 0,
"typeCode": "string",
"typeDescrip": "string",
"mode": 0,
"adProgramVersionId": 0,
"adCatalogYearId": 0,
"effectiveDate": "2019-08-24T14:15:22Z"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Update Student Enrollment Billing Method

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentperiod-updatestudentenrollmentbillingmethod-request-payload)

campusId	number <int32>
programVersionStartDate	string <date-time>
programVersionEndDate	string <date-time>
	Array of objects (cmc-nexus-academics-services-updateEnrollmentBillingMethodRequest_StudentEnrollmentPeriodBillingMethod)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusId": 0,
"programVersionStartDate": "2019-08-24T14:15:22Z",
"programVersionEndDate": "2019-08-24T14:15:22Z",
"studentEnrollmentPeriodBillingMethodList": [{"studentEnrollmentPeriodID": 0,
"billingMethodId": 0,
"previousBillingMethodId": 0
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Update Student Enrollment Make Up Hours

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentperiod-updatestudentenrollmentmakeuphours-request-payload)

studentCourseId	number <int32>
attendId	number <int32>
classSectionId	number <int32>
hours	number <int32>
minutes	number <int32>
attendanceDate	string <date-time>
note	string
type	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentCourseId": 0,
"attendId": 0,
"classSectionId": 0,
"hours": 0,
"minutes": 0,
"attendanceDate": "2019-08-24T14:15:22Z",
"note": "string",
"type": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Update Student Enrollment Period

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-studentenrollmentperiod-updatestudentenrollmentperiod-request-payload)

isDegreeProgramType	boolean
isChangeDateApplicable	boolean
isReEntryApplicable	boolean
	Array of objects (cmc-nexus-academics-services-savedProgramVersionAreaOfStudyConfigList)
isOverriddeEnrollmentStatusCategory	boolean
isBudgetApplicable	boolean
isBillMethodChange	boolean
loaStart	string <date-time>
loaReturn	string <date-time>
isCatalogYearChanged	boolean
isGraduationDateChanged	boolean
previousGraduationDate	string <date-time>
loaPreviousSchoolStatusId	number <int32>
previousProgramVersionId	number <int32>
previousSchoolStatusId	number <int32>
previousSystemSchoolStatusId	number <int32>
faaNotificationStaffId	number <int32>
faaNotificationMessage	string
previousBillingMethodId	number <int32>
previousStudentEnrollmentPeriodId	number <int32>
	object (cmc-nexus-academics-entities-studentEnrollmentPeriodEntity)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isDegreeProgramType": true,
"isChangeDateApplicable": true,
"isReEntryApplicable": true,
"programVersionAreaOfStudyConfigList": [{"pkId": 0,
"adConcentrationId": 0,
"code": "string",
"descrip": "string",
"adMajorId": 0,
"adMajorCode": "string",
"selListId": 0,
"typeId": 0,
"typeCode": "string",
"typeDescrip": "string",
"mode": 0,
"adProgramVersionId": 0,
"adCatalogYearId": 0,
"effectiveDate": "2019-08-24T14:15:22Z"
}
],
"isOverriddeEnrollmentStatusCategory": true,
"isBudgetApplicable": true,
"isBillMethodChange": true,
"loaStart": "2019-08-24T14:15:22Z",
"loaReturn": "2019-08-24T14:15:22Z",
"isCatalogYearChanged": true,
"isGraduationDateChanged": true,
"previousGraduationDate": "2019-08-24T14:15:22Z",
"loaPreviousSchoolStatusId": 0,
"previousProgramVersionId": 0,
"previousSchoolStatusId": 0,
"previousSystemSchoolStatusId": 0,
"faaNotificationStaffId": 0,
"faaNotificationMessage": "string",
"previousBillingMethodId": 0,
"previousStudentEnrollmentPeriodId": 0,
"entity": {"isExcludedCrmIntegration": true,
"statusColor": "string",
"systemStatusCategory": "string",
"registeredCreditHours": 0,
"registeredClockHours": 0,
"nsldsStatusName": "string",
"isLastStatusTransfer": true,
"isTermAggregateRegisteredCredits": true,
"previousTransferStudentEnrollmentPeriodId": 0,
"previousSchoolStatusId": 0,
"studentAdvisorList": [{"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"academicAdvisor": {"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"isBatchCatalogAssignment": true,
"isUpdateStudentEnrollmentPeriod": true,
"message": "string",
"isDocumentDelete": true,
"id": 0,
"academicAdvisorId": 0,
"accountReceivableBalance": 0,
"actualStartDate": "2019-08-24T14:15:22Z",
"admissionsRegionId": 0,
"agencyBranchId": 0,
"aosTransferDate": "2019-08-24T14:15:22Z",
"applicantProgress": 0,
"applicantTypeId": 0,
"applicationReceivedDate": "2019-08-24T14:15:22Z",
"assignedAdmissionsRepId": 0,
"autoChargesTermId": 0,
"billedDate": "2019-08-24T14:15:22Z",
"billingMethodId": 0,
"campusId": 0,
"catalogYearId": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"clockHoursRequired": 0,
"clockHoursScheduled": 0,
"coreCreditHoursAttempted": 0,
"coreCreditHoursEarned": 0,
"coreGpa": 0,
"coreNumericAvg": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"creditHoursRequired": 0,
"creditHoursScheduled": 0,
"cumGpaPoints": 0,
"daysAbsent": 0,
"degreeAudit": "string",
"dropDate": "2019-08-24T14:15:22Z",
"dropEarn": 0,
"dropType": "string",
"enrollmentDate": "2019-08-24T14:15:22Z",
"enrollmentNumber": "string",
"enrollmentStatusId": 0,
"expectedCreditsHoursPerTerm": 0,
"expectedHoursPerWeekForExternship": 0,
"expectedRefundProcessDate": "2019-08-24T14:15:22Z",
"expectedStartDate": "2019-08-24T14:15:22Z",
"externshipBeginDate": "2019-08-24T14:15:22Z",
"faEntranceInterviewDate": "2019-08-24T14:15:22Z",
"faExitInterviewDate": "2019-08-24T14:15:22Z",
"financialAidCredits": 0,
"gpa": 0,
"gpaCreditHours": 0,
"gradeLevelId": 0,
"gradeScaleId": 0,
"graduationDate": "2019-08-24T14:15:22Z",
"ipedsState": "string",
"isApplicant": true,
"isAttendanceArchived": true,
"isIpedsTransfer": true,
"isReenrollment": { },
"isTransfer": true,
"isUiUpdate": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"linkedSapStudentEnrollmentPeriodId": 0,
"midpointDate": "2019-08-24T14:15:22Z",
"minutesAbsent": 0,
"minutesAttended": 0,
"minutesMakeUp": 0,
"note": "string",
"nsldsWithdrawalDate": "2019-08-24T14:15:22Z",
"numericAverage": 0,
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalGraduationDate": "2019-08-24T14:15:22Z",
"outsideCourseWorkHours": 0,
"previousEducationId": 0,
"previousGradDate": "2019-08-24T14:15:22Z",
"programId": 0,
"programVersionId": 0,
"programVersionName": "string",
"recalculateTermSequence": true,
"reenrollDate": "2019-08-24T14:15:22Z",
"reentryAfter180Date": "2019-08-24T14:15:22Z",
"rightsResponsibilitiesAck": true,
"rowVersion": "string",
"sapCheckpoint": { },
"sapFlag": "string",
"sapStatusId": 0,
"schoolStatusChangeDate": "2019-08-24T14:15:22Z",
"schoolStatusChangeReasonId": 0,
"schoolStatusId": 0,
"shiftId": 0,
"speProgression": 0,
"startDateId": 0,
"startTermId": 0,
"statusChangeType": 0,
"studentId": 0,
"transcriptIssued": "2019-08-24T14:15:22Z",
"transferCreditHours": 0,
"transferInDate": "2019-08-24T14:15:22Z",
"student": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}
}

Response samples

Content type

application/json

{"payload": {"data": {"entity": {"isExcludedCrmIntegration": true,
"statusColor": "string",
"systemStatusCategory": "string",
"registeredCreditHours": 0,
"registeredClockHours": 0,
"nsldsStatusName": "string",
"isLastStatusTransfer": true,
"isTermAggregateRegisteredCredits": true,
"previousTransferStudentEnrollmentPeriodId": 0,
"previousSchoolStatusId": 0,
"studentAdvisorList": [{"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"academicAdvisor": {"id": 0,
"studentId": 0,
"staffGroupId": 0,
"studentEnrollmentPeriodId": 0,
"advisorModule": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"staffId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"isBatchCatalogAssignment": true,
"isUpdateStudentEnrollmentPeriod": true,
"message": "string",
"isDocumentDelete": true,
"id": 0,
"academicAdvisorId": 0,
"accountReceivableBalance": 0,
"actualStartDate": "2019-08-24T14:15:22Z",
"admissionsRegionId": 0,
"agencyBranchId": 0,
"aosTransferDate": "2019-08-24T14:15:22Z",
"applicantProgress": 0,
"applicantTypeId": 0,
"applicationReceivedDate": "2019-08-24T14:15:22Z",
"assignedAdmissionsRepId": 0,
"autoChargesTermId": 0,
"billedDate": "2019-08-24T14:15:22Z",
"billingMethodId": 0,
"campusId": 0,
"catalogYearId": 0,
"clockHoursAttempted": 0,
"clockHoursEarned": 0,
"clockHoursRequired": 0,
"clockHoursScheduled": 0,
"coreCreditHoursAttempted": 0,
"coreCreditHoursEarned": 0,
"coreGpa": 0,
"coreNumericAvg": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditHoursAttempted": 0,
"creditHoursEarned": 0,
"creditHoursRequired": 0,
"creditHoursScheduled": 0,
"cumGpaPoints": 0,
"daysAbsent": 0,
"degreeAudit": "string",
"dropDate": "2019-08-24T14:15:22Z",
"dropEarn": 0,
"dropType": "string",
"enrollmentDate": "2019-08-24T14:15:22Z",
"enrollmentNumber": "string",
"enrollmentStatusId": 0,
"expectedCreditsHoursPerTerm": 0,
"expectedHoursPerWeekForExternship": 0,
"expectedRefundProcessDate": "2019-08-24T14:15:22Z",
"expectedStartDate": "2019-08-24T14:15:22Z",
"externshipBeginDate": "2019-08-24T14:15:22Z",
"faEntranceInterviewDate": "2019-08-24T14:15:22Z",
"faExitInterviewDate": "2019-08-24T14:15:22Z",
"financialAidCredits": 0,
"gpa": 0,
"gpaCreditHours": 0,
"gradeLevelId": 0,
"gradeScaleId": 0,
"graduationDate": "2019-08-24T14:15:22Z",
"ipedsState": "string",
"isApplicant": true,
"isAttendanceArchived": true,
"isIpedsTransfer": true,
"isReenrollment": { },
"isTransfer": true,
"isUiUpdate": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lda": "2019-08-24T14:15:22Z",
"linkedSapStudentEnrollmentPeriodId": 0,
"midpointDate": "2019-08-24T14:15:22Z",
"minutesAbsent": 0,
"minutesAttended": 0,
"minutesMakeUp": 0,
"note": "string",
"nsldsWithdrawalDate": "2019-08-24T14:15:22Z",
"numericAverage": 0,
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalGraduationDate": "2019-08-24T14:15:22Z",
"outsideCourseWorkHours": 0,
"previousEducationId": 0,
"previousGradDate": "2019-08-24T14:15:22Z",
"programId": 0,
"programVersionId": 0,
"programVersionName": "string",
"recalculateTermSequence": true,
"reenrollDate": "2019-08-24T14:15:22Z",
"reentryAfter180Date": "2019-08-24T14:15:22Z",
"rightsResponsibilitiesAck": true,
"rowVersion": "string",
"sapCheckpoint": { },
"sapFlag": "string",
"sapStatusId": 0,
"schoolStatusChangeDate": "2019-08-24T14:15:22Z",
"schoolStatusChangeReasonId": 0,
"schoolStatusId": 0,
"shiftId": 0,
"speProgression": 0,
"startDateId": 0,
"startTermId": 0,
"statusChangeType": 0,
"studentId": 0,
"transcriptIssued": "2019-08-24T14:15:22Z",
"transferCreditHours": 0,
"transferInDate": "2019-08-24T14:15:22Z",
"student": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Student

Change Student Status On Close Task

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (common-student-changestudentstatusonclosetask-request-payload)

taskId	number <int32>
studentId	number <int32>
schoolStatusId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"taskId": 0,
"studentId": 0,
"schoolStatusId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentId": 0,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Check Duplicate Campus Student

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (common-student-checkduplicatecampusstudent-request-payload)

isDupNamePhoneCheckRequired	boolean
firstName	string
lastName	string
phone	string
workPhone	string
eMail	string
postalCode	string
highSchoolGraduationYear	string
sSN	string
leadSourceId	string
admissionsOfficerId	string
city	string
stateId	string
countryId	string
workPhoneExtension	string
birthDate	string
driversLicenseNumber	string
driversLicenseStateId	string
expectedStartDate	string
otherEmail	string
otherPhone	string
middleName	string
schoolStatusId	string
genderId	string
locationId	string
leadTypeId	string
address	string
countyId	string
programId	string
agencyId	string
leadDate	string
highSchoolGradDate	string
alienRegistrationNumber	string
bestTimeToContact	string
citizenshipId	string
collegeId	string
comments	string
currentEmployerId	string
hasDisability	string
isVeteran	string
employmentStatusId	string
extraCurricularId	string
nickName	string
previousEducationId	string
highSchoolDateEnrolled	string
highSchoolGraduate	string
highSchoolGraduationSession	string
highSchoolLastDateAttended	string
highSchoolSize	string
highSchoolStudentLevel	string
highSchoolStudentRank	string
highSchoolTranscriptType	string
maidenName	string
maritalStatusId	string
nationalityId	string
raceId	string
titleId	string
suffixId	string
shiftId	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isDupNamePhoneCheckRequired": true,
"firstName": "string",
"lastName": "string",
"phone": "string",
"workPhone": "string",
"eMail": "string",
"postalCode": "string",
"highSchoolGraduationYear": "string",
"sSN": "string",
"leadSourceId": "string",
"admissionsOfficerId": "string",
"city": "string",
"stateId": "string",
"countryId": "string",
"workPhoneExtension": "string",
"birthDate": "string",
"driversLicenseNumber": "string",
"driversLicenseStateId": "string",
"expectedStartDate": "string",
"otherEmail": "string",
"otherPhone": "string",
"middleName": "string",
"schoolStatusId": "string",
"genderId": "string",
"locationId": "string",
"leadTypeId": "string",
"address": "string",
"countyId": "string",
"programId": "string",
"agencyId": "string",
"leadDate": "string",
"highSchoolGradDate": "string",
"alienRegistrationNumber": "string",
"bestTimeToContact": "string",
"citizenshipId": "string",
"collegeId": "string",
"comments": "string",
"currentEmployerId": "string",
"hasDisability": "string",
"isVeteran": "string",
"employmentStatusId": "string",
"extraCurricularId": "string",
"nickName": "string",
"previousEducationId": "string",
"highSchoolDateEnrolled": "string",
"highSchoolGraduate": "string",
"highSchoolGraduationSession": "string",
"highSchoolLastDateAttended": "string",
"highSchoolSize": "string",
"highSchoolStudentLevel": "string",
"highSchoolStudentRank": "string",
"highSchoolTranscriptType": "string",
"maidenName": "string",
"maritalStatusId": "string",
"nationalityId": "string",
"raceId": "string",
"titleId": "string",
"suffixId": "string",
"shiftId": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"students": [{"syStudentId": 0,
"syCampusId": 0,
"sySchoolStatusId": 0,
"amLeadSrcId": 0,
"amLeadTypeId": 0,
"amRepId": 0,
"admRepDescrp": "string",
"firstName": "string",
"lastName": "string",
"mI": "string",
"sSN": "string",
"city": "string",
"state": "string",
"zip": "string",
"phone": "string",
"dOB": "2019-08-24T14:15:22Z",
"drivLic": "string",
"email": "string",
"addr1": "string",
"workPhone": "string",
"campusName": "string",
"leadDate": "2019-08-24T14:15:22Z",
"lastContactDate": "2019-08-24T14:15:22Z"
}
],
"itemsAffected": 0,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Create Student

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Student

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (common-student-delete-request-payload)

isExcludedCrmIntegration	boolean
addressTypeId	number <int32>
studentInquiryRequired	boolean
extraCurricularsList	Array of numbers <int32> [ items <int32 > ]
programsList	Array of numbers <int32> [ items <int32 > ]
enrolledProgramIdList	Array of numbers <int32> [ items <int32 > ]
ethnicitiesList	Array of numbers <int32> [ items <int32 > ]
leadSourcesList	Array of numbers <int32> [ items <int32 > ]
deleteVeteranDetails	boolean
	Array of objects (cmc-nexus-common-entities-vendor)
studentAddressAssociation	number <int32>
newAssignedAdmissionsRepId	number <int32>
assignedAdmissionsRepReassignedDate	string <date-time>
	object (cmc-nexus-common-entities-studentRelationshipAddressEntity)
lastFourSsn	string Last Four Ssn
customProperties	Array of strings
multiValueCustomProperties	Array of strings
originalCustomProperties	Array of strings
originalMultiValueCustomProperties	Array of strings
originalCustomPropertiesValues	string <byte>
originalMultiValueCustomPropertiesValues	string <byte>
genderPronounList	Array of numbers <int32> [ items <int32 > ]
overridePrevEducAltPellValidation	boolean
id	number <int32> Id
acgEligReasonCode	string Acg Elig Reason Code
agencyId	number <int32> Agency Id
alienNumber	string If the student is not a U.S. citizen, the alien registration number for the student.
arAccountStatus	string Ar Account Status
arBalance	number <double> Ar Balance
arNextTransactionNumber	object Ar Next Transaction Number
assignedAdmissionsRepId	number <int32> Assigned Admissions Rep Id
athleticIdentifier	string Athletic Identifier
bestTimeToContact	string Best Time To Contact
campusId	number <int32> The campus for the student. The list only contains campuses you are associated with. You can only change the campus if the student is a prospect. Otherwise, the campus is specified during enrollment and the field is display only.
citizenId	number <int32> The citizenship status for the student. The citizenship status is used to determine whether or not a student is eligible for financial aid.
city	string The name of the city.
collegeId	number <int32> College Id
countryId	number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country.
countyId	number <int32> The county for the address.
createdDateTime	string <date-time> The date when the item or person was added or the status change was entered.
cumulativeGpa	number <double> Cumulative Gpa
cumulativeGpaPoints	number <double> Cumulative Gpa Points
currencyCodeId	number <int32> Currency Code Id
currentLda	string <date-time> Current Lda
dataBlockIndicator	boolean When it is not selected, indicates that the student has chosen to block the release of their directory information under the he Family Educational Rights and Privacy Act (FERPA) at the Clearinghouse from distribution to other servicers. This indicator, along with the other data, is sent to the Clearinghouse. When selected, the student has chosen to share directory information. The type of information that can be shared is determined by your institution and you can specify the type of information on their FERPA page. The field is disabled by default and is only enabled if your campus is using the Clearinghouse for sending IPEDS data to the Department of Education.
dateOfBirth	string <date-time> Specifies the date of birth (DOB) in the format MM/DD/YYYY.
dbiModifiedDate	string <date-time> Dbi Modified Date
defaultAddressCode	string Default Address Code
defaultMasterStudentAddressId	number <int32> Default Master Student Address Id
defaultStudentAddressId	number <int32> Default Student Address Id
disabled	string Disability status of the student. When you are adding the Student Profile, Unspecified is the default.
driverLicenseNumber	string The driver's license number for the student.
driverLicenseState	string The state where the driver's license for the student was issued.
emailAddress	string The email address.
employabilityAboutInfo	string Employability About Info
employerId	number <int32> Employer Id
employmentStatusId	number <int32> Employment Status Id
externalStudentIdentifier	string External Student Identifier
extraCurricularActivityId	number <int32> Extra Curricular Activity Id
facebookUrl	string Facebook Url
faGradPlusCounselingDate	string <date-time> Fa Grad Plus Counseling Date
faRigorousHighSchoolProgramCodeId	number <int32> Fa Rigorous High School Program Code Id
firstName	string The first name of the student or person.
genderId	number <int32> The gender of the student or person. The values that can be selected are configured by your institution.
gpaCredits	number <double> Gpa Credits
hispanicLatino	string Indicates whether a student is of Spanish or Latin American descent.
hsAcademicGpa	number <double> Hs Academic Gpa
instagramUrl	string Instagram Url
isActive	boolean Specifies whether or not the associated record is active.
isAllowedBulkRegistrationByTrack	boolean Is Allowed Bulk Registration By Track
isBadAddress	boolean When selected, specifies that there are one more errors in the address for the student (such as the address is incomplete or mail has been returned).
isBadPhone	boolean When selected, specifies that there is an error in the phone number for the student.
isDdVeteran	boolean Is Dd Veteran
isEftDefaultForStipends	boolean Is Eft Default For Stipends
isInDistrict	boolean Is In District
isSscrError11Received	boolean Is Sscr Error11Received
lastActivityDate	string <date-time> Last Activity Date
lastInterestDate	string <date-time> Last Interest Date
lastModifiedDateTime	string <date-time> The date that the item was updated or changed.
lastModifiedUserId	number <int32> The last and then first name of the person that changed the item.
lastName	string The last name of the student or person.
lastNameFirstFour	string Last Name First Four
lastStatementBeginDate	string <date-time> Last Statement Begin Date
lastStatementCloseDate	string <date-time> Last Statement Close Date
lastStatementDate	string <date-time> Last Statement Date
leadDate	string <date-time> The date that the prospective student contacted the institution.
leadSourceId	number <int32> Lead Source Id
leadTypeId	number <int32> The type of prospect. The values are configured by your institution.
linkedInUrl	string Linked In Url
maidenName	string If any, the maiden name of the student or person.
maritalStatusId	number <int32> The marital status of the student. The values are configured by your institution.
mi	string Mi
middleName	string The middle name of the student or person.
mobilePhoneNumber	string Specifies the mobile phone number. A mobile number must be specified if the student wants to receive SMS text messages. It must also be specified if you select the Subscribe to SMS check box.
nationalityId	number <int32> If your institution enrolls international students, the nationality of the student. The values can be configured by your institution.
nickName	string If the student has a substitute for their proper name, the name.
niStudent	boolean Specifies whether or not a student is an international (non-immigrant) student. This field is disabled if your institution does not enroll international students. This field is required for Student and Exchange Visitor Information System (SEVIS) processing for the Immigration and Naturalization Service (INS).
note	string Area you can use to display or specify comments or additional information.
originalAssignedAdmissionsRepId	number <int32> Original Assigned Admissions Rep Id
originalExpectedStartDate	string <date-time> Original Student Expected Start Date
originalStartDate	string <date-time> Original Start Date
otherEmailAddress	string If the student has more than one email address, the secondary email address.
otherPhoneNumber	string If the student has a phone number where they can be contacted in addition to their mobile or work phone, the phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens).
personId	number <int32> Person Id
phoneNumber	string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens).
pin	number <double> The 4-digit personal identification number (PIN) selected by the student. The portal requires the student to enter his or her Student ID and PIN to log in. If you do not specify the PIN or change the social security number, the program defaults the PIN to the last four numbers of the social security number. If the last four characters begin with a zero, the PIN defaults to a 1 followed by the last 3 characters of the number. For example, if the last 4 digits of the social security number are 0398, the PIN is 1398.
postalCode	string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes.
postalCodeFirstThree	string Postal Code First Three
preferredContactType	string Preferred Contact Type
preferredName	string Preferred Name
previousEducationGpa	number <double> Previous Education Gpa
previousEducationId	number <int32> The highest level of previous education for the student. The previous education for the student. If selected in a report, the report contains the name of the institution, and the status (such as graduated). If the student graduated, it also shows the graduation date and year.
programGroupId	number <int32> Program Group Id
programId	number <int32> Program Id
rawFirstName	string Raw First Name
rawLastName	string Raw Last Name
rawPhoneNumber	string Raw Phone Number
rowVersion	string
schoolStatusId	number <int32> Specifies the status of the prospect or student at your institution. Statuses vary by institution. They are configured by your institution. If you change the status for a student, a dialog is displayed so that you can confirm the change. If there are also tasks associated with the previous status, CampusNexus Student displays a dialog that you can use to select the tasks to keep and the tasks to close with the result of canceled.
shiftId	number <int32> The shift that the student will attend classes (such as day or evenings). They are configured by your institution.
smsServiceProviderId	number <int32> Specifies the cell phone provider for the student. If you select the Subscribe to SMS check box, you must also specify a value for Mobile Phone Number and select a provider in the SMS Provider list for the student to receive the text messages.
sourceSystem	string Source System
ssn	string The social security number (SSN) associated with the student. You must be authorized to work with SSNs.
startDate	string <date-time> The expected start date for the student at your institution.
state	string If within the United States, the name of the state.
statementComment	string Statement Comment
streetAddress	string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, if an address has more than 40 characters, the additional characters in the address line will not be extracted to be sent to COD, but will be truncated.
streetAddress2	string Street Address2
studentFullName	string Student Full Name
studentIdentifier	string Student Identifier
studentNumber	string If your institution assigns student numbers, the number your institution uses to identify the student. How the number is assigned, is specified by your institution. For example, CampusNexus Student can be configured to assign the number or your institution can use some other method for assigning the ID.
subscribeToSms	boolean Specifies that the student wants to receive SMS text messages. If you select the check box, you must also specify a value for Mobile Phone Number and select a provider in the SMS Provider list for the student to receive the text messages. The student can also use the CampusNexus Portal.
suffix	string If the student or person's name has a suffix, the suffix. The suffix is required by SEVIS.
suffixId	number <int32> If the student or person's name has a suffix, the suffix. The suffix is required by SEVIS.
titleId	number <int32> The title for the student.
twitterUrl	string Twitter Url
veteran	string The veteran status of the student.
workPhoneNumber	string The work telephone number for the student. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). When a student is placed in a job using student placement, the program automatically updates the number with the phone number for the employer. If it applies, the extension is also updated.
workPhoneNumberExtension	string If needed, the extension for the work phone number.
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Alumni

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (common-student-deletealumni-request-payload)

isExcludedCrmIntegration	boolean
addressTypeId	number <int32>
studentInquiryRequired	boolean
extraCurricularsList	Array of numbers <int32> [ items <int32 > ]
programsList	Array of numbers <int32> [ items <int32 > ]
enrolledProgramIdList	Array of numbers <int32> [ items <int32 > ]
ethnicitiesList	Array of numbers <int32> [ items <int32 > ]
leadSourcesList	Array of numbers <int32> [ items <int32 > ]
deleteVeteranDetails	boolean
	Array of objects (cmc-nexus-common-entities-vendor)
studentAddressAssociation	number <int32>
newAssignedAdmissionsRepId	number <int32>
assignedAdmissionsRepReassignedDate	string <date-time>
	object (cmc-nexus-common-entities-studentRelationshipAddressEntity)
lastFourSsn	string Last Four Ssn
customProperties	Array of strings
multiValueCustomProperties	Array of strings
originalCustomProperties	Array of strings
originalMultiValueCustomProperties	Array of strings
originalCustomPropertiesValues	string <byte>
originalMultiValueCustomPropertiesValues	string <byte>
genderPronounList	Array of numbers <int32> [ items <int32 > ]
overridePrevEducAltPellValidation	boolean
id	number <int32> Id
acgEligReasonCode	string Acg Elig Reason Code
agencyId	number <int32> Agency Id
alienNumber	string If the student is not a U.S. citizen, the alien registration number for the student.
arAccountStatus	string Ar Account Status
arBalance	number <double> Ar Balance
arNextTransactionNumber	object Ar Next Transaction Number
assignedAdmissionsRepId	number <int32> Assigned Admissions Rep Id
athleticIdentifier	string Athletic Identifier
bestTimeToContact	string Best Time To Contact
campusId	number <int32> The campus for the student. The list only contains campuses you are associated with. You can only change the campus if the student is a prospect. Otherwise, the campus is specified during enrollment and the field is display only.
citizenId	number <int32> The citizenship status for the student. The citizenship status is used to determine whether or not a student is eligible for financial aid.
city	string The name of the city.
collegeId	number <int32> College Id
countryId	number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country.
countyId	number <int32> The county for the address.
createdDateTime	string <date-time> The date when the item or person was added or the status change was entered.
cumulativeGpa	number <double> Cumulative Gpa
cumulativeGpaPoints	number <double> Cumulative Gpa Points
currencyCodeId	number <int32> Currency Code Id
currentLda	string <date-time> Current Lda
dataBlockIndicator	boolean When it is not selected, indicates that the student has chosen to block the release of their directory information under the he Family Educational Rights and Privacy Act (FERPA) at the Clearinghouse from distribution to other servicers. This indicator, along with the other data, is sent to the Clearinghouse. When selected, the student has chosen to share directory information. The type of information that can be shared is determined by your institution and you can specify the type of information on their FERPA page. The field is disabled by default and is only enabled if your campus is using the Clearinghouse for sending IPEDS data to the Department of Education.
dateOfBirth	string <date-time> Specifies the date of birth (DOB) in the format MM/DD/YYYY.
dbiModifiedDate	string <date-time> Dbi Modified Date
defaultAddressCode	string Default Address Code
defaultMasterStudentAddressId	number <int32> Default Master Student Address Id
defaultStudentAddressId	number <int32> Default Student Address Id
disabled	string Disability status of the student. When you are adding the Student Profile, Unspecified is the default.
driverLicenseNumber	string The driver's license number for the student.
driverLicenseState	string The state where the driver's license for the student was issued.
emailAddress	string The email address.
employabilityAboutInfo	string Employability About Info
employerId	number <int32> Employer Id
employmentStatusId	number <int32> Employment Status Id
externalStudentIdentifier	string External Student Identifier
extraCurricularActivityId	number <int32> Extra Curricular Activity Id
facebookUrl	string Facebook Url
faGradPlusCounselingDate	string <date-time> Fa Grad Plus Counseling Date
faRigorousHighSchoolProgramCodeId	number <int32> Fa Rigorous High School Program Code Id
firstName	string The first name of the student or person.
genderId	number <int32> The gender of the student or person. The values that can be selected are configured by your institution.
gpaCredits	number <double> Gpa Credits
hispanicLatino	string Indicates whether a student is of Spanish or Latin American descent.
hsAcademicGpa	number <double> Hs Academic Gpa
instagramUrl	string Instagram Url
isActive	boolean Specifies whether or not the associated record is active.
isAllowedBulkRegistrationByTrack	boolean Is Allowed Bulk Registration By Track
isBadAddress	boolean When selected, specifies that there are one more errors in the address for the student (such as the address is incomplete or mail has been returned).
isBadPhone	boolean When selected, specifies that there is an error in the phone number for the student.
isDdVeteran	boolean Is Dd Veteran
isEftDefaultForStipends	boolean Is Eft Default For Stipends
isInDistrict	boolean Is In District
isSscrError11Received	boolean Is Sscr Error11Received
lastActivityDate	string <date-time> Last Activity Date
lastInterestDate	string <date-time> Last Interest Date
lastModifiedDateTime	string <date-time> The date that the item was updated or changed.
lastModifiedUserId	number <int32> The last and then first name of the person that changed the item.
lastName	string The last name of the student or person.
lastNameFirstFour	string Last Name First Four
lastStatementBeginDate	string <date-time> Last Statement Begin Date
lastStatementCloseDate	string <date-time> Last Statement Close Date
lastStatementDate	string <date-time> Last Statement Date
leadDate	string <date-time> The date that the prospective student contacted the institution.
leadSourceId	number <int32> Lead Source Id
leadTypeId	number <int32> The type of prospect. The values are configured by your institution.
linkedInUrl	string Linked In Url
maidenName	string If any, the maiden name of the student or person.
maritalStatusId	number <int32> The marital status of the student. The values are configured by your institution.
mi	string Mi
middleName	string The middle name of the student or person.
mobilePhoneNumber	string Specifies the mobile phone number. A mobile number must be specified if the student wants to receive SMS text messages. It must also be specified if you select the Subscribe to SMS check box.
nationalityId	number <int32> If your institution enrolls international students, the nationality of the student. The values can be configured by your institution.
nickName	string If the student has a substitute for their proper name, the name.
niStudent	boolean Specifies whether or not a student is an international (non-immigrant) student. This field is disabled if your institution does not enroll international students. This field is required for Student and Exchange Visitor Information System (SEVIS) processing for the Immigration and Naturalization Service (INS).
note	string Area you can use to display or specify comments or additional information.
originalAssignedAdmissionsRepId	number <int32> Original Assigned Admissions Rep Id
originalExpectedStartDate	string <date-time> Original Student Expected Start Date
originalStartDate	string <date-time> Original Start Date
otherEmailAddress	string If the student has more than one email address, the secondary email address.
otherPhoneNumber	string If the student has a phone number where they can be contacted in addition to their mobile or work phone, the phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens).
personId	number <int32> Person Id
phoneNumber	string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens).
pin	number <double> The 4-digit personal identification number (PIN) selected by the student. The portal requires the student to enter his or her Student ID and PIN to log in. If you do not specify the PIN or change the social security number, the program defaults the PIN to the last four numbers of the social security number. If the last four characters begin with a zero, the PIN defaults to a 1 followed by the last 3 characters of the number. For example, if the last 4 digits of the social security number are 0398, the PIN is 1398.
postalCode	string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes.
postalCodeFirstThree	string Postal Code First Three
preferredContactType	string Preferred Contact Type
preferredName	string Preferred Name
previousEducationGpa	number <double> Previous Education Gpa
previousEducationId	number <int32> The highest level of previous education for the student. The previous education for the student. If selected in a report, the report contains the name of the institution, and the status (such as graduated). If the student graduated, it also shows the graduation date and year.
programGroupId	number <int32> Program Group Id
programId	number <int32> Program Id
rawFirstName	string Raw First Name
rawLastName	string Raw Last Name
rawPhoneNumber	string Raw Phone Number
rowVersion	string
schoolStatusId	number <int32> Specifies the status of the prospect or student at your institution. Statuses vary by institution. They are configured by your institution. If you change the status for a student, a dialog is displayed so that you can confirm the change. If there are also tasks associated with the previous status, CampusNexus Student displays a dialog that you can use to select the tasks to keep and the tasks to close with the result of canceled.
shiftId	number <int32> The shift that the student will attend classes (such as day or evenings). They are configured by your institution.
smsServiceProviderId	number <int32> Specifies the cell phone provider for the student. If you select the Subscribe to SMS check box, you must also specify a value for Mobile Phone Number and select a provider in the SMS Provider list for the student to receive the text messages.
sourceSystem	string Source System
ssn	string The social security number (SSN) associated with the student. You must be authorized to work with SSNs.
startDate	string <date-time> The expected start date for the student at your institution.
state	string If within the United States, the name of the state.
statementComment	string Statement Comment
streetAddress	string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, if an address has more than 40 characters, the additional characters in the address line will not be extracted to be sent to COD, but will be truncated.
streetAddress2	string Street Address2
studentFullName	string Student Full Name
studentIdentifier	string Student Identifier
studentNumber	string If your institution assigns student numbers, the number your institution uses to identify the student. How the number is assigned, is specified by your institution. For example, CampusNexus Student can be configured to assign the number or your institution can use some other method for assigning the ID.
subscribeToSms	boolean Specifies that the student wants to receive SMS text messages. If you select the check box, you must also specify a value for Mobile Phone Number and select a provider in the SMS Provider list for the student to receive the text messages. The student can also use the CampusNexus Portal.
suffix	string If the student or person's name has a suffix, the suffix. The suffix is required by SEVIS.
suffixId	number <int32> If the student or person's name has a suffix, the suffix. The suffix is required by SEVIS.
titleId	number <int32> The title for the student.
twitterUrl	string Twitter Url
veteran	string The veteran status of the student.
workPhoneNumber	string The work telephone number for the student. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). When a student is placed in a job using student placement, the program automatically updates the number with the phone number for the employer. If it applies, the extension is also updated.
workPhoneNumberExtension	string If needed, the extension for the work phone number.
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Student

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (common-student-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Activity Statement Students

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (common-student-getactivitystatementstudents-request-payload)

campusId	number <int32>
lastModifiedUserId	number <int32>
lowStartDate	string
highStartDate	string
lowExpectedStartDate	string
highExpectedStartDate	string
lowGraduationDate	string
highGraduationDate	string
minimumAccountBalance	number <double>
accountBalanceAsOfDate	string
schoolStatusCodesIdList	Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusId": 0,
"lastModifiedUserId": 0,
"lowStartDate": "string",
"highStartDate": "string",
"lowExpectedStartDate": "string",
"highExpectedStartDate": "string",
"lowGraduationDate": "string",
"highGraduationDate": "string",
"minimumAccountBalance": 0,
"accountBalanceAsOfDate": "string",
"schoolStatusCodesIdList": [0
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentIdList": [0
],
"studentCount": 0,
"message": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Alumni

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (common-student-getalumni-request-payload)

isExcludedCrmIntegration	boolean
addressTypeId	number <int32>
studentInquiryRequired	boolean
extraCurricularsList	Array of numbers <int32> [ items <int32 > ]
programsList	Array of numbers <int32> [ items <int32 > ]
enrolledProgramIdList	Array of numbers <int32> [ items <int32 > ]
ethnicitiesList	Array of numbers <int32> [ items <int32 > ]
leadSourcesList	Array of numbers <int32> [ items <int32 > ]
deleteVeteranDetails	boolean
	Array of objects (cmc-nexus-common-entities-vendor)
studentAddressAssociation	number <int32>
newAssignedAdmissionsRepId	number <int32>
assignedAdmissionsRepReassignedDate	string <date-time>
	object (cmc-nexus-common-entities-studentRelationshipAddressEntity)
lastFourSsn	string Last Four Ssn
customProperties	Array of strings
multiValueCustomProperties	Array of strings
originalCustomProperties	Array of strings
originalMultiValueCustomProperties	Array of strings
originalCustomPropertiesValues	string <byte>
originalMultiValueCustomPropertiesValues	string <byte>
genderPronounList	Array of numbers <int32> [ items <int32 > ]
overridePrevEducAltPellValidation	boolean
id	number <int32> Id
acgEligReasonCode	string Acg Elig Reason Code
agencyId	number <int32> Agency Id
alienNumber	string If the student is not a U.S. citizen, the alien registration number for the student.
arAccountStatus	string Ar Account Status
arBalance	number <double> Ar Balance
arNextTransactionNumber	object Ar Next Transaction Number
assignedAdmissionsRepId	number <int32> Assigned Admissions Rep Id
athleticIdentifier	string Athletic Identifier
bestTimeToContact	string Best Time To Contact
campusId	number <int32> The campus for the student. The list only contains campuses you are associated with. You can only change the campus if the student is a prospect. Otherwise, the campus is specified during enrollment and the field is display only.
citizenId	number <int32> The citizenship status for the student. The citizenship status is used to determine whether or not a student is eligible for financial aid.
city	string The name of the city.
collegeId	number <int32> College Id
countryId	number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country.
countyId	number <int32> The county for the address.
createdDateTime	string <date-time> The date when the item or person was added or the status change was entered.
cumulativeGpa	number <double> Cumulative Gpa
cumulativeGpaPoints	number <double> Cumulative Gpa Points
currencyCodeId	number <int32> Currency Code Id
currentLda	string <date-time> Current Lda
dataBlockIndicator	boolean When it is not selected, indicates that the student has chosen to block the release of their directory information under the he Family Educational Rights and Privacy Act (FERPA) at the Clearinghouse from distribution to other servicers. This indicator, along with the other data, is sent to the Clearinghouse. When selected, the student has chosen to share directory information. The type of information that can be shared is determined by your institution and you can specify the type of information on their FERPA page. The field is disabled by default and is only enabled if your campus is using the Clearinghouse for sending IPEDS data to the Department of Education.
dateOfBirth	string <date-time> Specifies the date of birth (DOB) in the format MM/DD/YYYY.
dbiModifiedDate	string <date-time> Dbi Modified Date
defaultAddressCode	string Default Address Code
defaultMasterStudentAddressId	number <int32> Default Master Student Address Id
defaultStudentAddressId	number <int32> Default Student Address Id
disabled	string Disability status of the student. When you are adding the Student Profile, Unspecified is the default.
driverLicenseNumber	string The driver's license number for the student.
driverLicenseState	string The state where the driver's license for the student was issued.
emailAddress	string The email address.
employabilityAboutInfo	string Employability About Info
employerId	number <int32> Employer Id
employmentStatusId	number <int32> Employment Status Id
externalStudentIdentifier	string External Student Identifier
extraCurricularActivityId	number <int32> Extra Curricular Activity Id
facebookUrl	string Facebook Url
faGradPlusCounselingDate	string <date-time> Fa Grad Plus Counseling Date
faRigorousHighSchoolProgramCodeId	number <int32> Fa Rigorous High School Program Code Id
firstName	string The first name of the student or person.
genderId	number <int32> The gender of the student or person. The values that can be selected are configured by your institution.
gpaCredits	number <double> Gpa Credits
hispanicLatino	string Indicates whether a student is of Spanish or Latin American descent.
hsAcademicGpa	number <double> Hs Academic Gpa
instagramUrl	string Instagram Url
isActive	boolean Specifies whether or not the associated record is active.
isAllowedBulkRegistrationByTrack	boolean Is Allowed Bulk Registration By Track
isBadAddress	boolean When selected, specifies that there are one more errors in the address for the student (such as the address is incomplete or mail has been returned).
isBadPhone	boolean When selected, specifies that there is an error in the phone number for the student.
isDdVeteran	boolean Is Dd Veteran
isEftDefaultForStipends	boolean Is Eft Default For Stipends
isInDistrict	boolean Is In District
isSscrError11Received	boolean Is Sscr Error11Received
lastActivityDate	string <date-time> Last Activity Date
lastInterestDate	string <date-time> Last Interest Date
lastModifiedDateTime	string <date-time> The date that the item was updated or changed.
lastModifiedUserId	number <int32> The last and then first name of the person that changed the item.
lastName	string The last name of the student or person.
lastNameFirstFour	string Last Name First Four
lastStatementBeginDate	string <date-time> Last Statement Begin Date
lastStatementCloseDate	string <date-time> Last Statement Close Date
lastStatementDate	string <date-time> Last Statement Date
leadDate	string <date-time> The date that the prospective student contacted the institution.
leadSourceId	number <int32> Lead Source Id
leadTypeId	number <int32> The type of prospect. The values are configured by your institution.
linkedInUrl	string Linked In Url
maidenName	string If any, the maiden name of the student or person.
maritalStatusId	number <int32> The marital status of the student. The values are configured by your institution.
mi	string Mi
middleName	string The middle name of the student or person.
mobilePhoneNumber	string Specifies the mobile phone number. A mobile number must be specified if the student wants to receive SMS text messages. It must also be specified if you select the Subscribe to SMS check box.
nationalityId	number <int32> If your institution enrolls international students, the nationality of the student. The values can be configured by your institution.
nickName	string If the student has a substitute for their proper name, the name.
niStudent	boolean Specifies whether or not a student is an international (non-immigrant) student. This field is disabled if your institution does not enroll international students. This field is required for Student and Exchange Visitor Information System (SEVIS) processing for the Immigration and Naturalization Service (INS).
note	string Area you can use to display or specify comments or additional information.
originalAssignedAdmissionsRepId	number <int32> Original Assigned Admissions Rep Id
originalExpectedStartDate	string <date-time> Original Student Expected Start Date
originalStartDate	string <date-time> Original Start Date
otherEmailAddress	string If the student has more than one email address, the secondary email address.
otherPhoneNumber	string If the student has a phone number where they can be contacted in addition to their mobile or work phone, the phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens).
personId	number <int32> Person Id
phoneNumber	string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens).
pin	number <double> The 4-digit personal identification number (PIN) selected by the student. The portal requires the student to enter his or her Student ID and PIN to log in. If you do not specify the PIN or change the social security number, the program defaults the PIN to the last four numbers of the social security number. If the last four characters begin with a zero, the PIN defaults to a 1 followed by the last 3 characters of the number. For example, if the last 4 digits of the social security number are 0398, the PIN is 1398.
postalCode	string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes.
postalCodeFirstThree	string Postal Code First Three
preferredContactType	string Preferred Contact Type
preferredName	string Preferred Name
previousEducationGpa	number <double> Previous Education Gpa
previousEducationId	number <int32> The highest level of previous education for the student. The previous education for the student. If selected in a report, the report contains the name of the institution, and the status (such as graduated). If the student graduated, it also shows the graduation date and year.
programGroupId	number <int32> Program Group Id
programId	number <int32> Program Id
rawFirstName	string Raw First Name
rawLastName	string Raw Last Name
rawPhoneNumber	string Raw Phone Number
rowVersion	string
schoolStatusId	number <int32> Specifies the status of the prospect or student at your institution. Statuses vary by institution. They are configured by your institution. If you change the status for a student, a dialog is displayed so that you can confirm the change. If there are also tasks associated with the previous status, CampusNexus Student displays a dialog that you can use to select the tasks to keep and the tasks to close with the result of canceled.
shiftId	number <int32> The shift that the student will attend classes (such as day or evenings). They are configured by your institution.
smsServiceProviderId	number <int32> Specifies the cell phone provider for the student. If you select the Subscribe to SMS check box, you must also specify a value for Mobile Phone Number and select a provider in the SMS Provider list for the student to receive the text messages.
sourceSystem	string Source System
ssn	string The social security number (SSN) associated with the student. You must be authorized to work with SSNs.
startDate	string <date-time> The expected start date for the student at your institution.
state	string If within the United States, the name of the state.
statementComment	string Statement Comment
streetAddress	string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, if an address has more than 40 characters, the additional characters in the address line will not be extracted to be sent to COD, but will be truncated.
streetAddress2	string Street Address2
studentFullName	string Student Full Name
studentIdentifier	string Student Identifier
studentNumber	string If your institution assigns student numbers, the number your institution uses to identify the student. How the number is assigned, is specified by your institution. For example, CampusNexus Student can be configured to assign the number or your institution can use some other method for assigning the ID.
subscribeToSms	boolean Specifies that the student wants to receive SMS text messages. If you select the check box, you must also specify a value for Mobile Phone Number and select a provider in the SMS Provider list for the student to receive the text messages. The student can also use the CampusNexus Portal.
suffix	string If the student or person's name has a suffix, the suffix. The suffix is required by SEVIS.
suffixId	number <int32> If the student or person's name has a suffix, the suffix. The suffix is required by SEVIS.
titleId	number <int32> The title for the student.
twitterUrl	string Twitter Url
veteran	string The veteran status of the student.
workPhoneNumber	string The work telephone number for the student. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). When a student is placed in a job using student placement, the program automatically updates the number with the phone number for the employer. If it applies, the extension is also updated.
workPhoneNumberExtension	string If needed, the extension for the work phone number.
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Batch Transcript Students

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (common-student-getbatchtranscriptstudents-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
statusIdList	Array of numbers <int32> [ items <int32 > ]
studentGroupId	number <int32>
programVersionId	number <int32>
programId	number <int32>
minStartDate	string <date-time>
maxStartDate	string <date-time>
firstName	string
lastName	string
ssn	string
studentId	number <int32>
enrollmentNumber	string
studentGroupIdList	Array of numbers <int32> [ items <int32 > ]
programVersionIdList	Array of numbers <int32> [ items <int32 > ]
shiftIdList	Array of numbers <int32> [ items <int32 > ]
minGraduationDate	string <date-time>
maxGraduationDate	string <date-time>
isIncludeTranscriptsOnHold	boolean
studentIDToPrint	number <int32>
studentNumber	string
emailAddress	string
phoneNumber	string
dateOfBirth	string <date-time>
programIdList	Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"statusIdList": [0
],
"studentGroupId": 0,
"programVersionId": 0,
"programId": 0,
"minStartDate": "2019-08-24T14:15:22Z",
"maxStartDate": "2019-08-24T14:15:22Z",
"firstName": "string",
"lastName": "string",
"ssn": "string",
"studentId": 0,
"enrollmentNumber": "string",
"studentGroupIdList": [0
],
"programVersionIdList": [0
],
"shiftIdList": [0
],
"minGraduationDate": "2019-08-24T14:15:22Z",
"maxGraduationDate": "2019-08-24T14:15:22Z",
"isIncludeTranscriptsOnHold": true,
"studentIDToPrint": 0,
"studentNumber": "string",
"emailAddress": "string",
"phoneNumber": "string",
"dateOfBirth": "2019-08-24T14:15:22Z",
"programIdList": [0
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentBatchTranscriptList": [{"id": 0,
"studentNumber": "string",
"studentName": "string",
"enrollmentNumber": "string",
"campusId": 0,
"campusName": "string",
"programId": 0,
"programName": "string",
"programVersionId": 0,
"programVersionName": "string",
"programVersionCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"schoolStatusId": 0,
"schoolStatusName": "string",
"filePath": "string",
"fileName": "string",
"status": "string",
"exceptionMsg": "string",
"transcriptHoldStatus": 0
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Quick Lead Template Detail

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (common-student-getquickleadtemplatedetail-request-payload)

templateCode	string
	Array of objects (cmc-nexus-common-services-getQuickLeadTemplateDetailRequest_TemplateProperty)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"templateCode": "string",
"templatePropertyList": [{"columnName": "string",
"tableName": "string",
"isRequired": true,
"groupName": "string"
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"prospectTemplateFieldDetails": [{"controlType": "string",
"controlOption": "string",
"displayName": "string",
"displayFormat": "string",
"propertyName": "string",
"helpText": "string",
"tableName": "string",
"isDefault": true,
"isRequired": true,
"inputMask": "string",
"dataType": "string",
"maxLength": 0,
"decimals": "string",
"minimumRange": "string",
"maximumRange": "string",
"isDataFromOData": true,
"oDataLookUp": "string",
"valueField": "string",
"textField": "string",
"selectedValue": "string",
"otherSelectedValue": "string",
"existingDataDetails": [{"id": 0,
"name": "string",
"code": "string"
}
],
"groupName": "string",
"orderNumber": 0
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Recent Students

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

payload

any (common-student-getrecentstudents-request-payload)

Responses

Request samples

Payload

Content type

application/json

{"payload": null
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Process Duplicate Student

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (common-student-processduplicatestudent-request-payload)

object (cmc-nexus-common-entities-studentEntity)

isExcludedCrmIntegration	boolean
addressTypeId	number <int32>
studentInquiryRequired	boolean
extraCurricularsList	Array of numbers <int32> [ items <int32 > ]
programsList	Array of numbers <int32> [ items <int32 > ]
enrolledProgramIdList	Array of numbers <int32> [ items <int32 > ]
ethnicitiesList	Array of numbers <int32> [ items <int32 > ]
leadSourcesList	Array of numbers <int32> [ items <int32 > ]
deleteVeteranDetails	boolean
	Array of objects (cmc-nexus-common-entities-vendor)
studentAddressAssociation	number <int32>
newAssignedAdmissionsRepId	number <int32>
assignedAdmissionsRepReassignedDate	string <date-time>
	object (cmc-nexus-common-entities-studentRelationshipAddressEntity)
lastFourSsn	string Last Four Ssn
customProperties	Array of strings
multiValueCustomProperties	Array of strings
originalCustomProperties	Array of strings
originalMultiValueCustomProperties	Array of strings
originalCustomPropertiesValues	string <byte>
originalMultiValueCustomPropertiesValues	string <byte>
genderPronounList	Array of numbers <int32> [ items <int32 > ]
overridePrevEducAltPellValidation	boolean
id required	number <int32> Id
acgEligReasonCode	string Acg Elig Reason Code
agencyId	number <int32> Agency Id
alienNumber	string If the student is not a U.S. citizen, the alien registration number for the student.
arAccountStatus	string Ar Account Status
arBalance	number <double> Ar Balance
arNextTransactionNumber	object Ar Next Transaction Number
assignedAdmissionsRepId	number <int32> Assigned Admissions Rep Id
athleticIdentifier	string Athletic Identifier
bestTimeToContact	string Best Time To Contact
campusId required	number <int32> The campus for the student. The list only contains campuses you are associated with. You can only change the campus if the student is a prospect. Otherwise, the campus is specified during enrollment and the field is display only.
citizenId	number <int32> The citizenship status for the student. The citizenship status is used to determine whether or not a student is eligible for financial aid.
city	string The name of the city.
collegeId	number <int32> College Id
countryId	number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country.
countyId	number <int32> The county for the address.
createdDateTime	string <date-time> The date when the item or person was added or the status change was entered.
cumulativeGpa	number <double> Cumulative Gpa
cumulativeGpaPoints	number <double> Cumulative Gpa Points
currencyCodeId	number <int32> Currency Code Id
currentLda	string <date-time> Current Lda
dataBlockIndicator	boolean When it is not selected, indicates that the student has chosen to block the release of their directory information under the he Family Educational Rights and Privacy Act (FERPA) at the Clearinghouse from distribution to other servicers. This indicator, along with the other data, is sent to the Clearinghouse. When selected, the student has chosen to share directory information. The type of information that can be shared is determined by your institution and you can specify the type of information on their FERPA page. The field is disabled by default and is only enabled if your campus is using the Clearinghouse for sending IPEDS data to the Department of Education.
dateOfBirth	string <date-time> Specifies the date of birth (DOB) in the format MM/DD/YYYY.
dbiModifiedDate	string <date-time> Dbi Modified Date
defaultAddressCode	string Default Address Code
defaultMasterStudentAddressId	number <int32> Default Master Student Address Id
defaultStudentAddressId	number <int32> Default Student Address Id
disabled	string Disability status of the student. When you are adding the Student Profile, Unspecified is the default.
driverLicenseNumber	string The driver's license number for the student.
driverLicenseState	string The state where the driver's license for the student was issued.
emailAddress	string The email address.
employabilityAboutInfo	string Employability About Info
employerId	number <int32> Employer Id
employmentStatusId	number <int32> Employment Status Id
externalStudentIdentifier	string External Student Identifier
extraCurricularActivityId	number <int32> Extra Curricular Activity Id
facebookUrl	string Facebook Url
faGradPlusCounselingDate	string <date-time> Fa Grad Plus Counseling Date
faRigorousHighSchoolProgramCodeId	number <int32> Fa Rigorous High School Program Code Id
firstName required	string The first name of the student or person.
genderId	number <int32> The gender of the student or person. The values that can be selected are configured by your institution.
gpaCredits	number <double> Gpa Credits
hispanicLatino	string Indicates whether a student is of Spanish or Latin American descent.
hsAcademicGpa	number <double> Hs Academic Gpa
instagramUrl	string Instagram Url
isActive	boolean Specifies whether or not the associated record is active.
isAllowedBulkRegistrationByTrack	boolean Is Allowed Bulk Registration By Track
isBadAddress	boolean When selected, specifies that there are one more errors in the address for the student (such as the address is incomplete or mail has been returned).
isBadPhone	boolean When selected, specifies that there is an error in the phone number for the student.
isDdVeteran	boolean Is Dd Veteran
isEftDefaultForStipends	boolean Is Eft Default For Stipends
isInDistrict	boolean Is In District
isSscrError11Received	boolean Is Sscr Error11Received
lastActivityDate	string <date-time> Last Activity Date
lastInterestDate	string <date-time> Last Interest Date
lastModifiedDateTime	string <date-time> The date that the item was updated or changed.
lastModifiedUserId	number <int32> The last and then first name of the person that changed the item.
lastName required	string The last name of the student or person.
lastNameFirstFour	string Last Name First Four
lastStatementBeginDate	string <date-time> Last Statement Begin Date
lastStatementCloseDate	string <date-time> Last Statement Close Date
lastStatementDate	string <date-time> Last Statement Date
leadDate	string <date-time> The date that the prospective student contacted the institution.
leadSourceId	number <int32> Lead Source Id
leadTypeId	number <int32> The type of prospect. The values are configured by your institution.
linkedInUrl	string Linked In Url
maidenName	string If any, the maiden name of the student or person.
maritalStatusId	number <int32> The marital status of the student. The values are configured by your institution.
mi	string Mi
middleName	string The middle name of the student or person.
mobilePhoneNumber	string Specifies the mobile phone number. A mobile number must be specified if the student wants to receive SMS text messages. It must also be specified if you select the Subscribe to SMS check box.
nationalityId	number <int32> If your institution enrolls international students, the nationality of the student. The values can be configured by your institution.
nickName	string If the student has a substitute for their proper name, the name.
niStudent	boolean Specifies whether or not a student is an international (non-immigrant) student. This field is disabled if your institution does not enroll international students. This field is required for Student and Exchange Visitor Information System (SEVIS) processing for the Immigration and Naturalization Service (INS).
note	string Area you can use to display or specify comments or additional information.
originalAssignedAdmissionsRepId	number <int32> Original Assigned Admissions Rep Id
originalExpectedStartDate	string <date-time> Original Student Expected Start Date
originalStartDate	string <date-time> Original Start Date
otherEmailAddress	string If the student has more than one email address, the secondary email address.
otherPhoneNumber	string If the student has a phone number where they can be contacted in addition to their mobile or work phone, the phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens).
personId	number <int32> Person Id
phoneNumber	string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens).
pin	number <double> The 4-digit personal identification number (PIN) selected by the student. The portal requires the student to enter his or her Student ID and PIN to log in. If you do not specify the PIN or change the social security number, the program defaults the PIN to the last four numbers of the social security number. If the last four characters begin with a zero, the PIN defaults to a 1 followed by the last 3 characters of the number. For example, if the last 4 digits of the social security number are 0398, the PIN is 1398.
postalCode	string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes.
postalCodeFirstThree	string Postal Code First Three
preferredContactType	string Preferred Contact Type
preferredName	string Preferred Name
previousEducationGpa	number <double> Previous Education Gpa
previousEducationId	number <int32> The highest level of previous education for the student. The previous education for the student. If selected in a report, the report contains the name of the institution, and the status (such as graduated). If the student graduated, it also shows the graduation date and year.
programGroupId	number <int32> Program Group Id
programId	number <int32> Program Id
rawFirstName	string Raw First Name
rawLastName	string Raw Last Name
rawPhoneNumber	string Raw Phone Number
rowVersion	string
schoolStatusId required	number <int32> Specifies the status of the prospect or student at your institution. Statuses vary by institution. They are configured by your institution. If you change the status for a student, a dialog is displayed so that you can confirm the change. If there are also tasks associated with the previous status, CampusNexus Student displays a dialog that you can use to select the tasks to keep and the tasks to close with the result of canceled.
shiftId	number <int32> The shift that the student will attend classes (such as day or evenings). They are configured by your institution.
smsServiceProviderId	number <int32> Specifies the cell phone provider for the student. If you select the Subscribe to SMS check box, you must also specify a value for Mobile Phone Number and select a provider in the SMS Provider list for the student to receive the text messages.
sourceSystem	string Source System
ssn	string The social security number (SSN) associated with the student. You must be authorized to work with SSNs.
startDate	string <date-time> The expected start date for the student at your institution.
state	string If within the United States, the name of the state.
statementComment	string Statement Comment
streetAddress	string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, if an address has more than 40 characters, the additional characters in the address line will not be extracted to be sent to COD, but will be truncated.
streetAddress2	string Street Address2
studentFullName	string Student Full Name
studentIdentifier	string Student Identifier
studentNumber	string If your institution assigns student numbers, the number your institution uses to identify the student. How the number is assigned, is specified by your institution. For example, CampusNexus Student can be configured to assign the number or your institution can use some other method for assigning the ID.
subscribeToSms	boolean Specifies that the student wants to receive SMS text messages. If you select the check box, you must also specify a value for Mobile Phone Number and select a provider in the SMS Provider list for the student to receive the text messages. The student can also use the CampusNexus Portal.
suffix	string If the student or person's name has a suffix, the suffix. The suffix is required by SEVIS.
suffixId	number <int32> If the student or person's name has a suffix, the suffix. The suffix is required by SEVIS.
titleId	number <int32> The title for the student.
twitterUrl	string Twitter Url
veteran	string The veteran status of the student.
workPhoneNumber	string The work telephone number for the student. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). When a student is placed in a job using student placement, the program automatically updates the number with the phone number for the employer. If it applies, the extension is also updated.
workPhoneNumberExtension	string If needed, the extension for the work phone number.
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"entity": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}
}

Response samples

Content type

application/json

{"payload": {"data": {"entity": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Student

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (common-student-save-request-payload)

isExcludedCrmIntegration	boolean
addressTypeId	number <int32>
studentInquiryRequired	boolean
extraCurricularsList	Array of numbers <int32> [ items <int32 > ]
programsList	Array of numbers <int32> [ items <int32 > ]
enrolledProgramIdList	Array of numbers <int32> [ items <int32 > ]
ethnicitiesList	Array of numbers <int32> [ items <int32 > ]
leadSourcesList	Array of numbers <int32> [ items <int32 > ]
deleteVeteranDetails	boolean
	Array of objects (cmc-nexus-common-entities-vendor)
studentAddressAssociation	number <int32>
newAssignedAdmissionsRepId	number <int32>
assignedAdmissionsRepReassignedDate	string <date-time>
	object (cmc-nexus-common-entities-studentRelationshipAddressEntity)
lastFourSsn	string Last Four Ssn
customProperties	Array of strings
multiValueCustomProperties	Array of strings
originalCustomProperties	Array of strings
originalMultiValueCustomProperties	Array of strings
originalCustomPropertiesValues	string <byte>
originalMultiValueCustomPropertiesValues	string <byte>
genderPronounList	Array of numbers <int32> [ items <int32 > ]
overridePrevEducAltPellValidation	boolean
id	number <int32> Id
acgEligReasonCode	string Acg Elig Reason Code
agencyId	number <int32> Agency Id
alienNumber	string If the student is not a U.S. citizen, the alien registration number for the student.
arAccountStatus	string Ar Account Status
arBalance	number <double> Ar Balance
arNextTransactionNumber	object Ar Next Transaction Number
assignedAdmissionsRepId	number <int32> Assigned Admissions Rep Id
athleticIdentifier	string Athletic Identifier
bestTimeToContact	string Best Time To Contact
campusId	number <int32> The campus for the student. The list only contains campuses you are associated with. You can only change the campus if the student is a prospect. Otherwise, the campus is specified during enrollment and the field is display only.
citizenId	number <int32> The citizenship status for the student. The citizenship status is used to determine whether or not a student is eligible for financial aid.
city	string The name of the city.
collegeId	number <int32> College Id
countryId	number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country.
countyId	number <int32> The county for the address.
createdDateTime	string <date-time> The date when the item or person was added or the status change was entered.
cumulativeGpa	number <double> Cumulative Gpa
cumulativeGpaPoints	number <double> Cumulative Gpa Points
currencyCodeId	number <int32> Currency Code Id
currentLda	string <date-time> Current Lda
dataBlockIndicator	boolean When it is not selected, indicates that the student has chosen to block the release of their directory information under the he Family Educational Rights and Privacy Act (FERPA) at the Clearinghouse from distribution to other servicers. This indicator, along with the other data, is sent to the Clearinghouse. When selected, the student has chosen to share directory information. The type of information that can be shared is determined by your institution and you can specify the type of information on their FERPA page. The field is disabled by default and is only enabled if your campus is using the Clearinghouse for sending IPEDS data to the Department of Education.
dateOfBirth	string <date-time> Specifies the date of birth (DOB) in the format MM/DD/YYYY.
dbiModifiedDate	string <date-time> Dbi Modified Date
defaultAddressCode	string Default Address Code
defaultMasterStudentAddressId	number <int32> Default Master Student Address Id
defaultStudentAddressId	number <int32> Default Student Address Id
disabled	string Disability status of the student. When you are adding the Student Profile, Unspecified is the default.
driverLicenseNumber	string The driver's license number for the student.
driverLicenseState	string The state where the driver's license for the student was issued.
emailAddress	string The email address.
employabilityAboutInfo	string Employability About Info
employerId	number <int32> Employer Id
employmentStatusId	number <int32> Employment Status Id
externalStudentIdentifier	string External Student Identifier
extraCurricularActivityId	number <int32> Extra Curricular Activity Id
facebookUrl	string Facebook Url
faGradPlusCounselingDate	string <date-time> Fa Grad Plus Counseling Date
faRigorousHighSchoolProgramCodeId	number <int32> Fa Rigorous High School Program Code Id
firstName	string The first name of the student or person.
genderId	number <int32> The gender of the student or person. The values that can be selected are configured by your institution.
gpaCredits	number <double> Gpa Credits
hispanicLatino	string Indicates whether a student is of Spanish or Latin American descent.
hsAcademicGpa	number <double> Hs Academic Gpa
instagramUrl	string Instagram Url
isActive	boolean Specifies whether or not the associated record is active.
isAllowedBulkRegistrationByTrack	boolean Is Allowed Bulk Registration By Track
isBadAddress	boolean When selected, specifies that there are one more errors in the address for the student (such as the address is incomplete or mail has been returned).
isBadPhone	boolean When selected, specifies that there is an error in the phone number for the student.
isDdVeteran	boolean Is Dd Veteran
isEftDefaultForStipends	boolean Is Eft Default For Stipends
isInDistrict	boolean Is In District
isSscrError11Received	boolean Is Sscr Error11Received
lastActivityDate	string <date-time> Last Activity Date
lastInterestDate	string <date-time> Last Interest Date
lastModifiedDateTime	string <date-time> The date that the item was updated or changed.
lastModifiedUserId	number <int32> The last and then first name of the person that changed the item.
lastName	string The last name of the student or person.
lastNameFirstFour	string Last Name First Four
lastStatementBeginDate	string <date-time> Last Statement Begin Date
lastStatementCloseDate	string <date-time> Last Statement Close Date
lastStatementDate	string <date-time> Last Statement Date
leadDate	string <date-time> The date that the prospective student contacted the institution.
leadSourceId	number <int32> Lead Source Id
leadTypeId	number <int32> The type of prospect. The values are configured by your institution.
linkedInUrl	string Linked In Url
maidenName	string If any, the maiden name of the student or person.
maritalStatusId	number <int32> The marital status of the student. The values are configured by your institution.
mi	string Mi
middleName	string The middle name of the student or person.
mobilePhoneNumber	string Specifies the mobile phone number. A mobile number must be specified if the student wants to receive SMS text messages. It must also be specified if you select the Subscribe to SMS check box.
nationalityId	number <int32> If your institution enrolls international students, the nationality of the student. The values can be configured by your institution.
nickName	string If the student has a substitute for their proper name, the name.
niStudent	boolean Specifies whether or not a student is an international (non-immigrant) student. This field is disabled if your institution does not enroll international students. This field is required for Student and Exchange Visitor Information System (SEVIS) processing for the Immigration and Naturalization Service (INS).
note	string Area you can use to display or specify comments or additional information.
originalAssignedAdmissionsRepId	number <int32> Original Assigned Admissions Rep Id
originalExpectedStartDate	string <date-time> Original Student Expected Start Date
originalStartDate	string <date-time> Original Start Date
otherEmailAddress	string If the student has more than one email address, the secondary email address.
otherPhoneNumber	string If the student has a phone number where they can be contacted in addition to their mobile or work phone, the phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens).
personId	number <int32> Person Id
phoneNumber	string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens).
pin	number <double> The 4-digit personal identification number (PIN) selected by the student. The portal requires the student to enter his or her Student ID and PIN to log in. If you do not specify the PIN or change the social security number, the program defaults the PIN to the last four numbers of the social security number. If the last four characters begin with a zero, the PIN defaults to a 1 followed by the last 3 characters of the number. For example, if the last 4 digits of the social security number are 0398, the PIN is 1398.
postalCode	string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes.
postalCodeFirstThree	string Postal Code First Three
preferredContactType	string Preferred Contact Type
preferredName	string Preferred Name
previousEducationGpa	number <double> Previous Education Gpa
previousEducationId	number <int32> The highest level of previous education for the student. The previous education for the student. If selected in a report, the report contains the name of the institution, and the status (such as graduated). If the student graduated, it also shows the graduation date and year.
programGroupId	number <int32> Program Group Id
programId	number <int32> Program Id
rawFirstName	string Raw First Name
rawLastName	string Raw Last Name
rawPhoneNumber	string Raw Phone Number
rowVersion	string
schoolStatusId	number <int32> Specifies the status of the prospect or student at your institution. Statuses vary by institution. They are configured by your institution. If you change the status for a student, a dialog is displayed so that you can confirm the change. If there are also tasks associated with the previous status, CampusNexus Student displays a dialog that you can use to select the tasks to keep and the tasks to close with the result of canceled.
shiftId	number <int32> The shift that the student will attend classes (such as day or evenings). They are configured by your institution.
smsServiceProviderId	number <int32> Specifies the cell phone provider for the student. If you select the Subscribe to SMS check box, you must also specify a value for Mobile Phone Number and select a provider in the SMS Provider list for the student to receive the text messages.
sourceSystem	string Source System
ssn	string The social security number (SSN) associated with the student. You must be authorized to work with SSNs.
startDate	string <date-time> The expected start date for the student at your institution.
state	string If within the United States, the name of the state.
statementComment	string Statement Comment
streetAddress	string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, if an address has more than 40 characters, the additional characters in the address line will not be extracted to be sent to COD, but will be truncated.
streetAddress2	string Street Address2
studentFullName	string Student Full Name
studentIdentifier	string Student Identifier
studentNumber	string If your institution assigns student numbers, the number your institution uses to identify the student. How the number is assigned, is specified by your institution. For example, CampusNexus Student can be configured to assign the number or your institution can use some other method for assigning the ID.
subscribeToSms	boolean Specifies that the student wants to receive SMS text messages. If you select the check box, you must also specify a value for Mobile Phone Number and select a provider in the SMS Provider list for the student to receive the text messages. The student can also use the CampusNexus Portal.
suffix	string If the student or person's name has a suffix, the suffix. The suffix is required by SEVIS.
suffixId	number <int32> If the student or person's name has a suffix, the suffix. The suffix is required by SEVIS.
titleId	number <int32> The title for the student.
twitterUrl	string Twitter Url
veteran	string The veteran status of the student.
workPhoneNumber	string The work telephone number for the student. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). When a student is placed in a job using student placement, the program automatically updates the number with the phone number for the employer. If it applies, the extension is also updated.
workPhoneNumberExtension	string If needed, the extension for the work phone number.
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Student

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (common-student-savenew-request-payload)

isExcludedCrmIntegration	boolean
addressTypeId	number <int32>
studentInquiryRequired	boolean
extraCurricularsList	Array of numbers <int32> [ items <int32 > ]
programsList	Array of numbers <int32> [ items <int32 > ]
enrolledProgramIdList	Array of numbers <int32> [ items <int32 > ]
ethnicitiesList	Array of numbers <int32> [ items <int32 > ]
leadSourcesList	Array of numbers <int32> [ items <int32 > ]
deleteVeteranDetails	boolean
	Array of objects (cmc-nexus-common-entities-vendor)
studentAddressAssociation	number <int32>
newAssignedAdmissionsRepId	number <int32>
assignedAdmissionsRepReassignedDate	string <date-time>
	object (cmc-nexus-common-entities-studentRelationshipAddressEntity)
lastFourSsn	string Last Four Ssn
customProperties	Array of strings
multiValueCustomProperties	Array of strings
originalCustomProperties	Array of strings
originalMultiValueCustomProperties	Array of strings
originalCustomPropertiesValues	string <byte>
originalMultiValueCustomPropertiesValues	string <byte>
genderPronounList	Array of numbers <int32> [ items <int32 > ]
overridePrevEducAltPellValidation	boolean
id	number <int32> Id
acgEligReasonCode	string Acg Elig Reason Code
agencyId	number <int32> Agency Id
alienNumber	string If the student is not a U.S. citizen, the alien registration number for the student.
arAccountStatus	string Ar Account Status
arBalance	number <double> Ar Balance
arNextTransactionNumber	object Ar Next Transaction Number
assignedAdmissionsRepId	number <int32> Assigned Admissions Rep Id
athleticIdentifier	string Athletic Identifier
bestTimeToContact	string Best Time To Contact
campusId	number <int32> The campus for the student. The list only contains campuses you are associated with. You can only change the campus if the student is a prospect. Otherwise, the campus is specified during enrollment and the field is display only.
citizenId	number <int32> The citizenship status for the student. The citizenship status is used to determine whether or not a student is eligible for financial aid.
city	string The name of the city.
collegeId	number <int32> College Id
countryId	number <int32> The country of residence. If you are specifying a country, it defaults to the country for the campus. The country also determines the format of phone numbers. If you change the country, the phone numbers are automatically reformatted to the format for that country.
countyId	number <int32> The county for the address.
createdDateTime	string <date-time> The date when the item or person was added or the status change was entered.
cumulativeGpa	number <double> Cumulative Gpa
cumulativeGpaPoints	number <double> Cumulative Gpa Points
currencyCodeId	number <int32> Currency Code Id
currentLda	string <date-time> Current Lda
dataBlockIndicator	boolean When it is not selected, indicates that the student has chosen to block the release of their directory information under the he Family Educational Rights and Privacy Act (FERPA) at the Clearinghouse from distribution to other servicers. This indicator, along with the other data, is sent to the Clearinghouse. When selected, the student has chosen to share directory information. The type of information that can be shared is determined by your institution and you can specify the type of information on their FERPA page. The field is disabled by default and is only enabled if your campus is using the Clearinghouse for sending IPEDS data to the Department of Education.
dateOfBirth	string <date-time> Specifies the date of birth (DOB) in the format MM/DD/YYYY.
dbiModifiedDate	string <date-time> Dbi Modified Date
defaultAddressCode	string Default Address Code
defaultMasterStudentAddressId	number <int32> Default Master Student Address Id
defaultStudentAddressId	number <int32> Default Student Address Id
disabled	string Disability status of the student. When you are adding the Student Profile, Unspecified is the default.
driverLicenseNumber	string The driver's license number for the student.
driverLicenseState	string The state where the driver's license for the student was issued.
emailAddress	string The email address.
employabilityAboutInfo	string Employability About Info
employerId	number <int32> Employer Id
employmentStatusId	number <int32> Employment Status Id
externalStudentIdentifier	string External Student Identifier
extraCurricularActivityId	number <int32> Extra Curricular Activity Id
facebookUrl	string Facebook Url
faGradPlusCounselingDate	string <date-time> Fa Grad Plus Counseling Date
faRigorousHighSchoolProgramCodeId	number <int32> Fa Rigorous High School Program Code Id
firstName	string The first name of the student or person.
genderId	number <int32> The gender of the student or person. The values that can be selected are configured by your institution.
gpaCredits	number <double> Gpa Credits
hispanicLatino	string Indicates whether a student is of Spanish or Latin American descent.
hsAcademicGpa	number <double> Hs Academic Gpa
instagramUrl	string Instagram Url
isActive	boolean Specifies whether or not the associated record is active.
isAllowedBulkRegistrationByTrack	boolean Is Allowed Bulk Registration By Track
isBadAddress	boolean When selected, specifies that there are one more errors in the address for the student (such as the address is incomplete or mail has been returned).
isBadPhone	boolean When selected, specifies that there is an error in the phone number for the student.
isDdVeteran	boolean Is Dd Veteran
isEftDefaultForStipends	boolean Is Eft Default For Stipends
isInDistrict	boolean Is In District
isSscrError11Received	boolean Is Sscr Error11Received
lastActivityDate	string <date-time> Last Activity Date
lastInterestDate	string <date-time> Last Interest Date
lastModifiedDateTime	string <date-time> The date that the item was updated or changed.
lastModifiedUserId	number <int32> The last and then first name of the person that changed the item.
lastName	string The last name of the student or person.
lastNameFirstFour	string Last Name First Four
lastStatementBeginDate	string <date-time> Last Statement Begin Date
lastStatementCloseDate	string <date-time> Last Statement Close Date
lastStatementDate	string <date-time> Last Statement Date
leadDate	string <date-time> The date that the prospective student contacted the institution.
leadSourceId	number <int32> Lead Source Id
leadTypeId	number <int32> The type of prospect. The values are configured by your institution.
linkedInUrl	string Linked In Url
maidenName	string If any, the maiden name of the student or person.
maritalStatusId	number <int32> The marital status of the student. The values are configured by your institution.
mi	string Mi
middleName	string The middle name of the student or person.
mobilePhoneNumber	string Specifies the mobile phone number. A mobile number must be specified if the student wants to receive SMS text messages. It must also be specified if you select the Subscribe to SMS check box.
nationalityId	number <int32> If your institution enrolls international students, the nationality of the student. The values can be configured by your institution.
nickName	string If the student has a substitute for their proper name, the name.
niStudent	boolean Specifies whether or not a student is an international (non-immigrant) student. This field is disabled if your institution does not enroll international students. This field is required for Student and Exchange Visitor Information System (SEVIS) processing for the Immigration and Naturalization Service (INS).
note	string Area you can use to display or specify comments or additional information.
originalAssignedAdmissionsRepId	number <int32> Original Assigned Admissions Rep Id
originalExpectedStartDate	string <date-time> Original Student Expected Start Date
originalStartDate	string <date-time> Original Start Date
otherEmailAddress	string If the student has more than one email address, the secondary email address.
otherPhoneNumber	string If the student has a phone number where they can be contacted in addition to their mobile or work phone, the phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens).
personId	number <int32> Person Id
phoneNumber	string The phone number. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens).
pin	number <double> The 4-digit personal identification number (PIN) selected by the student. The portal requires the student to enter his or her Student ID and PIN to log in. If you do not specify the PIN or change the social security number, the program defaults the PIN to the last four numbers of the social security number. If the last four characters begin with a zero, the PIN defaults to a 1 followed by the last 3 characters of the number. For example, if the last 4 digits of the social security number are 0398, the PIN is 1398.
postalCode	string The postal code for the address. If you are specifying an address, you must specify a value for City or State. If you specify a city or state or both, the list contains the valid zip codes.
postalCodeFirstThree	string Postal Code First Three
preferredContactType	string Preferred Contact Type
preferredName	string Preferred Name
previousEducationGpa	number <double> Previous Education Gpa
previousEducationId	number <int32> The highest level of previous education for the student. The previous education for the student. If selected in a report, the report contains the name of the institution, and the status (such as graduated). If the student graduated, it also shows the graduation date and year.
programGroupId	number <int32> Program Group Id
programId	number <int32> Program Id
rawFirstName	string Raw First Name
rawLastName	string Raw Last Name
rawPhoneNumber	string Raw Phone Number
rowVersion	string
schoolStatusId	number <int32> Specifies the status of the prospect or student at your institution. Statuses vary by institution. They are configured by your institution. If you change the status for a student, a dialog is displayed so that you can confirm the change. If there are also tasks associated with the previous status, CampusNexus Student displays a dialog that you can use to select the tasks to keep and the tasks to close with the result of canceled.
shiftId	number <int32> The shift that the student will attend classes (such as day or evenings). They are configured by your institution.
smsServiceProviderId	number <int32> Specifies the cell phone provider for the student. If you select the Subscribe to SMS check box, you must also specify a value for Mobile Phone Number and select a provider in the SMS Provider list for the student to receive the text messages.
sourceSystem	string Source System
ssn	string The social security number (SSN) associated with the student. You must be authorized to work with SSNs.
startDate	string <date-time> The expected start date for the student at your institution.
state	string If within the United States, the name of the state.
statementComment	string Statement Comment
streetAddress	string The street address. If the address line exceeds 40 characters, you must abbreviate some elements of the address. For student addresses, if an address has more than 40 characters, the additional characters in the address line will not be extracted to be sent to COD, but will be truncated.
streetAddress2	string Street Address2
studentFullName	string Student Full Name
studentIdentifier	string Student Identifier
studentNumber	string If your institution assigns student numbers, the number your institution uses to identify the student. How the number is assigned, is specified by your institution. For example, CampusNexus Student can be configured to assign the number or your institution can use some other method for assigning the ID.
subscribeToSms	boolean Specifies that the student wants to receive SMS text messages. If you select the check box, you must also specify a value for Mobile Phone Number and select a provider in the SMS Provider list for the student to receive the text messages. The student can also use the CampusNexus Portal.
suffix	string If the student or person's name has a suffix, the suffix. The suffix is required by SEVIS.
suffixId	number <int32> If the student or person's name has a suffix, the suffix. The suffix is required by SEVIS.
titleId	number <int32> The title for the student.
twitterUrl	string Twitter Url
veteran	string The veteran status of the student.
workPhoneNumber	string The work telephone number for the student. The format will depend on how your institution configured phone numbers (such as whether or not it uses parenthesis and hyphens). When a student is placed in a job using student placement, the program automatically updates the number with the phone number for the employer. If it applies, the extension is also updated.
workPhoneNumberExtension	string If needed, the extension for the work phone number.
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Alumni

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (common-student-savenewalumni-request-payload)

userId	number <int32>
titleId	number <int32>
lastName	string
firstName	string
middleName	string
suffix	string
maidenName	string
nickName	string
address	string
city	string
state	string
zip	string
countryID	number <int32>
sSN	string
telephone	string
workphone	string
workExt	string
email	string
sexId	number <int32>
citizen	number <int32>
dLState	string
dLNum	string
campusID	number <int32>
statusID	number <int32>
programID	number <int32>
programVersionID	number <int32>
shiftID	number <int32>
gradeLevelID	number <int32>
programDescrip	string
cumGPA	string
comments	string
startDate	string <date-time>
gradDate	string <date-time>
midDate	string <date-time>
isBadAddress	boolean
countyId	number <int32>
isBadPhone	boolean
nationalityId	number <int32>
maritalStatusId	number <int32>
dateOfBirth	string <date-time>
alienNumber	string
agencyId	number <int32>
pIN	number <int32>
extraCurricularActivityId	number <int32>
dataBlockIndicator	boolean
disabled	string
veteran	string
otherPhoneNumber	string
otherEmailAddress	string
nIStudent	boolean
dBIModifiedDate	string <date-time>
smsServiceProviderId	number <int32>
subscribeToSMS	boolean
mobilePhoneNumber	string
hispanicLatino	string
ethnicitiesList	Array of numbers <int32> [ items <int32 > ]
extraCurricular	Array of numbers <int32> [ items <int32 > ]
genderPronounList	Array of numbers <int32> [ items <int32 > ]
preferredName	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"userId": 0,
"titleId": 0,
"lastName": "string",
"firstName": "string",
"middleName": "string",
"suffix": "string",
"maidenName": "string",
"nickName": "string",
"address": "string",
"city": "string",
"state": "string",
"zip": "string",
"countryID": 0,
"sSN": "string",
"telephone": "string",
"workphone": "string",
"workExt": "string",
"email": "string",
"sexId": 0,
"citizen": 0,
"dLState": "string",
"dLNum": "string",
"campusID": 0,
"statusID": 0,
"programID": 0,
"programVersionID": 0,
"shiftID": 0,
"gradeLevelID": 0,
"programDescrip": "string",
"cumGPA": "string",
"comments": "string",
"startDate": "2019-08-24T14:15:22Z",
"gradDate": "2019-08-24T14:15:22Z",
"midDate": "2019-08-24T14:15:22Z",
"isBadAddress": true,
"countyId": 0,
"isBadPhone": true,
"nationalityId": 0,
"maritalStatusId": 0,
"dateOfBirth": "2019-08-24T14:15:22Z",
"alienNumber": "string",
"agencyId": 0,
"pIN": 0,
"extraCurricularActivityId": 0,
"dataBlockIndicator": true,
"disabled": "string",
"veteran": "string",
"otherPhoneNumber": "string",
"otherEmailAddress": "string",
"nIStudent": true,
"dBIModifiedDate": "2019-08-24T14:15:22Z",
"smsServiceProviderId": 0,
"subscribeToSMS": true,
"mobilePhoneNumber": "string",
"hispanicLatino": "string",
"ethnicitiesList": [0
],
"extraCurricular": [0
],
"genderPronounList": [0
],
"preferredName": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"id": 0,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Quick Lead

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (common-student-savequicklead-request-payload)

	Array of objects (cmc-nexus-common-services-prospectTemplateFieldDetail)
isIgnoreDuplicate	boolean
processDuplicateStudentId	number <int32>
newAssignedAdmissionsRepId	number <int32>
effectiveDate	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"prospectTemplateFieldDetails": [{"controlType": "string",
"controlOption": "string",
"displayName": "string",
"displayFormat": "string",
"propertyName": "string",
"helpText": "string",
"tableName": "string",
"isDefault": true,
"isRequired": true,
"inputMask": "string",
"dataType": "string",
"maxLength": 0,
"decimals": "string",
"minimumRange": "string",
"maximumRange": "string",
"isDataFromOData": true,
"oDataLookUp": "string",
"valueField": "string",
"textField": "string",
"selectedValue": "string",
"otherSelectedValue": "string",
"existingDataDetails": [{"id": 0,
"name": "string",
"code": "string"
}
],
"groupName": "string",
"orderNumber": 0
}
],
"isIgnoreDuplicate": true,
"processDuplicateStudentId": 0,
"newAssignedAdmissionsRepId": 0,
"effectiveDate": "2019-08-24T14:15:22Z"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"prospectTemplateFieldDetails": [{"controlType": "string",
"controlOption": "string",
"displayName": "string",
"displayFormat": "string",
"propertyName": "string",
"helpText": "string",
"tableName": "string",
"isDefault": true,
"isRequired": true,
"inputMask": "string",
"dataType": "string",
"maxLength": 0,
"decimals": "string",
"minimumRange": "string",
"maximumRange": "string",
"isDataFromOData": true,
"oDataLookUp": "string",
"valueField": "string",
"textField": "string",
"selectedValue": "string",
"otherSelectedValue": "string",
"existingDataDetails": [{"id": 0,
"name": "string",
"code": "string"
}
],
"groupName": "string",
"orderNumber": 0
}
],
"studentEntity": {"isExcludedCrmIntegration": true,
"addressTypeId": 0,
"studentInquiryRequired": true,
"extraCurricularsList": [0
],
"programsList": [0
],
"enrolledProgramIdList": [0
],
"ethnicitiesList": [0
],
"leadSourcesList": [0
],
"deleteVeteranDetails": true,
"vendors": [{"syOrganizationId": 0,
"leadSourceId": 0
}
],
"studentAddressAssociation": 0,
"newAssignedAdmissionsRepId": 0,
"assignedAdmissionsRepReassignedDate": "2019-08-24T14:15:22Z",
"studentRelationshipAddress": {"isPermanentAddress": true,
"isDefaultAddress": true,
"isExcludedCrmIntegration": true,
"id": 0,
"addressBeginDate": "2019-08-24T14:15:22Z",
"addressEndDate": "2019-08-24T14:15:22Z",
"addressTypeId": 0,
"admissionsRegionId": 0,
"city": "string",
"countryId": 0,
"countryName": "string",
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"emailAddress": "string",
"employerName": "string",
"firstName": "string",
"isSeasonalAddress": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"mobileNumber": "string",
"note": "string",
"otherEmailAddress": "string",
"otherPhone": "string",
"phoneNumber": "string",
"plusReferenceNumber": 0,
"postalCode": "string",
"printedOnMasterPromNote": "string",
"printedOnPlusPromNote": "string",
"referenceConfirmed": "string",
"referenceConfirmedDate": "2019-08-24T14:15:22Z",
"referenceNumber": 0,
"relationToStudent": "string",
"rowVersion": "string",
"secondPhoneNumber": "string",
"sourceSystem": "string",
"ssn": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"titleId": 0,
"workPhoneNumber": "string",
"yearsAtAddress": 0,
"yearsKnownStudent": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"lastFourSsn": "string",
"customProperties": ["string"
],
"multiValueCustomProperties": ["string"
],
"originalCustomProperties": ["string"
],
"originalMultiValueCustomProperties": ["string"
],
"originalCustomPropertiesValues": "string",
"originalMultiValueCustomPropertiesValues": "string",
"genderPronounList": [0
],
"overridePrevEducAltPellValidation": true,
"id": 0,
"acgEligReasonCode": "string",
"agencyId": 0,
"alienNumber": "string",
"arAccountStatus": "string",
"arBalance": 0,
"arNextTransactionNumber": { },
"assignedAdmissionsRepId": 0,
"athleticIdentifier": "string",
"bestTimeToContact": "string",
"campusId": 0,
"citizenId": 0,
"city": "string",
"collegeId": 0,
"countryId": 0,
"countyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"cumulativeGpa": 0,
"cumulativeGpaPoints": 0,
"currencyCodeId": 0,
"currentLda": "2019-08-24T14:15:22Z",
"dataBlockIndicator": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"dbiModifiedDate": "2019-08-24T14:15:22Z",
"defaultAddressCode": "string",
"defaultMasterStudentAddressId": 0,
"defaultStudentAddressId": 0,
"disabled": "string",
"driverLicenseNumber": "string",
"driverLicenseState": "string",
"emailAddress": "string",
"employabilityAboutInfo": "string",
"employerId": 0,
"employmentStatusId": 0,
"externalStudentIdentifier": "string",
"extraCurricularActivityId": 0,
"facebookUrl": "string",
"faGradPlusCounselingDate": "2019-08-24T14:15:22Z",
"faRigorousHighSchoolProgramCodeId": 0,
"firstName": "string",
"genderId": 0,
"gpaCredits": 0,
"hispanicLatino": "string",
"hsAcademicGpa": 0,
"instagramUrl": "string",
"isActive": true,
"isAllowedBulkRegistrationByTrack": true,
"isBadAddress": true,
"isBadPhone": true,
"isDdVeteran": true,
"isEftDefaultForStipends": true,
"isInDistrict": true,
"isSscrError11Received": true,
"lastActivityDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lastName": "string",
"lastNameFirstFour": "string",
"lastStatementBeginDate": "2019-08-24T14:15:22Z",
"lastStatementCloseDate": "2019-08-24T14:15:22Z",
"lastStatementDate": "2019-08-24T14:15:22Z",
"leadDate": "2019-08-24T14:15:22Z",
"leadSourceId": 0,
"leadTypeId": 0,
"linkedInUrl": "string",
"maidenName": "string",
"maritalStatusId": 0,
"mi": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"nationalityId": 0,
"nickName": "string",
"niStudent": true,
"note": "string",
"originalAssignedAdmissionsRepId": 0,
"originalExpectedStartDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"otherEmailAddress": "string",
"otherPhoneNumber": "string",
"personId": 0,
"phoneNumber": "string",
"pin": 0,
"postalCode": "string",
"postalCodeFirstThree": "string",
"preferredContactType": "string",
"preferredName": "string",
"previousEducationGpa": 0,
"previousEducationId": 0,
"programGroupId": 0,
"programId": 0,
"rawFirstName": "string",
"rawLastName": "string",
"rawPhoneNumber": "string",
"rowVersion": "string",
"schoolStatusId": 0,
"shiftId": 0,
"smsServiceProviderId": 0,
"sourceSystem": "string",
"ssn": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"statementComment": "string",
"streetAddress": "string",
"streetAddress2": "string",
"studentFullName": "string",
"studentIdentifier": "string",
"studentNumber": "string",
"subscribeToSms": true,
"suffix": "string",
"suffixId": 0,
"titleId": 0,
"twitterUrl": "string",
"veteran": "string",
"workPhoneNumber": "string",
"workPhoneNumberExtension": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"studentList": [{"syStudentId": 0,
"syCampusId": 0,
"sySchoolStatusId": 0,
"amLeadSrcId": 0,
"amLeadTypeId": 0,
"amRepId": 0,
"admRepDescrp": "string",
"firstName": "string",
"lastName": "string",
"mI": "string",
"sSN": "string",
"city": "string",
"state": "string",
"zip": "string",
"phone": "string",
"dOB": "2019-08-24T14:15:22Z",
"drivLic": "string",
"email": "string",
"addr1": "string",
"workPhone": "string",
"campusName": "string",
"leadDate": "2019-08-24T14:15:22Z",
"lastContactDate": "2019-08-24T14:15:22Z"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Set Default Student Label Address

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (common-student-setdefaultstudentlabeladdress-request-payload)

id	number <int32>
defaultAddressCode	string
defaultStudentAddressId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"defaultAddressCode": "string",
"defaultStudentAddressId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Term

Create Term

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"isExcludedCrmIntegration": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"auditDesignationDeadline": "2019-08-24T14:15:22Z",
"campusGroupId": 0,
"code": "string",
"courseRefundPolicyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"faAcademicCalendar": { },
"internalRegistrationBeginDateTime": "2019-08-24T14:15:22Z",
"internalRegistrationEndDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isAttendanceRecorded": true,
"isChildTermDatesRuleEnforced": true,
"isGlobalExtractTerm": true,
"isLdaRetainedUnregisteredCourses": true,
"isOnlineUsageAllowed": true,
"isPrePullRequiredForGlobal": true,
"isSapTerm": true,
"isStandardTerm": { },
"isTermOpen": true,
"isTermSuspendLiftedCampusLinkAmbassador": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"numberOfDaysAfterTermStartDate": 0,
"numberOfDaysPriorToTermStartDate": 0,
"numberOfDaysToRecalcNotification": 0,
"openRegistrationBeginDateTime": "2019-08-24T14:15:22Z",
"openRegistrationEndDateTime": "2019-08-24T14:15:22Z",
"revenueUnits": 0,
"rowVersion": "string",
"sapCalcDaysAfterTermEnd": 0,
"scheduleChangesType": "string",
"sendCourseSectionDataInitialDoneToLms": true,
"sendCourseSectionDataToLms": true,
"sendInstructorAssignmentsInitialDoneToLms": true,
"sendInstructorAssignmentsToLms": true,
"sendStudentRegistrationDataInitialDoneToLms": true,
"sendStudentRegistrationDataToLms": true,
"shiftId": 0,
"standardTermType": "string",
"startDate": "2019-08-24T14:15:22Z",
"studentRegisterEndDate": "2019-08-24T14:15:22Z",
"studentRegisterStartDate": "2019-08-24T14:15:22Z",
"summerHeaderOrTrailer": { },
"termGroupId": 0,
"termUsage": { },
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Term

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-term-delete-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
isExcludedCrmIntegration	boolean
id	number <int32> Id
addDropDate	string <date-time> Add Drop Date
auditDesignationDeadline	string <date-time> Audit Designation Deadline
campusGroupId	number <int32> Campus Group Id
code	string Code
courseRefundPolicyId	number <int32> Course Refund Policy Id
createdDateTime	string <date-time> Created Date Time
endDate	string <date-time> End Date
faAcademicCalendar	object Fa Academic Calendar
internalRegistrationBeginDateTime	string <date-time> Internal Registration Begin Date Time
internalRegistrationEndDateTime	string <date-time> Internal Registration End Date Time
isActive	boolean Is Active
isAttendanceRecorded	boolean Is Attendance Recorded
isChildTermDatesRuleEnforced	boolean Is Child Term Dates Rule Enforced
isGlobalExtractTerm	boolean Is Global Extract Term
isLdaRetainedUnregisteredCourses	boolean Is Lda Retained Unregistered Courses
isOnlineUsageAllowed	boolean Is Online Usage Allowed
isPrePullRequiredForGlobal	boolean Is Pre Pull Required For Global
isSapTerm	boolean Is Sap Term
isStandardTerm	object Is Standard Term
isTermOpen	boolean Is Term Open
isTermSuspendLiftedCampusLinkAmbassador	boolean Is Term Suspend Lifted Campus Link Ambassador
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
name	string Name
numberOfDaysAfterTermStartDate	number <int32> Number Of Days After Term Start Date
numberOfDaysPriorToTermStartDate	number <int32> Number Of Days Prior To Term Start Date
numberOfDaysToRecalcNotification	number <int32> Number Of Days To Recalc Notification
openRegistrationBeginDateTime	string <date-time> Open Registration Begin Date Time
openRegistrationEndDateTime	string <date-time> Open Registration End Date Time
revenueUnits	number <double> Revenue Units
rowVersion	string
sapCalcDaysAfterTermEnd	number <int32> Sap Calc Days After Term End
scheduleChangesType	string Schedule Changes Type
sendCourseSectionDataInitialDoneToLms	boolean Send Course Section Data Initial Done To Lms
sendCourseSectionDataToLms	boolean Send Course Section Data To Lms
sendInstructorAssignmentsInitialDoneToLms	boolean Send Instructor Assignments Initial Done To Lms
sendInstructorAssignmentsToLms	boolean Send Instructor Assignments To Lms
sendStudentRegistrationDataInitialDoneToLms	boolean Send Student Registration Data Initial Done To Lms
sendStudentRegistrationDataToLms	boolean Send Student Registration Data To Lms
shiftId	number <int32> Shift Id
standardTermType	string Standard Term Type
startDate	string <date-time> Start Date
studentRegisterEndDate	string <date-time> Student Register End Date
studentRegisterStartDate	string <date-time> Student Register Start Date
summerHeaderOrTrailer	object Summer Header Or Trailer
termGroupId	number <int32> Term Group Id
termUsage	object Term Usage
	object (cmc-nexus-common-entities-campusGroupEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"isExcludedCrmIntegration": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"auditDesignationDeadline": "2019-08-24T14:15:22Z",
"campusGroupId": 0,
"code": "string",
"courseRefundPolicyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"faAcademicCalendar": { },
"internalRegistrationBeginDateTime": "2019-08-24T14:15:22Z",
"internalRegistrationEndDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isAttendanceRecorded": true,
"isChildTermDatesRuleEnforced": true,
"isGlobalExtractTerm": true,
"isLdaRetainedUnregisteredCourses": true,
"isOnlineUsageAllowed": true,
"isPrePullRequiredForGlobal": true,
"isSapTerm": true,
"isStandardTerm": { },
"isTermOpen": true,
"isTermSuspendLiftedCampusLinkAmbassador": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"numberOfDaysAfterTermStartDate": 0,
"numberOfDaysPriorToTermStartDate": 0,
"numberOfDaysToRecalcNotification": 0,
"openRegistrationBeginDateTime": "2019-08-24T14:15:22Z",
"openRegistrationEndDateTime": "2019-08-24T14:15:22Z",
"revenueUnits": 0,
"rowVersion": "string",
"sapCalcDaysAfterTermEnd": 0,
"scheduleChangesType": "string",
"sendCourseSectionDataInitialDoneToLms": true,
"sendCourseSectionDataToLms": true,
"sendInstructorAssignmentsInitialDoneToLms": true,
"sendInstructorAssignmentsToLms": true,
"sendStudentRegistrationDataInitialDoneToLms": true,
"sendStudentRegistrationDataToLms": true,
"shiftId": 0,
"standardTermType": "string",
"startDate": "2019-08-24T14:15:22Z",
"studentRegisterEndDate": "2019-08-24T14:15:22Z",
"studentRegisterStartDate": "2019-08-24T14:15:22Z",
"summerHeaderOrTrailer": { },
"termGroupId": 0,
"termUsage": { },
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Term

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-term-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"isExcludedCrmIntegration": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"auditDesignationDeadline": "2019-08-24T14:15:22Z",
"campusGroupId": 0,
"code": "string",
"courseRefundPolicyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"faAcademicCalendar": { },
"internalRegistrationBeginDateTime": "2019-08-24T14:15:22Z",
"internalRegistrationEndDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isAttendanceRecorded": true,
"isChildTermDatesRuleEnforced": true,
"isGlobalExtractTerm": true,
"isLdaRetainedUnregisteredCourses": true,
"isOnlineUsageAllowed": true,
"isPrePullRequiredForGlobal": true,
"isSapTerm": true,
"isStandardTerm": { },
"isTermOpen": true,
"isTermSuspendLiftedCampusLinkAmbassador": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"numberOfDaysAfterTermStartDate": 0,
"numberOfDaysPriorToTermStartDate": 0,
"numberOfDaysToRecalcNotification": 0,
"openRegistrationBeginDateTime": "2019-08-24T14:15:22Z",
"openRegistrationEndDateTime": "2019-08-24T14:15:22Z",
"revenueUnits": 0,
"rowVersion": "string",
"sapCalcDaysAfterTermEnd": 0,
"scheduleChangesType": "string",
"sendCourseSectionDataInitialDoneToLms": true,
"sendCourseSectionDataToLms": true,
"sendInstructorAssignmentsInitialDoneToLms": true,
"sendInstructorAssignmentsToLms": true,
"sendStudentRegistrationDataInitialDoneToLms": true,
"sendStudentRegistrationDataToLms": true,
"shiftId": 0,
"standardTermType": "string",
"startDate": "2019-08-24T14:15:22Z",
"studentRegisterEndDate": "2019-08-24T14:15:22Z",
"studentRegisterStartDate": "2019-08-24T14:15:22Z",
"summerHeaderOrTrailer": { },
"termGroupId": 0,
"termUsage": { },
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Term

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-term-save-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
isExcludedCrmIntegration	boolean
id	number <int32> Id
addDropDate	string <date-time> Add Drop Date
auditDesignationDeadline	string <date-time> Audit Designation Deadline
campusGroupId	number <int32> Campus Group Id
code	string Code
courseRefundPolicyId	number <int32> Course Refund Policy Id
createdDateTime	string <date-time> Created Date Time
endDate	string <date-time> End Date
faAcademicCalendar	object Fa Academic Calendar
internalRegistrationBeginDateTime	string <date-time> Internal Registration Begin Date Time
internalRegistrationEndDateTime	string <date-time> Internal Registration End Date Time
isActive	boolean Is Active
isAttendanceRecorded	boolean Is Attendance Recorded
isChildTermDatesRuleEnforced	boolean Is Child Term Dates Rule Enforced
isGlobalExtractTerm	boolean Is Global Extract Term
isLdaRetainedUnregisteredCourses	boolean Is Lda Retained Unregistered Courses
isOnlineUsageAllowed	boolean Is Online Usage Allowed
isPrePullRequiredForGlobal	boolean Is Pre Pull Required For Global
isSapTerm	boolean Is Sap Term
isStandardTerm	object Is Standard Term
isTermOpen	boolean Is Term Open
isTermSuspendLiftedCampusLinkAmbassador	boolean Is Term Suspend Lifted Campus Link Ambassador
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
name	string Name
numberOfDaysAfterTermStartDate	number <int32> Number Of Days After Term Start Date
numberOfDaysPriorToTermStartDate	number <int32> Number Of Days Prior To Term Start Date
numberOfDaysToRecalcNotification	number <int32> Number Of Days To Recalc Notification
openRegistrationBeginDateTime	string <date-time> Open Registration Begin Date Time
openRegistrationEndDateTime	string <date-time> Open Registration End Date Time
revenueUnits	number <double> Revenue Units
rowVersion	string
sapCalcDaysAfterTermEnd	number <int32> Sap Calc Days After Term End
scheduleChangesType	string Schedule Changes Type
sendCourseSectionDataInitialDoneToLms	boolean Send Course Section Data Initial Done To Lms
sendCourseSectionDataToLms	boolean Send Course Section Data To Lms
sendInstructorAssignmentsInitialDoneToLms	boolean Send Instructor Assignments Initial Done To Lms
sendInstructorAssignmentsToLms	boolean Send Instructor Assignments To Lms
sendStudentRegistrationDataInitialDoneToLms	boolean Send Student Registration Data Initial Done To Lms
sendStudentRegistrationDataToLms	boolean Send Student Registration Data To Lms
shiftId	number <int32> Shift Id
standardTermType	string Standard Term Type
startDate	string <date-time> Start Date
studentRegisterEndDate	string <date-time> Student Register End Date
studentRegisterStartDate	string <date-time> Student Register Start Date
summerHeaderOrTrailer	object Summer Header Or Trailer
termGroupId	number <int32> Term Group Id
termUsage	object Term Usage
	object (cmc-nexus-common-entities-campusGroupEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"isExcludedCrmIntegration": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"auditDesignationDeadline": "2019-08-24T14:15:22Z",
"campusGroupId": 0,
"code": "string",
"courseRefundPolicyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"faAcademicCalendar": { },
"internalRegistrationBeginDateTime": "2019-08-24T14:15:22Z",
"internalRegistrationEndDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isAttendanceRecorded": true,
"isChildTermDatesRuleEnforced": true,
"isGlobalExtractTerm": true,
"isLdaRetainedUnregisteredCourses": true,
"isOnlineUsageAllowed": true,
"isPrePullRequiredForGlobal": true,
"isSapTerm": true,
"isStandardTerm": { },
"isTermOpen": true,
"isTermSuspendLiftedCampusLinkAmbassador": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"numberOfDaysAfterTermStartDate": 0,
"numberOfDaysPriorToTermStartDate": 0,
"numberOfDaysToRecalcNotification": 0,
"openRegistrationBeginDateTime": "2019-08-24T14:15:22Z",
"openRegistrationEndDateTime": "2019-08-24T14:15:22Z",
"revenueUnits": 0,
"rowVersion": "string",
"sapCalcDaysAfterTermEnd": 0,
"scheduleChangesType": "string",
"sendCourseSectionDataInitialDoneToLms": true,
"sendCourseSectionDataToLms": true,
"sendInstructorAssignmentsInitialDoneToLms": true,
"sendInstructorAssignmentsToLms": true,
"sendStudentRegistrationDataInitialDoneToLms": true,
"sendStudentRegistrationDataToLms": true,
"shiftId": 0,
"standardTermType": "string",
"startDate": "2019-08-24T14:15:22Z",
"studentRegisterEndDate": "2019-08-24T14:15:22Z",
"studentRegisterStartDate": "2019-08-24T14:15:22Z",
"summerHeaderOrTrailer": { },
"termGroupId": 0,
"termUsage": { },
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"isExcludedCrmIntegration": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"auditDesignationDeadline": "2019-08-24T14:15:22Z",
"campusGroupId": 0,
"code": "string",
"courseRefundPolicyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"faAcademicCalendar": { },
"internalRegistrationBeginDateTime": "2019-08-24T14:15:22Z",
"internalRegistrationEndDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isAttendanceRecorded": true,
"isChildTermDatesRuleEnforced": true,
"isGlobalExtractTerm": true,
"isLdaRetainedUnregisteredCourses": true,
"isOnlineUsageAllowed": true,
"isPrePullRequiredForGlobal": true,
"isSapTerm": true,
"isStandardTerm": { },
"isTermOpen": true,
"isTermSuspendLiftedCampusLinkAmbassador": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"numberOfDaysAfterTermStartDate": 0,
"numberOfDaysPriorToTermStartDate": 0,
"numberOfDaysToRecalcNotification": 0,
"openRegistrationBeginDateTime": "2019-08-24T14:15:22Z",
"openRegistrationEndDateTime": "2019-08-24T14:15:22Z",
"revenueUnits": 0,
"rowVersion": "string",
"sapCalcDaysAfterTermEnd": 0,
"scheduleChangesType": "string",
"sendCourseSectionDataInitialDoneToLms": true,
"sendCourseSectionDataToLms": true,
"sendInstructorAssignmentsInitialDoneToLms": true,
"sendInstructorAssignmentsToLms": true,
"sendStudentRegistrationDataInitialDoneToLms": true,
"sendStudentRegistrationDataToLms": true,
"shiftId": 0,
"standardTermType": "string",
"startDate": "2019-08-24T14:15:22Z",
"studentRegisterEndDate": "2019-08-24T14:15:22Z",
"studentRegisterStartDate": "2019-08-24T14:15:22Z",
"summerHeaderOrTrailer": { },
"termGroupId": 0,
"termUsage": { },
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Term

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-term-savenew-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
isExcludedCrmIntegration	boolean
id	number <int32> Id
addDropDate	string <date-time> Add Drop Date
auditDesignationDeadline	string <date-time> Audit Designation Deadline
campusGroupId	number <int32> Campus Group Id
code	string Code
courseRefundPolicyId	number <int32> Course Refund Policy Id
createdDateTime	string <date-time> Created Date Time
endDate	string <date-time> End Date
faAcademicCalendar	object Fa Academic Calendar
internalRegistrationBeginDateTime	string <date-time> Internal Registration Begin Date Time
internalRegistrationEndDateTime	string <date-time> Internal Registration End Date Time
isActive	boolean Is Active
isAttendanceRecorded	boolean Is Attendance Recorded
isChildTermDatesRuleEnforced	boolean Is Child Term Dates Rule Enforced
isGlobalExtractTerm	boolean Is Global Extract Term
isLdaRetainedUnregisteredCourses	boolean Is Lda Retained Unregistered Courses
isOnlineUsageAllowed	boolean Is Online Usage Allowed
isPrePullRequiredForGlobal	boolean Is Pre Pull Required For Global
isSapTerm	boolean Is Sap Term
isStandardTerm	object Is Standard Term
isTermOpen	boolean Is Term Open
isTermSuspendLiftedCampusLinkAmbassador	boolean Is Term Suspend Lifted Campus Link Ambassador
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
name	string Name
numberOfDaysAfterTermStartDate	number <int32> Number Of Days After Term Start Date
numberOfDaysPriorToTermStartDate	number <int32> Number Of Days Prior To Term Start Date
numberOfDaysToRecalcNotification	number <int32> Number Of Days To Recalc Notification
openRegistrationBeginDateTime	string <date-time> Open Registration Begin Date Time
openRegistrationEndDateTime	string <date-time> Open Registration End Date Time
revenueUnits	number <double> Revenue Units
rowVersion	string
sapCalcDaysAfterTermEnd	number <int32> Sap Calc Days After Term End
scheduleChangesType	string Schedule Changes Type
sendCourseSectionDataInitialDoneToLms	boolean Send Course Section Data Initial Done To Lms
sendCourseSectionDataToLms	boolean Send Course Section Data To Lms
sendInstructorAssignmentsInitialDoneToLms	boolean Send Instructor Assignments Initial Done To Lms
sendInstructorAssignmentsToLms	boolean Send Instructor Assignments To Lms
sendStudentRegistrationDataInitialDoneToLms	boolean Send Student Registration Data Initial Done To Lms
sendStudentRegistrationDataToLms	boolean Send Student Registration Data To Lms
shiftId	number <int32> Shift Id
standardTermType	string Standard Term Type
startDate	string <date-time> Start Date
studentRegisterEndDate	string <date-time> Student Register End Date
studentRegisterStartDate	string <date-time> Student Register Start Date
summerHeaderOrTrailer	object Summer Header Or Trailer
termGroupId	number <int32> Term Group Id
termUsage	object Term Usage
	object (cmc-nexus-common-entities-campusGroupEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"isExcludedCrmIntegration": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"auditDesignationDeadline": "2019-08-24T14:15:22Z",
"campusGroupId": 0,
"code": "string",
"courseRefundPolicyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"faAcademicCalendar": { },
"internalRegistrationBeginDateTime": "2019-08-24T14:15:22Z",
"internalRegistrationEndDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isAttendanceRecorded": true,
"isChildTermDatesRuleEnforced": true,
"isGlobalExtractTerm": true,
"isLdaRetainedUnregisteredCourses": true,
"isOnlineUsageAllowed": true,
"isPrePullRequiredForGlobal": true,
"isSapTerm": true,
"isStandardTerm": { },
"isTermOpen": true,
"isTermSuspendLiftedCampusLinkAmbassador": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"numberOfDaysAfterTermStartDate": 0,
"numberOfDaysPriorToTermStartDate": 0,
"numberOfDaysToRecalcNotification": 0,
"openRegistrationBeginDateTime": "2019-08-24T14:15:22Z",
"openRegistrationEndDateTime": "2019-08-24T14:15:22Z",
"revenueUnits": 0,
"rowVersion": "string",
"sapCalcDaysAfterTermEnd": 0,
"scheduleChangesType": "string",
"sendCourseSectionDataInitialDoneToLms": true,
"sendCourseSectionDataToLms": true,
"sendInstructorAssignmentsInitialDoneToLms": true,
"sendInstructorAssignmentsToLms": true,
"sendStudentRegistrationDataInitialDoneToLms": true,
"sendStudentRegistrationDataToLms": true,
"shiftId": 0,
"standardTermType": "string",
"startDate": "2019-08-24T14:15:22Z",
"studentRegisterEndDate": "2019-08-24T14:15:22Z",
"studentRegisterStartDate": "2019-08-24T14:15:22Z",
"summerHeaderOrTrailer": { },
"termGroupId": 0,
"termUsage": { },
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"isExcludedCrmIntegration": true,
"id": 0,
"addDropDate": "2019-08-24T14:15:22Z",
"auditDesignationDeadline": "2019-08-24T14:15:22Z",
"campusGroupId": 0,
"code": "string",
"courseRefundPolicyId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"faAcademicCalendar": { },
"internalRegistrationBeginDateTime": "2019-08-24T14:15:22Z",
"internalRegistrationEndDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isAttendanceRecorded": true,
"isChildTermDatesRuleEnforced": true,
"isGlobalExtractTerm": true,
"isLdaRetainedUnregisteredCourses": true,
"isOnlineUsageAllowed": true,
"isPrePullRequiredForGlobal": true,
"isSapTerm": true,
"isStandardTerm": { },
"isTermOpen": true,
"isTermSuspendLiftedCampusLinkAmbassador": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"numberOfDaysAfterTermStartDate": 0,
"numberOfDaysPriorToTermStartDate": 0,
"numberOfDaysToRecalcNotification": 0,
"openRegistrationBeginDateTime": "2019-08-24T14:15:22Z",
"openRegistrationEndDateTime": "2019-08-24T14:15:22Z",
"revenueUnits": 0,
"rowVersion": "string",
"sapCalcDaysAfterTermEnd": 0,
"scheduleChangesType": "string",
"sendCourseSectionDataInitialDoneToLms": true,
"sendCourseSectionDataToLms": true,
"sendInstructorAssignmentsInitialDoneToLms": true,
"sendInstructorAssignmentsToLms": true,
"sendStudentRegistrationDataInitialDoneToLms": true,
"sendStudentRegistrationDataToLms": true,
"shiftId": 0,
"standardTermType": "string",
"startDate": "2019-08-24T14:15:22Z",
"studentRegisterEndDate": "2019-08-24T14:15:22Z",
"studentRegisterStartDate": "2019-08-24T14:15:22Z",
"summerHeaderOrTrailer": { },
"termGroupId": 0,
"termUsage": { },
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Term Status

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (academics-term-savetermstatus-request-payload)

termIdList	Array of numbers <int32> [ items <int32 > ]
isTermOpen	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"termIdList": [0
],
"isTermOpen": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}