AAU.Ta3leem.Sdk 1.1.20.11
Ta3leem SDK
A comprehensive .NET SDK for integrating with the Iraqi Ministry of Higher Education's Ta3leem API. Provides strongly-typed, resilient interfaces for accessing educational data including organizations, governorates, study years, and student information.
🚀 Quick Start
Installation
# Add the NuGet source (first time only)
dotnet nuget add source https://baget.dev.ostk.creativeadvtech.ml/v3/index.json --name AAU-BaGet
# Install the package
dotnet add package AAU.Ta3leem.Sdk
Basic Setup
using AAU.Ta3leem.Sdk;
builder.Services.AddTa3leemSdk(options =>
{
options.BaseUrl = "https://ums-core-api-stg.mohesr.net";
options.ClientId = "your-client-id";
options.ClientSecret = "your-client-secret";
});
Usage Example
public class StudentController : ControllerBase
{
private readonly ISISFindJuniorService _sisService;
public StudentController(ISISFindJuniorService sisService)
{
_sisService = sisService;
}
[HttpGet("{examNumber}")]
public async Task<IActionResult> GetStudent(string examNumber)
{
var result = await _sisService.FindAsync(new SISFindJuniorRequest
{
JuniorExamNumber = examNumber
});
return result.IsSuccess ? Ok(result.Payload) : BadRequest(result.Message);
}
}
📚 Documentation Catalog
Core Documentation
| Document | Description |
|---|---|
| Getting Started | Installation, configuration, first steps, and examples |
| API Reference | Complete API documentation for all 5 services |
| Data Models | Request/response models and JSON converters |
| Architecture | System design, patterns, and technical implementation |
| Testing Guide | Unit tests, integration tests, and best practices |
| Troubleshooting | Common issues, solutions, and debugging tips |
Additional Resources
| Resource | Description |
|---|---|
| Documentation Index | Complete documentation navigation and statistics |
✨ Key Features
- ✅ 5 Services - Governorate, Organization, StudyYear, UnitType, SISFindJunior
- ✅ Strongly Typed - Full IntelliSense support with typed models
- ✅ Resilient - Built-in retry policies, circuit breaker, and timeout handling
- ✅ Null Safe - Custom converters handle API nulls automatically
- ✅ Score Safe - Numeric fields guaranteed parseable (never throw exceptions)
- ✅ Bilingual - Arabic and English support via LocalizedString
- ✅ Well Tested - 110 tests (65 unit + 45 integration) with 100% pass rate
- ✅ Easy DI - First-class dependency injection support
- ✅ Async/Await - Modern async programming throughout
🏗️ Available Services
| Service | Description | Documentation |
|---|---|---|
| IGovernorateService | Iraqi governorates (provinces) | API Docs |
| IOrganizationService | Educational organizations & institutions | API Docs |
| IStudyYearService | Academic years management | API Docs |
| IUnitTypeService | Unit type classifications | API Docs |
| ISISFindJuniorService | Student information lookup | API Docs |
🤝 Support & Contributing
Documentation
- Full Documentation Index - Navigate all documentation
- Getting Started Guide - Step-by-step setup
- Troubleshooting - Common issues & solutions
Resources
- NuGet Package: AAU.Ta3leem.Sdk
- Company Website: https://aau.iq/
Development
# Clone and setup
git clone <repository-url>
cd ta3leem-sdk-integration
# Restore and build
dotnet restore
dotnet build
# Run tests
dotnet test
📊 Project Structure
ta3leem-sdk-integration/
├── docs/ # 📚 Complete documentation (75+ pages)
├── ta3leem-sdk/ # 📦 SDK library (5 services)
├── ta3leem-sdk-tests/ # 🧪 Tests (110 tests, 100% passing)
├── Directory.Build.props # Version & metadata
└── README.md # This file
📄 About
Asl Al-Uroba (AAU) - Powering Innovation, Delivering Excellence
A leading technology company focused on transforming challenges into opportunities through innovative software solutions for the Iraqi Ministry of Higher Education.
Website: https://aau.iq/
Made with ❤️ by Asl Al-Uroba (AAU)