NAV
shell ruby python csharp php

CourseAttendance

The CourseAttendance object

The CourseAttendance object looks like this in JSON:

{
    "object": "course_attendance",
    "id": 5,
    "student_id": 12,
    "course_meeting_id": 2,
    "status": "present",
    "present_coef": 1,
    "note": null,
    "kiosk_id": null,
    "beacon_id": null,
    "device_id": null,
    "beacon_found_at": null,
    "attendance_hours": null,
    "clinical_hours": null,
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}
Attribute Required Data Type
id Yes int
student_id Yes int
course_meeting_id Yes int
status Yes enum (present, tardy, absent, excused)
present_coef Yes decimal
note No text
kiosk_id No int
beacon_id No int
device_id No int
beacon_found_at No datetime
attendance_hours No decimal
clinical_hours No decimal
added_at No datetime
added_by_id No int
sandbox No bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/attendance/detail" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "filter": []
}' \ 
require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/attendance/detail',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body
import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/attendance/detail',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/attendance/detail"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/attendance/detail');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": 200,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "person",
            "id": 12,
            "first_name": "Alice",
            "last_name": "Admin",
            "middle_name": null,
            "prefix": "Mrs.",
            "suffix": null,
            "preferred_name": null,
            "display_name": "Alice Admin",
            "salutation": "Mrs. Alice Admin",
            "addressee": "Mrs. Alice Admin",
            "gender": "female",
            "other_gender": null,
            "image_file_id": null,
            "birth_date": null,
            "status": "active",
            "social_security_number": null,
            "alien_registration_number": null,
            "social_insurance_number": null,
            "home_city": null,
            "home_state": null,
            "home_country": null,
            "former_name": null,
            "license_plate": null,
            "bio": null,
            "hispanic_latino": false,
            "resident_alien": false,
            "localization_id": null,
            "notification_email_id": null,
            "deceased_date": null,
            "import_id": null,
            "staff_id": null,
            "faculty_id": null,
            "degree_level_id": null,
            "added_at": null,
            "added_by_id": null,
            "updated_at": null,
            "report_data": {
                "dummy_id": "20220xx002",
                "academic_term_id": 8,
                "term_name": "Spring 2010 2009-2010",
                "course_offering_id": 21910,
                "course_name": "LAT101-1: Beginning Latin I",
                "meeting_summary": "Main class",
                "meeting_start_time": "2022-10-01 01:00:00",
                "meeting_end_time": "2022-10-01 02:30:00",
                "attendance_status": "PRESENT",
                "attendance_method": "",
                "attendance_note": null,
                "attendance_added_at": null,
                "attendance_added_by": null,
                "row_id": "12_3"
            },
            "private_profile": false,
            "is_user": true
        }
    ],
    "sandbox": true
}

Retrieves all CourseAttendance objects that match given filter conditions.

HTTP Request

GET /attendance/detail

Parameters

Name Required Data Type Description
filter No mixed See available filter conditions
page No int The page of results to return if more than 200 records are found.

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name Type
student object_id
student_course_status enum
has_active_student_role enum (yes, no)
student_program object id
student_campus object id
academic_term object_id
academic_term_type academic_term_type
academic_year object id
course object_id
catalog_course object_id
primary_faculty object id
event_start_time datetime
method choice
status choice
tag tag

Permissions

One of the following roles is required to call this method: