AcademicTerm

The AcademicTerm object

The AcademicTerm object looks like this in JSON:

{
    "object": "academic_term",
    "id": 8,
    "academic_year_id": 4,
    "name": "Spring 2010",
    "display_name": "Spring 2010 2009-2010",
    "start_date": "2010-02-01",
    "end_date": "2010-05-15",
    "grades_date": "2010-05-10",
    "add_drop_time": "2010-02-15T00:00:00+00:00",
    "enrollment_start_time": "2010-01-01T00:00:00+00:00",
    "enrollment_end_time": null,
    "max_enrolled_credits": null,
    "max_enrolled_hours": null,
    "max_audit_credits": null,
    "max_audit_hours": null,
    "can_overlap_dates": false,
    "level": "single",
    "academic_term_type_id": null,
    "is_for_transcript": true,
    "is_for_billing": true,
    "is_for_campus_life": true,
    "is_entrance_term": true,
    "evaluations_available_from": null,
    "evaluations_available_to": null,
    "evaluations_lock_grades_at": null,
    "online_registration_delay_until": null,
    "online_registration_randomization_seconds": 0,
    "evaluations_lock_grades_until": null,
    "evaluations_available_to_faculty": null,
    "lms_sync": null,
    "external_id": null,
    "start_year": 2009,
    "end_year": 2010,
    "added_at": null,
    "added_by_id": null,
    "type": "standard",
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
academic_year_id	Yes	int
name	Yes	text (255)
display_name	Yes	text (200)
start_date	Yes	date
end_date	Yes	date
grades_date	Yes	date
add_drop_time	Yes	datetime
enrollment_start_time	No	datetime
enrollment_end_time	No	datetime
max_enrolled_credits	No	decimal
max_enrolled_hours	No	decimal
max_audit_credits	No	decimal
max_audit_hours	No	decimal
can_overlap_dates	Yes	bool
level	Yes	enum (single, super, sub)
academic_term_type_id	No	int
is_for_transcript	Yes	bool
is_for_billing	Yes	bool
is_for_campus_life	Yes	bool
is_entrance_term	Yes	bool
evaluations_available_from	No	datetime
evaluations_available_to	No	datetime
evaluations_lock_grades_at	No	datetime
online_registration_delay_until	No	datetime
online_registration_randomization_seconds	Yes	int
evaluations_lock_grades_until	No	datetime
evaluations_available_to_faculty	No	enum (not_available, available_after_60_percent_completion, available_after_60_percent_completion_and_course_finalized)
lms_sync	No	enum (none, canvas, brightspace)
external_id	No	text (100)
start_year	No	int
end_year	No	int
added_at	No	datetime
added_by_id	No	int
type	No	text
sandbox	No	bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/academicterms" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/academicterms',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/academicterms',
 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/academicterms"), 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/academicterms');
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": 8,
    "results": 8,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "academic_term",
            "id": 8,
            "academic_year_id": 4,
            "name": "Spring 2010",
            "display_name": "Spring 2010 2009-2010",
            "start_date": "2010-02-01",
            "end_date": "2010-05-15",
            "grades_date": "2010-05-10",
            "add_drop_time": "2010-02-15T00:00:00+00:00",
            "enrollment_start_time": "2010-01-01T00:00:00+00:00",
            "enrollment_end_time": null,
            "max_enrolled_credits": null,
            "max_enrolled_hours": null,
            "max_audit_credits": null,
            "max_audit_hours": null,
            "can_overlap_dates": false,
            "level": "single",
            "academic_term_type_id": null,
            "is_for_transcript": true,
            "is_for_billing": true,
            "is_for_campus_life": true,
            "is_entrance_term": true,
            "evaluations_available_from": null,
            "evaluations_available_to": null,
            "evaluations_lock_grades_at": null,
            "online_registration_delay_until": null,
            "online_registration_randomization_seconds": 0,
            "evaluations_lock_grades_until": null,
            "evaluations_available_to_faculty": null,
            "lms_sync": null,
            "external_id": null,
            "start_year": 2009,
            "end_year": 2010,
            "added_at": null,
            "added_by_id": null,
            "type": "standard"
        }
    ],
    "sandbox": true
}

Retrieves all AcademicTerm objects.

HTTP Request

GET /academicterms

Parameters

None

Expandable Properties

academic_year
enrollment_periods
subterms

Permissions

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

Academic Auditor
Academic Auditor
Academic Admin
Registrar

show

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/academicterms/(academicterm)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/academicterms/(academicterm)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/academicterms/(academicterm)',
 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/academicterms/(academicterm)"), 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/academicterms/(academicterm)');
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": "academic_term",
    "id": 8,
    "academic_year_id": 4,
    "name": "Spring 2010",
    "display_name": "Spring 2010 2009-2010",
    "start_date": "2010-02-01",
    "end_date": "2010-05-15",
    "grades_date": "2010-05-10",
    "add_drop_time": "2010-02-15T00:00:00+00:00",
    "enrollment_start_time": "2010-01-01T00:00:00+00:00",
    "enrollment_end_time": null,
    "max_enrolled_credits": null,
    "max_enrolled_hours": null,
    "max_audit_credits": null,
    "max_audit_hours": null,
    "can_overlap_dates": false,
    "level": "single",
    "academic_term_type_id": null,
    "is_for_transcript": true,
    "is_for_billing": true,
    "is_for_campus_life": true,
    "is_entrance_term": true,
    "evaluations_available_from": null,
    "evaluations_available_to": null,
    "evaluations_lock_grades_at": null,
    "online_registration_delay_until": null,
    "online_registration_randomization_seconds": 0,
    "evaluations_lock_grades_until": null,
    "evaluations_available_to_faculty": null,
    "lms_sync": null,
    "external_id": null,
    "start_year": 2009,
    "end_year": 2010,
    "added_at": null,
    "added_by_id": null,
    "type": "standard",
    "sandbox": true
}

Retrieves a specific AcademicTerm object.

HTTP Request

GET /academicterms/(academicterm)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Expandable Properties

academic_year
enrollment_periods
subterms

Permissions

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

Academic Auditor
Academic Auditor
Academic Admin
Registrar

academicprogress

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/academicterms/(academicterm)/academicprogress" \
-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/academicterms/(academicterm)/academicprogress',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/academicterms/(academicterm)/academicprogress',
 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/academicterms/(academicterm)/academicprogress"), 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/academicterms/(academicterm)/academicprogress');
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": 0,
    "results": 0,
    "results_per_page": 200,
    "pages": 0,
    "page": 0,
    "offset": 0,
    "has_more": false,
    "data": [],
    "sandbox": true
}

Returns the equivalent of the Financial Aid Academic Progress Report.

HTTP Request

GET /academicterms/(academicterm)/academicprogress

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.

Expandable Properties

academic_year
enrollment_periods
subterms

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name	Type
student	object_id
has_aid	bool
sap	choice
can_appeal	bool
under_academic_discipline	bool
program	object id
degree	object id
attendance	choice
last_attendance	date
term_gpa	decimal
term_gpa_including_transfer	decimal
cum_gpa	decimal
cum_gpa_including_transfer	decimal
cum_units_attempted_including_transfer	decimal
cum_units_earned_including_transfer	decimal
completion_percent	integer
campus	object id
classification	object id
tag	tag
custom_field	custom

Permissions

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

Financial Aid

billing

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/academicterms/(academicterm)/billing" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "filter": {"0":{"logic":"ALL","fields":[{"name":"total_charges","value":{"type":"RANGE","start":"10.5","end":"900.15"},"positive":1}]}}
}' \

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/academicterms/(academicterm)/billing',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/academicterms/(academicterm)/billing',
 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/academicterms/(academicterm)/billing"), 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/academicterms/(academicterm)/billing');
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": 2,
    "results": 2,
    "results_per_page": 0,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "person",
            "id": 16,
            "first_name": "Abby",
            "last_name": "Admin",
            "middle_name": null,
            "prefix": null,
            "suffix": null,
            "preferred_name": null,
            "display_name": "Abby Admin",
            "salutation": "Abby Admin",
            "addressee": "Abby 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": {
                "studentid": 16,
                "dummyid": "20220xx001",
                "enrollment_agreements_signed": "0",
                "enrollment_agreements_unsigned": "0",
                "tuition": "0.00",
                "fees": "0.00",
                "room_plan": "0.00",
                "meal_plan": "0.00",
                "bookstore": "0.00",
                "pending_and_invoices_total_charges": "0.00",
                "grants": "3644.90",
                "loans": "0.00",
                "total_aid": "3644.90",
                "schedule_names": null,
                "schedule_ids": null,
                "fees_and_bookstore": "0.00",
                "room_and_meal_plan": "0.00",
                "charges_less_exp_aid": "-3644.90",
                "row_id": 16
            },
            "private_profile": false,
            "is_user": true
        }
    ],
    "sandbox": true
}

Returns a variety of collected individual student billing information for a specified term.

HTTP Request

GET /academicterms/(academicterm)/billing

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.

Expandable Properties

academic_year
enrollment_periods
subterms

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name	Type
tuition_schedule	object id
tuition	decimal
fees_and_bookstore	decimal
room_and_board	decimal
total_charges	decimal
expected_aid	decimal
charges_less_expected_aid	decimal
student_campus	object id
invoice_posted_date	date
term_amount_due	decimal
enrollment_agreement_status	enrollmentagreementstatus
tag	tag
custom_field	custom

Permissions

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

Financial Admin
Student Billing

courseofferings

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/academicterms/(academicterm)/courseofferings" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "filter": {"0":{"logic":"ALL","fields":[{"name":"enrolled","value":{"type":"RANGE","start":"1","end":"9"},"positive":1}]}}
}' \

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/academicterms/(academicterm)/courseofferings',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/academicterms/(academicterm)/courseofferings',
 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/academicterms/(academicterm)/courseofferings"), 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/academicterms/(academicterm)/courseofferings');
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": "course_offering",
            "id": 21910,
            "academic_term_id": 8,
            "campus_id": null,
            "finalized": false,
            "finalized_at": null,
            "max_enrolled": null,
            "max_auditors": null,
            "roster_visibility": true,
            "start_date": "2022-05-20",
            "end_date": "2022-10-08",
            "add_drop_time": null,
            "published": true,
            "open_to_students_date": "2022-05-20",
            "closed_to_students_date": "2022-10-08",
            "faculty_can_manage_roster": false,
            "faculty_can_override_enrollment": false,
            "students_can_add_discussions": true,
            "disable_student_bulletin_board_posts": false,
            "allow_auditor_assignments": false,
            "allow_auditor_attendance": false,
            "allow_auditor_evaluations": false,
            "waiting_list_management": "automatic",
            "image_file_id": null,
            "report_data": {
                "course_offering_catalog_course_id": 40,
                "name": "Beginning Latin I",
                "description": "",
                "catalog_course_id": 688,
                "section": "1",
                "credits": "2.00",
                "hours": "2.00",
                "pass_fail": 0,
                "attendance_hours": "0.00",
                "enable_clinical_hours": 0,
                "clinical_hours": "0.00",
                "fulfills_program_requirements": 1,
                "affects_standing": 1,
                "affects_full_time_status": 1,
                "pass_affects_gpa": 1,
                "fail_affects_gpa": 1,
                "pass_fail_pass_affects_gpa": 1,
                "pass_fail_fail_affects_gpa": 1,
                "course_abbrv": "LAT101",
                "department_name": "Undergraduate",
                "campus_name": null,
                "num_finalized_students": "0",
                "num_students": "2",
                "num_auditors": "0",
                "num_incomplete": "0",
                "num_withdrawn": "0",
                "num_waiting": 1,
                "primary_faculty_id": null,
                "primary_faculty_display_name": null,
                "primary_faculty_first_name": null,
                "primary_faculty_last_name": null,
                "other_faculty_ids": null,
                "other_faculty": null,
                "teaching_assistants": null,
                "primary_faculty_email_address": null,
                "other_faculty_email_addresses": null,
                "teaching_assistant_email_addresses": null,
                "add_drop_time_local": "2010-02-14 16:00:00",
                "department_id": 1,
                "program_name_ids": null,
                "hide_self_register": 0,
                "self_enroll": "YES",
                "self_audit": 1,
                "course_books": null,
                "course_links": null,
                "delivery_method_ids": null,
                "delivery_method_names": null,
                "primary_delivery_method_id": null,
                "primary_delivery_method_name": null,
                "has_course_evaluation": 0,
                "num_course_evaluation_completions": "0",
                "row_id": 40
            },
            "show_progress_to_students": false,
            "catalog_courses": [
                {
                    "object": "catalog_course",
                    "id": 40,
                    "course_offering_id": 21910,
                    "catalog_course_id": 688,
                    "primary": true,
                    "abbrv": "LAT101",
                    "name": "Beginning Latin I",
                    "description": null,
                    "section": "1",
                    "credits": 2,
                    "hours": 2,
                    "attendance_hours": 0,
                    "clinical_hours": 0,
                    "affects_standing": true,
                    "affects_full_time_status": true,
                    "pass_fail": false,
                    "pass_affects_gpa": true,
                    "fail_affects_gpa": true,
                    "pass_fail_pass_affects_gpa": true,
                    "pass_fail_fail_affects_gpa": true,
                    "fulfills_program_requirements": true,
                    "minimum_attendance": null,
                    "hide_self_register": false,
                    "self_enroll": "yes",
                    "self_audit": true,
                    "delivery_methods": [],
                    "added_at": null,
                    "added_by_id": null
                }
            ]
        }
    ],
    "sandbox": true
}

HTTP Request

GET /academicterms/(academicterm)/courseofferings

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.

Expandable Properties

academic_year
enrollment_periods
subterms

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name	Type
auditors	integer
enrolled	integer
incomplete	integer
waiting	integer
withdrawn	integer
campus	object id
course_group	course_group
delivery_method	object id
department	object id
finalized	bool
instructor	object_id
max_auditors	enrollment
max_enrolled	enrollment
pass_fail	bool
program	object id
published	bool
section	alphanumeric
self_audit	bool
self_enroll	choice
show_self_register	bool

Permissions

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

Academic Auditor
Academic Admin
Registrar

enrollments

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/academicterms/(academicterm)/enrollments" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "filter": {"0":{"logic":"ALL","fields":[{"name":"finalized","value":"YES","positive":1}]}}
}' \

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/academicterms/(academicterm)/enrollments',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/academicterms/(academicterm)/enrollments',
 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/academicterms/(academicterm)/enrollments"), 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/academicterms/(academicterm)/enrollments');
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": 2,
    "results": 2,
    "results_per_page": 200,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "person",
            "id": 16,
            "first_name": "Abby",
            "last_name": "Admin",
            "middle_name": null,
            "prefix": null,
            "suffix": null,
            "preferred_name": null,
            "display_name": "Abby Admin",
            "salutation": "Abby Admin",
            "addressee": "Abby 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": {
                "student_person_id": 16,
                "student_name": "Abby Admin",
                "academic_term_id": 8,
                "academic_term_name": "Spring 2010 2009-2010",
                "catalog_course_abbrv": "LAT101",
                "course_offering_id": 21910,
                "full_course_offering_name": "LAT101-1: Beginning Latin I",
                "course_student_status": "ENROLLED",
                "status_mapid": null,
                "status_map_abbrv": null,
                "programid": 0,
                "program_name": null,
                "grade_abbrv": null,
                "grade": "91.50",
                "delivery_method": null,
                "enrollment_id": 6000002,
                "course_offering_student_program_id": null,
                "pass_fail": 0,
                "student_middle_name": "",
                "student_preferred_name": "",
                "academic_term_start_date": "2010-02-01",
                "visible_student_id": "20220xx001",
                "course_campus_id": null,
                "academic_term_end_date": "2010-05-15",
                "student_first_name": "Abby",
                "student_last_name": "Admin",
                "course_offering_section": "1",
                "course_offering_name": "Beginning Latin I",
                "credits": "2.00",
                "hours": "2.00",
                "retake": null,
                "course_campus_name": null,
                "finalized": 0,
                "program_units": "CREDITS",
                "catalog_course_id": 688,
                "row_id": "16_0_21910"
            },
            "private_profile": false,
            "is_user": true
        }
    ],
    "sandbox": true
}

HTTP Request

GET /academicterms/(academicterm)/enrollments

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.

Expandable Properties

academic_year
enrollment_periods
subterms

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name	Type
academic_year	object id
added_at	datetime
advisor	advisor
age	integer
automatically_removed_at	datetime
automatically_removed_from	enum
billing_term	object_id
catalog_course	object_id
course	object_id
course_affects_standing	bool
course_campus	object id
course_delivery_method	object id
course_department	object id
course_end_date	date
course_faculty	object id
course_has_been_retaken	bool
course_section	alphanumeric
course_start_date	date
academic_term	object_id
credits	decimal
custom_field	custom
degree	object id
degree_level	choice
degree_seeking	bool
enrolled_by	object_id
enrollment_date	date
final_attendance	decimal
finalized	bool
finalized_at	datetime
first_time	bool
full_time	bool
gender	enum (male, female, unknown, other)
grade	decimal
has_active_student_role	enum (yes, no)
hours	decimal
include_deleted_students	bool
include_dropped_students	bool
include_waitlisted_students	bool
last_attendance	datetime
letter	text
pass_fail	bool
pay_period_end_date	date
pay_period_start_date	date
program	object id
race_ethnicity	object id
specialization	specialization
standing	academicstanding
status	enum
status_date	date
student	object_id
students_campus	object id
tag	tag
term_end_date	date
term_start_date	date
transcript_term	object_id
updated_at	datetime

Permissions

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

Academic Admin
Registrar

students

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/academicterms/(academicterm)/students" \
-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/academicterms/(academicterm)/students',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/academicterms/(academicterm)/students',
 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/academicterms/(academicterm)/students"), 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/academicterms/(academicterm)/students');
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": 2,
    "results": 2,
    "results_per_page": 200,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "person",
            "id": 16,
            "first_name": "Abby",
            "last_name": "Admin",
            "middle_name": null,
            "prefix": null,
            "suffix": null,
            "preferred_name": null,
            "display_name": "Abby Admin",
            "salutation": "Abby Admin",
            "addressee": "Abby 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": {
                "degree_list": null,
                "specialization_list": null,
                "standing_name": null,
                "term_gpa": null,
                "cum_gpa": null,
                "term_units_attempted": null,
                "program_id": null,
                "program_name": null,
                "full_time": null,
                "cum_units_granted": null,
                "courses_mapped_elsewhere": 0,
                "row_id": "16_0"
            },
            "private_profile": false,
            "is_user": true
        }
    ],
    "sandbox": true
}

HTTP Request

GET /academicterms/(academicterm)/students

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.

Expandable Properties

academic_year
enrollment_periods
subterms

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name	Type
program	object id
standing	academicstanding
degree_seeking	bool
degree_level	choice
degree	object id
specialization	specialization
first_time	bool
full_time	bool
term_units	decimal
term_units_granted	decimal
term_gpa	decimal
cum_units	decimal
resident_cum_gpa	decimal
total_cum_gpa	decimal
total_transfer_credits	decimal
region	choice
race_ethnicity	object id
gender	enum (male, female, unknown, other)
campus	object id
tag	tag
custom_field	custom
lock_type	locktype

Permissions

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

Academic Auditor
Academic Admin
Registrar

waitinglist

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/academicterms/(academicterm)/waitinglist" \
-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/academicterms/(academicterm)/waitinglist',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/academicterms/(academicterm)/waitinglist',
 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/academicterms/(academicterm)/waitinglist"), 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/academicterms/(academicterm)/waitinglist');
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": 16,
            "first_name": "Abby",
            "last_name": "Admin",
            "middle_name": null,
            "prefix": null,
            "suffix": null,
            "preferred_name": null,
            "display_name": "Abby Admin",
            "salutation": "Abby Admin",
            "addressee": "Abby 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": {
                "waiting_list_added_at": "2022-10-11 17:08:57",
                "waiting_list_position": 2,
                "course_offering_id": 21910,
                "full_course_offering_name": "LAT101-1: Beginning Latin I",
                "max_enrolled": null,
                "num_enrolled_incomplete": 2,
                "openings": null,
                "row_id": "40_16"
            },
            "private_profile": false,
            "is_user": true
        }
    ],
    "sandbox": true
}

HTTP Request

GET /academicterms/(academicterm)/waitinglist

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.

Expandable Properties

academic_year
enrollment_periods
subterms

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name	Type
course	object_id
student	object_id
position	integer
added_at	datetime
max_enrolled	integer
enrolled	integer
openings	integer
catalog_course	object_id
course_delivery_method	object id
course_faculty	object id
finalized	bool
credits	decimal
hours	decimal
pass_fail	bool
course_campus	object id
has_active_student_role	enum (yes, no)
students_campus	object id
program	object id
standing	academicstanding
degree_seeking	bool
degree_level	choice
degree	object id
first_time	bool
full_time	bool
age	integer
gender	enum (male, female, unknown, other)
race_ethnicity	object id

Permissions

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

Academic Auditor
Academic Admin
Registrar

current

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/academicterms/current" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/academicterms/current',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/academicterms/current',
 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/academicterms/current"), 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/academicterms/current');
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": "academic_term",
    "id": 8,
    "academic_year_id": 4,
    "name": "Spring 2010",
    "display_name": "Spring 2010 2009-2010",
    "start_date": "2010-02-01",
    "end_date": "2010-05-15",
    "grades_date": "2010-05-10",
    "add_drop_time": "2010-02-15T00:00:00+00:00",
    "enrollment_start_time": "2010-01-01T00:00:00+00:00",
    "enrollment_end_time": null,
    "max_enrolled_credits": null,
    "max_enrolled_hours": null,
    "max_audit_credits": null,
    "max_audit_hours": null,
    "can_overlap_dates": false,
    "level": "single",
    "academic_term_type_id": null,
    "is_for_transcript": true,
    "is_for_billing": true,
    "is_for_campus_life": true,
    "is_entrance_term": true,
    "evaluations_available_from": null,
    "evaluations_available_to": null,
    "evaluations_lock_grades_at": null,
    "online_registration_delay_until": null,
    "online_registration_randomization_seconds": 0,
    "evaluations_lock_grades_until": null,
    "evaluations_available_to_faculty": null,
    "lms_sync": null,
    "external_id": null,
    "start_year": 2009,
    "end_year": 2010,
    "added_at": null,
    "added_by_id": null,
    "type": "standard",
    "sandbox": true
}

Returns the current default term.

HTTP Request

GET /academicterms/current

Parameters

None

Expandable Properties

academic_year
enrollment_periods
subterms

Permissions

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

Academic Admin
Registrar