GET api/Sites/{SiteId}/StudentPeriodAttendance

Returns the Student Period Attendance for a Site.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SiteId

Application identifier for the Site

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of StudentPeriodAttendance objects for the specified SiteId

Collection of StudentPeriodAttendance
NameDescriptionTypeAdditional 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

Sample:
[
  {
    "StudentId": "2ed49bdf-ce73-4d99-a36a-c2799ead62db",
    "AttendanceDate": "2025-04-26T00:14:53.0101303-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": "2ed49bdf-ce73-4d99-a36a-c2799ead62db",
    "AttendanceDate": "2025-04-26T00:14:53.0101303-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

Sample:
<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:14:53.0101303-05:00</AttendanceDate>
    <IsAbsent>true</IsAbsent>
    <IsActivity>true</IsActivity>
    <IsExcused>true</IsExcused>
    <IsTardy>true</IsTardy>
    <PeriodName>sample string 5</PeriodName>
    <StudentId>2ed49bdf-ce73-4d99-a36a-c2799ead62db</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:14:53.0101303-05:00</AttendanceDate>
    <IsAbsent>true</IsAbsent>
    <IsActivity>true</IsActivity>
    <IsExcused>true</IsExcused>
    <IsTardy>true</IsTardy>
    <PeriodName>sample string 5</PeriodName>
    <StudentId>2ed49bdf-ce73-4d99-a36a-c2799ead62db</StudentId>
  </StudentPeriodAttendance>
</ArrayOfStudentPeriodAttendance>