StudentHonor
The StudentHonor object
The StudentHonor object looks like this in JSON:
{
"object": "student_honor",
"id": 1,
"person_id": 12,
"honor_id": 1,
"program_id": null,
"link_id": null,
"added_at": "2022-07-13T23:29:39+00:00",
"added_by_id": 10,
"sandbox": true
}
| Attribute | Required | Data Type |
|---|---|---|
| id | Yes | int |
| person_id | Yes | int |
| honor_id | Yes | int |
| program_id | Yes | int |
| link_id | Yes | int |
| 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)/honors" \
-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)/honors',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/people/(person)/honors',
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)/honors"), 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)/honors');
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_honor",
"id": 1,
"person_id": 12,
"honor_id": 1,
"program_id": null,
"link_id": null,
"added_at": "2022-07-13T23:29:39+00:00",
"added_by_id": 10
}
],
"sandbox": true
}
Retrieves all StudentHonor objects tied to a specific Person.
HTTP Request
GET /people/(person)/honors
Parameters
None
Expandable Properties
- honor
- program
- degree
- academic_term
Permissions
One of the following roles is required to call this method:
- Registrar
- Academic Admin
create
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/people/(person)/honors" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X POST
-d '{
"honor_id": 2,
"link_id": 1,
"program_id": 1
}' \
require 'httparty'
response = HTTParty.post(
'https://yourschool.populiweb.com/api2/people/(person)/honors',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
body: {
:honor_id => 2
}.to_json
)
puts response.body
import requests
response = requests.post(
'https://yourschool.populiweb.com/api2/people/(person)/honors',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
json={
'honor_id': 2
}
)
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)/honors"), Method.Post);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
request.AddJsonBody(new {
honor_id = 2
});
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)/honors');
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([
'honor_id' => 2
]));
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "student_honor",
"id": 3,
"person_id": 16,
"honor_id": 2,
"program_id": 1,
"link_id": 1,
"added_at": "2026-07-25T16:24:12+00:00",
"added_by_id": 22,
"sandbox": true
}
Creates a new StudentHonor object.
HTTP Request
POST /people/(person)/honors
Parameters
| Name | Required | Data Type | Description |
|---|---|---|---|
| honor_id | Yes | int | |
| link_id | No | int | This will be the ID of a Program, Degree, or Academic Term, depending on the type of Honor being created. |
| program_id | No | int | Required when applying an Academic Term honor. |
Permissions
One of the following roles is required to call this method:
- Registrar
- Academic Admin
show
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/people/(person)/honors/(studenthonor)" \
-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)/honors/(studenthonor)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/people/(person)/honors/(studenthonor)',
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)/honors/(studenthonor)"), 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)/honors/(studenthonor)');
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": "student_honor",
"id": 2,
"person_id": 16,
"honor_id": 1,
"program_id": null,
"link_id": 1,
"added_at": "2022-07-13T23:29:39+00:00",
"added_by_id": 10,
"sandbox": true
}
Retrieves a specific StudentHonor object.
HTTP Request
GET /people/(person)/honors/(studenthonor)
Parameters
No additional parameters are needed beyond the ID of the object being requested that appears in the URL.
Expandable Properties
- honor
- program
- degree
- academic_term
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)/honors/(studenthonor)" \
-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)/honors/(studenthonor)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.delete(
'https://yourschool.populiweb.com/api2/people/(person)/honors/(studenthonor)',
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)/honors/(studenthonor)"), 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)/honors/(studenthonor)');
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_honor",
"id": 2,
"deleted": true
}
Deletes an existing StudentHonor object.
HTTP Request
DELETE /people/(person)/honors/(studenthonor)
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