NAV
shell ruby python csharp php

TuitionScheduleStudent

The TuitionScheduleStudent object

The TuitionScheduleStudent object looks like this in JSON:

{
    "object": "tuition_schedule_student",
    "id": 1,
    "academic_term_id": 1,
    "student_id": 13,
    "schedule_id": 1,
    "bracket_id": null,
    "adjustment": 0,
    "sandbox": true
}
Attribute Required Data Type
id Yes int
academic_term_id Yes int
student_id Yes int
schedule_id Yes int
bracket_id Yes int
adjustment Yes decimal
sandbox No bool

index

Example code to call this method:

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/people/(person)/tuitionschedules',
 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)/tuitionschedules"), 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)/tuitionschedules');
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": "tuition_schedule_student",
            "id": 3,
            "academic_term_id": 4,
            "student_id": 12,
            "schedule_id": 1,
            "bracket_id": null,
            "adjustment": 0,
            "tuition_schedule": {
                "object": "tuition_schedule",
                "id": 1,
                "name": "Cool Kids Plan",
                "units": "hours",
                "status": "active",
                "refund_type": "prorated",
                "refund_policy_id": null,
                "added_at": null,
                "added_by_id": null
            },
            "tuition_schedule_bracket": null
        }
    ],
    "sandbox": true
}

Retrieves all TuitionScheduleStudent objects tied to a specific Person.

HTTP Request

GET /people/(person)/tuitionschedules

Parameters

None

Permissions

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

create

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/tuitionschedules" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X POST
-d '{
    "academic_term_id": 8,
    "tuition_schedule_id": 1
}' \ 

require 'httparty'
response = HTTParty.post(
 'https://yourschool.populiweb.com/api2/people/(person)/tuitionschedules',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
 body: {
  :academic_term_id => 8,
  :tuition_schedule_id => 1
 }.to_json
)
puts response.body

import requests
response = requests.post(
 'https://yourschool.populiweb.com/api2/people/(person)/tuitionschedules',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
 json={
  'academic_term_id': 8,
  'tuition_schedule_id': 1
 }
)
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)/tuitionschedules"), Method.Post);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
request.AddJsonBody(new {
  academic_term_id = 8,
  tuition_schedule_id = 1
});
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)/tuitionschedules');
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([
  'academic_term_id' => 8,
  'tuition_schedule_id' => 1
]));
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "tuition_schedule_student",
    "id": 4,
    "academic_term_id": 8,
    "student_id": 12,
    "schedule_id": 1,
    "bracket_id": null,
    "adjustment": 0,
    "tuition_schedule": {
        "object": "tuition_schedule",
        "id": 1,
        "name": "Cool Kids Plan",
        "units": "hours",
        "status": "active",
        "refund_type": "prorated",
        "refund_policy_id": null,
        "added_at": null,
        "added_by_id": null
    },
    "tuition_schedule_bracket": null,
    "sandbox": true
}

Creates a new TuitionScheduleStudent object.

HTTP Request

POST /people/(person)/tuitionschedules

Parameters

Name Required Data Type Description
academic_term_id Yes int
tuition_schedule_id Yes int
tuition_schedule_bracket_id No int

Permissions

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

show

Example code to call this method:

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/people/(person)/tuitionschedules/(tuitionschedulestudent)',
 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)/tuitionschedules/(tuitionschedulestudent)"), 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)/tuitionschedules/(tuitionschedulestudent)');
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": "tuition_schedule_student",
    "id": 1,
    "academic_term_id": 1,
    "student_id": 13,
    "schedule_id": 1,
    "bracket_id": null,
    "adjustment": 0,
    "tuition_schedule": {
        "object": "tuition_schedule",
        "id": 1,
        "name": "Cool Kids Plan",
        "units": "hours",
        "status": "active",
        "refund_type": "prorated",
        "refund_policy_id": null,
        "added_at": null,
        "added_by_id": null
    },
    "tuition_schedule_bracket": null,
    "sandbox": true
}

Retrieves a specific TuitionScheduleStudent object.

HTTP Request

GET /people/(person)/tuitionschedules/(tuitionschedulestudent)

Parameters

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

Permissions

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

update

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/tuitionschedules/(tuitionschedulestudent)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X PUT

require 'httparty'
response = HTTParty.put(
 'https://yourschool.populiweb.com/api2/people/(person)/tuitionschedules/(tuitionschedulestudent)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.put(
 'https://yourschool.populiweb.com/api2/people/(person)/tuitionschedules/(tuitionschedulestudent)',
 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)/tuitionschedules/(tuitionschedulestudent)"), Method.Put);
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)/tuitionschedules/(tuitionschedulestudent)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "tuition_schedule_student",
    "id": 1,
    "academic_term_id": 1,
    "student_id": 13,
    "schedule_id": 1,
    "bracket_id": null,
    "adjustment": 0,
    "tuition_schedule": {
        "object": "tuition_schedule",
        "id": 1,
        "name": "Cool Kids Plan",
        "units": "hours",
        "status": "active",
        "refund_type": "prorated",
        "refund_policy_id": null,
        "added_at": null,
        "added_by_id": null
    },
    "tuition_schedule_bracket": null,
    "sandbox": true
}

Updates an existing TuitionScheduleStudent object.

HTTP Request

PUT /people/(person)/tuitionschedules/(tuitionschedulestudent)

Parameters

Name Required Data Type Description
tuition_schedule_bracket_id No int

Permissions

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

delete

Example code to call this method:

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

import requests
response = requests.delete(
 'https://yourschool.populiweb.com/api2/people/(person)/tuitionschedules/(tuitionschedulestudent)',
 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)/tuitionschedules/(tuitionschedulestudent)"), 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)/tuitionschedules/(tuitionschedulestudent)');
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": "tuition_schedule_student",
    "id": 1,
    "deleted": true
}

Deletes an existing TuitionScheduleStudent object.

HTTP Request

DELETE /people/(person)/tuitionschedules/(tuitionschedulestudent)

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:

shell ruby python csharp php