GET api/{version}/Students/GetStudentClassScheduleNotes?registrationId={registrationId}
This get method gets all the available class schedule notes to display above and below the schedule details for student class schedules
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| registrationId | integer |
Required |
|
| version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
StudentClassScheduleNotes| Name | Description | Type | Additional information |
|---|---|---|---|
| TopPeriodCenterNotes |
Gets or sets the period center notes to show above the schedule table in student registration. |
Collection of ScheduleNote |
None. |
| BottomPeriodCenterNotes |
Gets or sets the period center notes to show below the schedule table in student registration. |
Collection of ScheduleNote |
None. |
| TopCenterNotes |
Gets or sets the center notes to show above the schedule table in student registration. |
Collection of ScheduleNote |
None. |
| BottomCenterNotes |
Gets or sets the center notes to show below the schedule table and below the bottome period center notes in student registration. |
Collection of ScheduleNote |
None. |
Response Formats
application/json, text/json
Sample:
{
"TopPeriodCenterNotes": [
{
"NoteId": 1,
"PeriodId": 2,
"CourseId": 3,
"CenterId": 4,
"Notes": "sample string 5",
"Sequence": 6,
"Position": 7,
"Display": true,
"Title": "sample string 9",
"DisplayMode": "sample string 10",
"NotesType": "sample string 11"
},
{
"NoteId": 1,
"PeriodId": 2,
"CourseId": 3,
"CenterId": 4,
"Notes": "sample string 5",
"Sequence": 6,
"Position": 7,
"Display": true,
"Title": "sample string 9",
"DisplayMode": "sample string 10",
"NotesType": "sample string 11"
}
],
"BottomPeriodCenterNotes": [
{
"NoteId": 1,
"PeriodId": 2,
"CourseId": 3,
"CenterId": 4,
"Notes": "sample string 5",
"Sequence": 6,
"Position": 7,
"Display": true,
"Title": "sample string 9",
"DisplayMode": "sample string 10",
"NotesType": "sample string 11"
},
{
"NoteId": 1,
"PeriodId": 2,
"CourseId": 3,
"CenterId": 4,
"Notes": "sample string 5",
"Sequence": 6,
"Position": 7,
"Display": true,
"Title": "sample string 9",
"DisplayMode": "sample string 10",
"NotesType": "sample string 11"
}
],
"TopCenterNotes": [
{
"NoteId": 1,
"PeriodId": 2,
"CourseId": 3,
"CenterId": 4,
"Notes": "sample string 5",
"Sequence": 6,
"Position": 7,
"Display": true,
"Title": "sample string 9",
"DisplayMode": "sample string 10",
"NotesType": "sample string 11"
},
{
"NoteId": 1,
"PeriodId": 2,
"CourseId": 3,
"CenterId": 4,
"Notes": "sample string 5",
"Sequence": 6,
"Position": 7,
"Display": true,
"Title": "sample string 9",
"DisplayMode": "sample string 10",
"NotesType": "sample string 11"
}
],
"BottomCenterNotes": [
{
"NoteId": 1,
"PeriodId": 2,
"CourseId": 3,
"CenterId": 4,
"Notes": "sample string 5",
"Sequence": 6,
"Position": 7,
"Display": true,
"Title": "sample string 9",
"DisplayMode": "sample string 10",
"NotesType": "sample string 11"
},
{
"NoteId": 1,
"PeriodId": 2,
"CourseId": 3,
"CenterId": 4,
"Notes": "sample string 5",
"Sequence": 6,
"Position": 7,
"Display": true,
"Title": "sample string 9",
"DisplayMode": "sample string 10",
"NotesType": "sample string 11"
}
]
}