RequirementException

The RequirementException object

The RequirementException object looks like this in JSON:

{
    "object": "requirement_exception",
    "id": 31,
    "student_id": 12,
    "degree_id": 2,
    "specialization_id": 4,
    "owner_type": "specialization_course_group",
    "owner_id": 41,
    "type": "course_group_courses",
    "value": 2,
    "note": null,
    "added_by_id": 24512,
    "sandbox": true
}

Attribute	Required	Data Type
id	No	int
student_id	Yes	int
degree_id	Yes	int
specialization_id	Yes	int
owner_type	Yes	enum (degree, specialization, degree_course_group, specialization_course_group)
owner_id	Yes	int
type	Yes	enum (cumulative_gpa, overall_gpa, cumulative_units, resident_units, cumulative_clinical_hours, resident_clinical_hours, cumulative_attendance_hours, resident_attendance_hours, course_group_units, course_group_courses, course_group_clinical_hours, course_group_gpa, course_group_grade_points)
value	Yes	decimal
note	Yes	text (1000)
added_by_id	No	int
sandbox	No	bool

index

Example code to call this method:

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

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/people/(person)/requirementexceptions',
 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/people/(person)/requirementexceptions"), 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/people/(person)/requirementexceptions');
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": "requirement_exception",
            "id": 31,
            "student_id": 12,
            "degree_id": 2,
            "specialization_id": 4,
            "owner_type": "specialization_course_group",
            "owner_id": 41,
            "type": "course_group_courses",
            "value": 2,
            "note": null,
            "added_by_id": 24512
        }
    ],
    "sandbox": true
}

Retrieves all RequirementException objects tied to a specific Person.

HTTP Request

GET /people/(person)/requirementexceptions

Parameters

None

Permissions

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

Academic Admin
Registrar