StudentAdvisor
The StudentAdvisor object
The StudentAdvisor object looks like this in JSON:
{
"object": "student_advisor",
"id": 2,
"student_id": 11,
"advisor_id": 16,
"type": "primary",
"added_at": "2026-07-25T16:24:16+00:00",
"added_by_id": 13,
"sandbox": true
}
| Attribute | Required | Data Type |
|---|---|---|
| id | Yes | int |
| student_id | Yes | int |
| advisor_id | Yes | int |
| type | Yes | enum (not_primary, primary, hidden) |
| added_at | No | datetime |
| added_by_id | No | int |
| sandbox | No | bool |
index
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/people/(person)/advisors" \
-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)/advisors',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/people/(person)/advisors',
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)/advisors"), 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)/advisors');
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": "student_advisor",
"id": 4,
"student_id": 12,
"advisor_id": 16,
"type": "hidden",
"added_at": "2026-07-25T16:23:56+00:00",
"added_by_id": 13
}
],
"sandbox": true
}
Retrieves all StudentAdvisor objects tied to a specific Person.
HTTP Request
GET /people/(person)/advisors
Parameters
None
Permissions
One of the following roles is required to call this method:
- Academic Auditor
- Registrar
- Academic Admin
create
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/people/(person)/advisors" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X POST
-d '{
"advisor_id": 17
}' \
require 'httparty'
response = HTTParty.post(
'https://yourschool.populiweb.com/api2/people/(person)/advisors',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
body: {
:advisor_id => 17
}.to_json
)
puts response.body
import requests
response = requests.post(
'https://yourschool.populiweb.com/api2/people/(person)/advisors',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
json={
'advisor_id': 17
}
)
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)/advisors"), Method.Post);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
request.AddJsonBody(new {
advisor_id = 17
});
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)/advisors');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode([
'advisor_id' => 17
]));
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "student_advisor",
"id": 5,
"student_id": 12,
"advisor_id": 17,
"type": "not_primary",
"added_at": "2026-07-25T16:24:11+00:00",
"added_by_id": 22,
"sandbox": true
}
Creates a new StudentAdvisor object.
HTTP Request
POST /people/(person)/advisors
Parameters
| Name | Required | Data Type | Description |
|---|---|---|---|
| advisor_id | Yes | int | |
| type | No | enum (not_primary, primary, hidden) |
Permissions
One of the following roles is required to call this method:
- Registrar
- Academic Admin
delete
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/people/(person)/advisors/(studentadvisor)" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X DELETE
require 'httparty'
response = HTTParty.delete(
'https://yourschool.populiweb.com/api2/people/(person)/advisors/(studentadvisor)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.delete(
'https://yourschool.populiweb.com/api2/people/(person)/advisors/(studentadvisor)',
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)/advisors/(studentadvisor)"), Method.Delete);
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)/advisors/(studentadvisor)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "student_advisor",
"id": 2,
"deleted": true
}
Deletes an existing StudentAdvisor object.
HTTP Request
DELETE /people/(person)/advisors/(studentadvisor)
Parameters
No additional parameters are needed beyond the ID of the object to delete that appears in the URL.
Permissions
One of the following roles is required to call this method:
- Registrar
- Academic Admin