CatalogCourse
The CatalogCourse object
The CatalogCourse object looks like this in JSON:
{
"object": "catalog_course",
"id": 576,
"name": "Pentateuch",
"description": "Biblical Studies: Pentateuch.\n\nThis course explores the five books of Moses, with particular attention to the Mosaic tabernacle, its institutions of worship and sacrifice, the laws of clean and unclean. The course also explores cultural-anthropological perspectives on the Pentateuch. Unless they can produce a better overview, students will be required to be able to reproduce Dorsey???s outline of each book of the Pentateuch, as well as rational for the outline.\nIn addition to readings, instructor-led discussions of selected passages of the Pentateuch, and lectures, students will be required to exegete at least one assigned passage of the Pentateuch and lead a class discussion on that passage.",
"abbrv": "BS502",
"department_id": 2,
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"finaid_credits": 0,
"finaid_hours": 0,
"fulfills_program_requirements": true,
"affects_standing": true,
"affects_full_time_status": true,
"count_retakes": false,
"status": "active",
"max_enrolled": 100,
"max_auditors": 100,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"cip_code": null,
"self_enroll": "yes",
"self_audit": true,
"enable_clinical_hours": false,
"roster_visibility": true,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"minimum_attendance": null,
"allowed_tuition_schedules": "all",
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"show_in_public_schedule": true,
"show_in_public_catalog": true,
"remedial": false,
"import_id": null,
"image_file_id": null,
"course_evaluation_id": null,
"sandbox": true
}
| Attribute | Required | Data Type |
|---|---|---|
| id | Yes | int |
| name | Yes | text (255) |
| description | Yes | text |
| abbrv | Yes | text (20) |
| department_id | Yes | int |
| credits | Yes | decimal |
| hours | Yes | decimal |
| attendance_hours | Yes | decimal |
| clinical_hours | Yes | decimal |
| finaid_credits | No | decimal |
| finaid_hours | No | decimal |
| fulfills_program_requirements | Yes | bool |
| affects_standing | Yes | bool |
| affects_full_time_status | Yes | bool |
| count_retakes | Yes | bool |
| status | Yes | enum (active, retired) |
| max_enrolled | No | int |
| max_auditors | No | int |
| pass_fail | Yes | bool |
| pass_affects_gpa | Yes | bool |
| fail_affects_gpa | Yes | bool |
| pass_fail_pass_affects_gpa | Yes | bool |
| pass_fail_fail_affects_gpa | Yes | bool |
| cip_code | Yes | text (15) |
| self_enroll | Yes | enum (yes, no_repeats, no) |
| self_audit | Yes | bool |
| enable_clinical_hours | Yes | bool |
| roster_visibility | Yes | bool |
| faculty_can_manage_roster | Yes | bool |
| faculty_can_override_enrollment | Yes | bool |
| minimum_attendance | No | decimal |
| allowed_tuition_schedules | Yes | enum (all, none, choose) |
| allow_auditor_assignments | Yes | bool |
| allow_auditor_attendance | Yes | bool |
| allow_auditor_evaluations | Yes | bool |
| waiting_list_management | Yes | enum (automatic, manual, none) |
| show_in_public_schedule | Yes | bool |
| show_in_public_catalog | Yes | bool |
| remedial | Yes | bool |
| import_id | No | int |
| image_file_id | No | int |
| course_evaluation_id | No | int |
| sandbox | No | bool |
index
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/catalogcourses" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
-d '{
"filter": {"0":{"logic":"ALL","fields":[{"name":"credits","value":{"type":"RANGE","start":"10.5","end":"900.15"},"positive":1}]}}
}' \
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/catalogcourses',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/catalogcourses',
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/catalogcourses"), 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/catalogcourses');
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": 36,
"results": 36,
"results_per_page": 200,
"pages": 1,
"page": 1,
"offset": 0,
"has_more": false,
"data": [
{
"object": "catalog_course",
"id": 576,
"name": "Pentateuch",
"description": "Biblical Studies: Pentateuch.\n\nThis course explores the five books of Moses, with particular attention to the Mosaic tabernacle, its institutions of worship and sacrifice, the laws of clean and unclean. The course also explores cultural-anthropological perspectives on the Pentateuch. Unless they can produce a better overview, students will be required to be able to reproduce Dorsey???s outline of each book of the Pentateuch, as well as rational for the outline.\nIn addition to readings, instructor-led discussions of selected passages of the Pentateuch, and lectures, students will be required to exegete at least one assigned passage of the Pentateuch and lead a class discussion on that passage.",
"abbrv": "BS502",
"department_id": 2,
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"finaid_credits": 0,
"finaid_hours": 0,
"fulfills_program_requirements": true,
"affects_standing": true,
"affects_full_time_status": true,
"count_retakes": false,
"status": "active",
"max_enrolled": 100,
"max_auditors": 100,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"cip_code": null,
"self_enroll": "yes",
"self_audit": true,
"enable_clinical_hours": false,
"roster_visibility": true,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"minimum_attendance": null,
"allowed_tuition_schedules": "all",
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"show_in_public_schedule": true,
"show_in_public_catalog": true,
"remedial": false,
"import_id": null,
"image_file_id": null,
"course_evaluation_id": null,
"report_data": {
"department_name": "Old Undergraduate",
"could_delete": 0,
"program_name_ids": null,
"row_id": 576
}
}
],
"sandbox": true
}
Retrieves all CatalogCourse objects that match given filter conditions.
HTTP Request
GET /catalogcourses
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
- faculty
- corequisites
- course_equivalencies
- prerequisites
- programs
- department
- tuition_schedules
Filter Condition Parameters
These conditions can be used to narrow the results returned.
| Name | Type |
|---|---|
| abbrv | text |
| name | text |
| credits | decimal |
| hours | decimal |
| status | enum |
| program | object id |
| department | object id |
| pass_fail | bool |
| delivery_method | object id |
| default_evaluation | object id |
| has_default_evaluation | bool |
| max_enrolled | enrollment |
| max_auditors | enrollment |
Permissions
Any role may call this method.
show
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/catalogcourses/(catalogcourse)" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/catalogcourses/(catalogcourse)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/catalogcourses/(catalogcourse)',
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/catalogcourses/(catalogcourse)"), 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/catalogcourses/(catalogcourse)');
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": "catalog_course",
"id": 576,
"name": "Pentateuch",
"description": "Biblical Studies: Pentateuch.\n\nThis course explores the five books of Moses, with particular attention to the Mosaic tabernacle, its institutions of worship and sacrifice, the laws of clean and unclean. The course also explores cultural-anthropological perspectives on the Pentateuch. Unless they can produce a better overview, students will be required to be able to reproduce Dorsey???s outline of each book of the Pentateuch, as well as rational for the outline.\nIn addition to readings, instructor-led discussions of selected passages of the Pentateuch, and lectures, students will be required to exegete at least one assigned passage of the Pentateuch and lead a class discussion on that passage.",
"abbrv": "BS502",
"department_id": 2,
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"finaid_credits": 0,
"finaid_hours": 0,
"fulfills_program_requirements": true,
"affects_standing": true,
"affects_full_time_status": true,
"count_retakes": false,
"status": "active",
"max_enrolled": 100,
"max_auditors": 100,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"cip_code": null,
"self_enroll": "yes",
"self_audit": true,
"enable_clinical_hours": false,
"roster_visibility": true,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"minimum_attendance": null,
"allowed_tuition_schedules": "all",
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"show_in_public_schedule": true,
"show_in_public_catalog": true,
"remedial": false,
"import_id": null,
"image_file_id": null,
"course_evaluation_id": null,
"sandbox": true
}
Retrieves a specific CatalogCourse object.
HTTP Request
GET /catalogcourses/(catalogcourse)
Parameters
No additional parameters are needed beyond the ID of the object being requested that appears in the URL.
Expandable Properties
- faculty
- corequisites
- course_equivalencies
- prerequisites
- programs
- department
- tuition_schedules
Permissions
One of the following roles is required to call this method:
- Academic Auditor
- Academic Admin
- Registrar