CourseGroupRequirement

The CourseGroupRequirement object

The CourseGroupRequirement object looks like this in JSON:

{
    "object": "course_group_requirement",
    "id": 1,
    "course_group_id": 1,
    "requirement_id": 1,
    "type": "courses",
    "value": 0,
    "gpa": 2.5,
    "grade_points": 3,
    "allow_equivalencies": true,
    "exclusively_apply_data": false,
    "order_id": 1,
    "course_group_name": "Undergrad Art",
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
course_group_id	Yes	int
requirement_id	Yes	int
type	No	enum (units, courses, clinical_hours, attendance_hours)
value	Yes	decimal
gpa	No	decimal
grade_points	No	decimal
allow_equivalencies	Yes	bool
exclusively_apply_data	Yes	bool
order_id	Yes	int
course_group_name	No	text
sandbox	No	bool

index

Example code to call this method:

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

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/coursegrouprequirements',
 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/coursegrouprequirements"), 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/coursegrouprequirements');
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": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "course_group_requirement",
            "id": 1,
            "course_group_id": 1,
            "requirement_id": 1,
            "type": "courses",
            "value": 0,
            "gpa": 2.5,
            "grade_points": 3,
            "allow_equivalencies": true,
            "exclusively_apply_data": false,
            "order_id": 1,
            "course_group_name": "Undergrad Art"
        }
    ],
    "sandbox": true
}

Retrieves all CourseGroupRequirement objects.

HTTP Request

GET /coursegrouprequirements

Parameters

None

Permissions

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

Academic Auditor
Academic Admin
Registrar

show

Example code to call this method:

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

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/coursegrouprequirements/(coursegrouprequirement)',
 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/coursegrouprequirements/(coursegrouprequirement)"), 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/coursegrouprequirements/(coursegrouprequirement)');
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": "course_group_requirement",
    "id": 1,
    "course_group_id": 1,
    "requirement_id": 1,
    "type": "courses",
    "value": 0,
    "gpa": 2.5,
    "grade_points": 3,
    "allow_equivalencies": true,
    "exclusively_apply_data": false,
    "order_id": 1,
    "course_group_name": "Undergrad Art",
    "sandbox": true
}

Retrieves a specific CourseGroupRequirement object.

HTTP Request

GET /coursegrouprequirements/(coursegrouprequirement)

Parameters

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

Expandable Properties

academic_requirement
course_group

Permissions

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

Academic Auditor
Academic Admin
Registrar