Honor

The Honor object

The Honor object looks like this in JSON:

{
    "object": "honor",
    "id": 5,
    "name": "All Programs Honor",
    "min_gpa": 3,
    "max_gpa": 4,
    "gpa_type": "gpa_including_transfer",
    "min_units": 0,
    "units_type": "include_transfer_units",
    "owner_type": "program",
    "type": "automatic",
    "tag_id": 443824,
    "start_date": null,
    "retired_at": null,
    "retired_by_id": null,
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
name	Yes	text (255)
min_gpa	No	decimal
max_gpa	No	decimal
gpa_type	Yes	enum (none, gpa_including_transfer, institutional_gpa)
min_units	No	decimal
units_type	Yes	enum (none, include_transfer_units, institutional_units)
owner_type	Yes	enum (program, degree, term, student)
type	Yes	enum (automatic, manual)
tag_id	Yes	int
start_date	No	date
retired_at	No	date
retired_by_id	No	int
sandbox	No	bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/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/honors',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/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/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/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": 5,
    "results": 5,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "honor",
            "id": 5,
            "name": "All Programs Honor",
            "min_gpa": 3,
            "max_gpa": 4,
            "gpa_type": "gpa_including_transfer",
            "min_units": 0,
            "units_type": "include_transfer_units",
            "owner_type": "program",
            "type": "automatic",
            "tag_id": 443824,
            "start_date": null,
            "retired_at": null,
            "retired_by_id": null
        }
    ],
    "sandbox": true
}

Retrieves all Honor objects.

HTTP Request

GET /honors

Parameters

None

Permissions

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

Academic Admin

show

Example code to call this method:

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

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/honors/(honor)',
 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/honors/(honor)"), 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/honors/(honor)');
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": "honor",
    "id": 5,
    "name": "All Programs Honor",
    "min_gpa": 3,
    "max_gpa": 4,
    "gpa_type": "gpa_including_transfer",
    "min_units": 0,
    "units_type": "include_transfer_units",
    "owner_type": "program",
    "type": "automatic",
    "tag_id": 443824,
    "start_date": null,
    "retired_at": null,
    "retired_by_id": null,
    "sandbox": true
}

Retrieves a specific Honor object.

HTTP Request

GET /honors/(honor)

Parameters

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

Expandable Properties

programs
program_standings
degrees

Permissions

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

Academic Admin