MealPlanStudent
The MealPlanStudent object
The MealPlanStudent object looks like this in JSON:
{
"object": "meal_plan_student",
"id": 6,
"term_id": 73,
"student_id": 61,
"plan_id": 1,
"amount": 1500,
"adjustment": 0,
"added_at": null,
"added_by_id": null,
"sandbox": true
}
| Attribute | Required | Data Type |
|---|---|---|
| id | Yes | int |
| term_id | Yes | int |
| student_id | Yes | int |
| plan_id | Yes | int |
| amount | Yes | decimal |
| adjustment | Yes | decimal |
| 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)/mealplans" \
-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)/mealplans',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/people/(person)/mealplans',
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)/mealplans"), 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)/mealplans');
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": "meal_plan_student",
"id": 8,
"term_id": 7,
"student_id": 12,
"plan_id": 2,
"amount": 1500,
"adjustment": 0,
"meal_plan": {
"object": "meal_plan",
"id": 2,
"name": "Silver",
"amount": 1255.55,
"status": "active",
"external_account_id": 1,
"account_id": 1,
"added_at": null,
"added_by_id": null
},
"added_at": null,
"added_by_id": null
}
],
"sandbox": true
}
Retrieves all MealPlanStudent objects tied to a specific Person.
HTTP Request
GET /people/(person)/mealplans
Parameters
None
Permissions
One of the following roles is required to call this method:
- Financial Auditor
- Campus Life
- Financial Admin
- Student Billing
create
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/people/(person)/mealplans" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X POST
-d '{
"academic_term_id": 8,
"meal_plan_id": 1
}' \
require 'httparty'
response = HTTParty.post(
'https://yourschool.populiweb.com/api2/people/(person)/mealplans',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
body: {
:academic_term_id => 8,
:meal_plan_id => 1
}.to_json
)
puts response.body
import requests
response = requests.post(
'https://yourschool.populiweb.com/api2/people/(person)/mealplans',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
json={
'academic_term_id': 8,
'meal_plan_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)/mealplans"), Method.Post);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
request.AddJsonBody(new {
academic_term_id = 8,
meal_plan_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)/mealplans');
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,
'meal_plan_id' => 1
]));
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "meal_plan_student",
"id": 183,
"term_id": 8,
"student_id": 12,
"plan_id": 1,
"amount": 1500,
"adjustment": 0,
"meal_plan": {
"object": "meal_plan",
"id": 1,
"name": "Gold",
"amount": 1500,
"status": "active",
"external_account_id": 1,
"account_id": 1,
"added_at": null,
"added_by_id": null
},
"added_at": "2026-07-25T16:24:12+00:00",
"added_by_id": 22,
"sandbox": true
}
Creates a new MealPlanStudent object.
HTTP Request
POST /people/(person)/mealplans
Parameters
| Name | Required | Data Type | Description |
|---|---|---|---|
| academic_term_id | Yes | int | |
| meal_plan_id | Yes | int |
Permissions
One of the following roles is required to call this method:
- Financial Admin
- Student Billing
show
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/people/(person)/mealplans/(mealplanstudent)" \
-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)/mealplans/(mealplanstudent)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/people/(person)/mealplans/(mealplanstudent)',
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)/mealplans/(mealplanstudent)"), 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)/mealplans/(mealplanstudent)');
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": "meal_plan_student",
"id": 7,
"term_id": 8,
"student_id": 16,
"plan_id": 1,
"amount": 1500,
"adjustment": 0,
"meal_plan": {
"object": "meal_plan",
"id": 1,
"name": "Gold",
"amount": 1500,
"status": "active",
"external_account_id": 1,
"account_id": 1,
"added_at": null,
"added_by_id": null
},
"added_at": null,
"added_by_id": null,
"sandbox": true
}
Retrieves a specific MealPlanStudent object.
HTTP Request
GET /people/(person)/mealplans/(mealplanstudent)
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:
- Financial Auditor
- Campus Life
- Financial Admin
- Student Billing
update
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/people/(person)/mealplans/(mealplanstudent)" \
-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)/mealplans/(mealplanstudent)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.put(
'https://yourschool.populiweb.com/api2/people/(person)/mealplans/(mealplanstudent)',
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)/mealplans/(mealplanstudent)"), 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)/mealplans/(mealplanstudent)');
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": "meal_plan_student",
"id": 7,
"term_id": 8,
"student_id": 16,
"plan_id": 1,
"amount": 1500,
"adjustment": 0,
"meal_plan": {
"object": "meal_plan",
"id": 1,
"name": "Gold",
"amount": 1500,
"status": "active",
"external_account_id": 1,
"account_id": 1,
"added_at": null,
"added_by_id": null
},
"added_at": null,
"added_by_id": null,
"sandbox": true
}
Updates an existing MealPlanStudent object.
HTTP Request
PUT /people/(person)/mealplans/(mealplanstudent)
Parameters
| Name | Required | Data Type | Description |
|---|---|---|---|
| meal_plan_id | No | int |
Permissions
One of the following roles is required to call this method:
- Financial Admin
- Student Billing
delete
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/people/(person)/mealplans/(mealplanstudent)" \
-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)/mealplans/(mealplanstudent)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.delete(
'https://yourschool.populiweb.com/api2/people/(person)/mealplans/(mealplanstudent)',
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)/mealplans/(mealplanstudent)"), 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)/mealplans/(mealplanstudent)');
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": "meal_plan_student",
"id": 7,
"deleted": true
}
Deletes an existing MealPlanStudent object.
HTTP Request
DELETE /people/(person)/mealplans/(mealplanstudent)
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:
- Financial Admin
- Student Billing