GET api/Students/{SchoolYear}/{StudentId}/StudentPeriodAttendance
Returns the Student Period Attendance for a Student.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
SchoolYear |
Numeric Value of the School Year (i.e. 2018 for the 2017-2018 School Year) |
integer |
Required |
StudentId |
Application identifier for the Student |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of StudentPeriodAttendance objects for the specified SchoolYear and StudentId
Collection of StudentPeriodAttendanceName | Description | Type | Additional information |
---|---|---|---|
StudentId |
The application identifier of the Student for the Attendance. |
globally unique identifier |
None. |
AttendanceDate |
The date for the Attendance. |
date |
None. |
AttendanceCodeUid |
The Attendance Code user identifier for the Attendance. |
string |
None. |
AttendanceCodeDescription |
The Attendance Code description for the Attendance. |
string |
None. |
PeriodName |
The period name for the Attendance. |
string |
None. |
IsAbsent |
The indicator for whether the Attendance is counted as an absence to the register. |
boolean |
None. |
IsActivity |
The indicator for whether the Attendance is counted as an activity absence. |
boolean |
None. |
IsTardy |
The indicator for whether the Attendance is counted as a tardy. |
boolean |
None. |
IsExcused |
The indicator for whether the Attendance is excused. |
boolean |
None. |
DataVersion |
The version of the API data |
string |
None. |
ApiName |
The name of the object without the Api suffix |
string |
None. |
Response Formats
application/json, text/json
[ { "StudentId": "4b8b99ce-7f8d-4af2-bf07-e90fdc9259e2", "AttendanceDate": "2025-04-26T00:02:26.69535-05:00", "AttendanceCodeUid": "sample string 3", "AttendanceCodeDescription": "sample string 4", "PeriodName": "sample string 5", "IsAbsent": true, "IsActivity": true, "IsTardy": true, "IsExcused": true, "DataVersion": "sample string 10", "ApiName": "" }, { "StudentId": "4b8b99ce-7f8d-4af2-bf07-e90fdc9259e2", "AttendanceDate": "2025-04-26T00:02:26.69535-05:00", "AttendanceCodeUid": "sample string 3", "AttendanceCodeDescription": "sample string 4", "PeriodName": "sample string 5", "IsAbsent": true, "IsActivity": true, "IsTardy": true, "IsExcused": true, "DataVersion": "sample string 10", "ApiName": "" } ]
application/xml, text/xml
<ArrayOfStudentPeriodAttendance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi.v1"> <StudentPeriodAttendance> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 10</DataVersion> <AttendanceCodeDescription>sample string 4</AttendanceCodeDescription> <AttendanceCodeUid>sample string 3</AttendanceCodeUid> <AttendanceDate>2025-04-26T00:02:26.69535-05:00</AttendanceDate> <IsAbsent>true</IsAbsent> <IsActivity>true</IsActivity> <IsExcused>true</IsExcused> <IsTardy>true</IsTardy> <PeriodName>sample string 5</PeriodName> <StudentId>4b8b99ce-7f8d-4af2-bf07-e90fdc9259e2</StudentId> </StudentPeriodAttendance> <StudentPeriodAttendance> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 10</DataVersion> <AttendanceCodeDescription>sample string 4</AttendanceCodeDescription> <AttendanceCodeUid>sample string 3</AttendanceCodeUid> <AttendanceDate>2025-04-26T00:02:26.69535-05:00</AttendanceDate> <IsAbsent>true</IsAbsent> <IsActivity>true</IsActivity> <IsExcused>true</IsExcused> <IsTardy>true</IsTardy> <PeriodName>sample string 5</PeriodName> <StudentId>4b8b99ce-7f8d-4af2-bf07-e90fdc9259e2</StudentId> </StudentPeriodAttendance> </ArrayOfStudentPeriodAttendance>