Advisee
The Advisee object
The Advisee object looks like this in JSON:
{
"object": "student",
"id": 1,
"entrance_term_id": 8,
"exit_date": null,
"exit_reason": null,
"grades_withheld": false,
"meal_plan_id": null,
"room_plan_id": null,
"proctored": false,
"first_time": false,
"max_enrolled_credits": null,
"max_enrolled_hours": null,
"max_audit_credits": null,
"max_audit_hours": null,
"last_academic_term_id": null,
"student_type_campus": "enroll_audit",
"student_type_online": "enroll_audit",
"housing": null,
"advisor_ids": null,
"visible_student_id": "20020xx000",
"sandbox": true
}
| Attribute | Required | Data Type |
|---|---|---|
| id | Yes | int |
| entrance_term_id | Yes | int |
| exit_date | Yes | date |
| exit_reason | Yes | int |
| grades_withheld | Yes | bool |
| meal_plan_id | Yes | int |
| room_plan_id | Yes | int |
| proctored | No | bool |
| first_time | Yes | bool |
| max_enrolled_credits | No | decimal |
| max_enrolled_hours | No | decimal |
| max_audit_credits | No | decimal |
| max_audit_hours | No | decimal |
| last_academic_term_id | No | int |
| student_type_campus | Yes | enum (enroll_audit, enroll, audit, none) |
| student_type_online | Yes | enum (enroll_audit, enroll, audit, none) |
| housing | No | enum (on_campus, with_parent, off_campus, on_campus_with_dependents) |
| advisor_ids | No | Array of Person IDs |
| visible_student_id | No | text |
| sandbox | No | bool |
index
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/advisees" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
-d '{
"filter": {"0":{"logic":"ALL","fields":[{"name":"last_name","value":{"type":"CONTAINS","text":"blah"},"positive":1}]}}
}' \
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/advisees',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/advisees',
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/advisees"), 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/advisees');
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": 3,
"results": 3,
"results_per_page": 200,
"pages": 1,
"page": 1,
"offset": 0,
"has_more": false,
"data": [
{
"object": "student",
"id": 16,
"entrance_term_id": 8,
"exit_date": null,
"exit_reason": null,
"grades_withheld": false,
"meal_plan_id": null,
"room_plan_id": null,
"proctored": false,
"first_time": false,
"max_enrolled_credits": null,
"max_enrolled_hours": null,
"max_audit_credits": null,
"max_audit_hours": null,
"last_academic_term_id": null,
"student_type_campus": "enroll_audit",
"student_type_online": "enroll_audit",
"housing": null,
"visible_student_id": "20220xx001",
"report_data": {
"advisor_names": "Financial Admin",
"advisor_types": "NOT_PRIMARY",
"advisor_ids": "17",
"raw_advisor_names": "Financial Admin (Advisor)",
"current_user_is_advisor": null,
"student_advisor_ids": "3",
"firstname": "Abby",
"preferred_name": "",
"lastname": "Admin",
"display_name": "Abby Admin",
"image_id": 0,
"last_attendance_date": null,
"registration_locked": 0,
"registration_locks": null,
"discipline": null,
"color": "YELLOW",
"entrance_term_name": "Spring 2010 2009-2010",
"row_id": 16
}
}
],
"sandbox": true
}
Retrieves all Advisee objects that match given filter conditions.
HTTP Request
GET /advisees
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. |
Filter Condition Parameters
These conditions can be used to narrow the results returned.
| Name | Type |
|---|---|
| first_name | text |
| preferred_name | text |
| last_name | text |
| program | object id |
| degree | object id |
| specialization | specialization |
| course_term | object_id |
| entrance_term | object id |
| flag | choice |
| last_attendance | DATE |
| discipline | object id |
| registration_lock | bool |
| student_campus | object id |
| cum_gpa | academic_progress_cache |
| cum_units | academic_progress_cache |
| custom_field | custom |
Permissions
One of the following roles is required to call this method:
- Academic Auditor
- Academic Admin
- Registrar