Technical Data Documentation
This page provides machine-readable specifications for the AAR dataset structure, ensuring interoperability and transparency.
Dataset Metadata (Dublin Core Aligned)
Every report release includes the following machine-readable metadata:
{
"title": "Student Academic Progress Report",
"description": "Biweekly academic performance metrics and teacher feedback",
"publisher": "Archov Technologies Ltd.",
"identifier": "UUIDv4",
"language": "en-GH",
"theme": "Education",
"spatial": "Republic of Ghana",
"accrualPeriodicity": "Biweekly"
}
Report Schema (JSON)
Our data follows a strict schema to ensure quality and consistency.
// StudentReport Interface Specification
{
"student_id": "string (UUID)",
"period_start": "ISO-8601 Date",
"period_end": "ISO-8601 Date",
"overall_average": "float (0.00 - 100.00)",
"integrity_hash": "string (SHA-256 hex)",
"grades": [
{
"subject": "string",
"score": "float",
"rank": "integer"
}
]
}
Data Codes & Definitions
To ensure consistency across different schools, AAR utilizes a standardized set of codes for subjects and grade levels.
- Subject Codes: Standardized shorthands (e.g.,
MATHfor Mathematics,ENGfor English Language) are used within machine-readable exports. - Level Codes: Grade levels are codified from
B1throughB6(Basic 1-6) andJHS1throughJHS3(Junior High School 1-3).
Vocabularies & Standards
We utilize the following open standards for data description:
- ISO-8601: For all temporal data and timestamps.
- UUID (RFC 4122): For all persistent identifiers.
- SHA-256: For data integrity and provenance verification.
Tools & Resources
We recommend the following official tools for working with AAR data:
- Report Verification Portal: The primary tool for parents and third parties to cryptographically verify report integrity.
- AAR School Dashboard: A secure, web-based tool for schools to manage, analyze, and export their datasets in machine-readable formats.
- CSV Analyzer: Any standard spreadsheet software (Excel, Google Sheets) can be used to process AAR's machine-readable CSV exports.