SAPOverride

The SAPOverride object

The SAPOverride object looks like this in JSON:

{
    "object": "sap_override",
    "id": 1,
    "student_id": 13,
    "academic_term_id": null,
    "owner_type": "payment_period",
    "owner_id": 1,
    "sap": "satisfactory",
    "can_appeal": true,
    "added_at": "2022-07-14T22:40:31+00:00",
    "added_by_id": 10,
    "updated_at": 2022,
    "updated_by_id": 10,
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
student_id	Yes	int
academic_term_id	Yes	int
owner_type	Yes	enum (term, payment_period)
owner_id	Yes	int
sap	Yes	enum (satisfactory, warning, probation, suspension, not_calculated)
can_appeal	Yes	bool
added_at	No	datetime
added_by_id	No	int
updated_at	No	int
updated_by_id	No	int
sandbox	No	bool

index

Example code to call this method:

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/people/(person)/sapoverrides',
 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)/sapoverrides"), 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)/sapoverrides');
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": "sap_override",
            "id": 3,
            "student_id": 12,
            "academic_term_id": null,
            "owner_type": "term",
            "owner_id": 1,
            "sap": "satisfactory",
            "can_appeal": true,
            "added_at": "2022-07-14T22:40:31+00:00",
            "added_by_id": 10,
            "updated_at": 2022,
            "updated_by_id": 10
        }
    ],
    "sandbox": true
}

Retrieves all SAPOverride objects tied to a specific Person.

HTTP Request

GET /people/(person)/sapoverrides

Parameters

None

Permissions

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

Financial Admin
Financial Aid

show

Example code to call this method:

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/people/(person)/sapoverrides/(sapoverride)',
 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)/sapoverrides/(sapoverride)"), 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)/sapoverrides/(sapoverride)');
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": "sap_override",
    "id": 2,
    "student_id": 16,
    "academic_term_id": null,
    "owner_type": "term",
    "owner_id": 1,
    "sap": "satisfactory",
    "can_appeal": true,
    "added_at": "2022-07-14T22:40:31+00:00",
    "added_by_id": 10,
    "updated_at": 2022,
    "updated_by_id": 10,
    "sandbox": true
}

Retrieves a specific SAPOverride object.

HTTP Request

GET /people/(person)/sapoverrides/(sapoverride)

Parameters

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

Expandable Properties

academic_term
payment_period

Permissions

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

Financial Admin
Financial Aid