Get enrollment tracker
curl --request GET \
--url https://{host}/primula/api/v3/enrollment_tracker \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/primula/api/v3/enrollment_tracker"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/primula/api/v3/enrollment_tracker', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/primula/api/v3/enrollment_tracker",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{host}/primula/api/v3/enrollment_tracker"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/primula/api/v3/enrollment_tracker")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/primula/api/v3/enrollment_tracker")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"school_id": "<string>",
"school_name": "<string>",
"rooms": [
{
"room_id": "<string>",
"room_name": "<string>",
"room_capacity": 123,
"staff_ratio": "<string>",
"room_age_low": 123,
"room_age_high": 123,
"periods": [
{
"period": "<string>",
"total_occupied_spaces": 123,
"is_over_enrolled": true,
"spaces": [
{
"slot": 123,
"is_first_available": true,
"is_on_room_capacity": true,
"space_status": "<string>",
"student": {
"student_id": "<string>",
"student_name": "<string>",
"procare_student_status": "<string>",
"birth_date": "<string>",
"age": 123,
"room_age": 123,
"transition_date_is_past_date": true,
"is_first_period_in_room_due_to_transition": true,
"is_age_less_than_room_age_low": true,
"is_age_greater_than_room_age_high": true,
"has_been_enrolled_for_over_room_days_limit": true,
"is_transition_date_within_days_limit": true,
"start_date": "<string>",
"withdrawal_date": "<string>",
"transition_date": "<string>"
}
}
]
}
]
}
]
}Enrollment tracker
Get enrollment tracker
Requires school_id assigned to the session. Returns the school tracker grid and computed enrollment information, optionally narrowed by room_id and monthly period. Returns 404 if the tracker is absent.
GET
/
enrollment_tracker
Get enrollment tracker
curl --request GET \
--url https://{host}/primula/api/v3/enrollment_tracker \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/primula/api/v3/enrollment_tracker"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/primula/api/v3/enrollment_tracker', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/primula/api/v3/enrollment_tracker",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{host}/primula/api/v3/enrollment_tracker"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/primula/api/v3/enrollment_tracker")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/primula/api/v3/enrollment_tracker")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"school_id": "<string>",
"school_name": "<string>",
"rooms": [
{
"room_id": "<string>",
"room_name": "<string>",
"room_capacity": 123,
"staff_ratio": "<string>",
"room_age_low": 123,
"room_age_high": 123,
"periods": [
{
"period": "<string>",
"total_occupied_spaces": 123,
"is_over_enrolled": true,
"spaces": [
{
"slot": 123,
"is_first_available": true,
"is_on_room_capacity": true,
"space_status": "<string>",
"student": {
"student_id": "<string>",
"student_name": "<string>",
"procare_student_status": "<string>",
"birth_date": "<string>",
"age": 123,
"room_age": 123,
"transition_date_is_past_date": true,
"is_first_period_in_room_due_to_transition": true,
"is_age_less_than_room_age_low": true,
"is_age_greater_than_room_age_high": true,
"has_been_enrolled_for_over_room_days_limit": true,
"is_transition_date_within_days_limit": true,
"start_date": "<string>",
"withdrawal_date": "<string>",
"transition_date": "<string>"
}
}
]
}
]
}
]
}Authorizations
Access token issued by POST /sessions and associated with a valid server-side session.
Query Parameters
Company UUID. Must equal the authenticated session company when that session has a company assigned; the equality check is skipped for sessions without one.
School UUID. Must be assigned to the authenticated session.
Optional room UUID.
Optional monthly period in YYYY-MM.
Pattern:
^\d{4}-(0[1-9]|1[0-2])$