AcademicTermType
The AcademicTermType object
The AcademicTermType object looks like this in JSON:
{
"object": "academic_term_type",
"id": 2,
"name": "Quarter",
"display_name": "{START_YEAR} Quarter",
"default_start_month": true,
"default_start_day": true,
"default_start_year": "start",
"default_start_weekday": false,
"default_end_month": true,
"default_end_day": true,
"default_end_year": "end",
"default_end_weekday": false,
"default_can_overlap_dates": false,
"default_add_drop_days": true,
"level": "single",
"parent_academic_term_type_id": null,
"is_for_transcript": false,
"is_for_billing": true,
"is_for_campus_life": false,
"is_entrance_term": false,
"status": "active",
"retired_at": null,
"retired_by_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"updated_by_id": null,
"sandbox": true,
"api_version": null
}
| Attribute | Required | Data Type |
|---|---|---|
| id | Yes | int |
| name | Yes | text (128) |
| display_name | No | text (128) |
| default_start_month | Yes | bool |
| default_start_day | Yes | bool |
| default_start_year | Yes | enum (start, end) |
| default_start_weekday | Yes | bool |
| default_end_month | Yes | bool |
| default_end_day | Yes | bool |
| default_end_year | Yes | enum (start, end) |
| default_end_weekday | Yes | bool |
| default_can_overlap_dates | Yes | bool |
| default_add_drop_days | Yes | bool |
| level | Yes | enum (single, super, sub) |
| parent_academic_term_type_id | No | int |
| is_for_transcript | No | bool |
| is_for_billing | Yes | bool |
| is_for_campus_life | Yes | bool |
| is_entrance_term | Yes | bool |
| status | No | enum (active, retired, deleted) |
| retired_at | No | datetime |
| retired_by_id | No | int |
| added_at | No | datetime |
| added_by_id | No | int |
| updated_at | No | datetime |
| updated_by_id | No | int |
| sandbox | No | bool |
| api_version | No | -- |
index
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/academictermtypes" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/academictermtypes',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/academictermtypes',
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/academictermtypes"), 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/academictermtypes');
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": null,
"pages": 1,
"page": 1,
"offset": 0,
"has_more": false,
"data": [
{
"object": "academic_term_type",
"id": 2,
"name": "Quarter",
"display_name": "{START_YEAR} Quarter",
"default_start_month": true,
"default_start_day": true,
"default_start_year": "start",
"default_start_weekday": false,
"default_end_month": true,
"default_end_day": true,
"default_end_year": "end",
"default_end_weekday": false,
"default_can_overlap_dates": false,
"default_add_drop_days": true,
"level": "single",
"parent_academic_term_type_id": null,
"is_for_transcript": false,
"is_for_billing": true,
"is_for_campus_life": false,
"is_entrance_term": false,
"status": "active",
"retired_at": null,
"retired_by_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"updated_by_id": null
}
],
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves all AcademicTermType objects.
HTTP Request
GET /academictermtypes
Parameters
None
Permissions
One of the following roles is required to call this method:
- Academic Auditor
- Academic Admin