Last updated 9 months ago
GET https://integrate.d6plus.co.za/api/v1/adminplus/school/{school_login_id}
GET
https://integrate.d6plus.co.za/api/v1/adminplus/school/{school_login_id}
Use this endpoint to fetch the information for the specified school.
school_login_id*
Integer
The login ID of the school to retrieve data from
HTTP-X-USERNAME*
String
As provided by d6
HTTP-X-PASSWORD*
{ "school_name": "d6+ Primary School", "admin_email_address": "support@d6plus.co.za", "telephone_calling_code": "27", "telephone_number": "0123334444", "website": "https://d6.co.za/", "physical_address": "Pegasus Building 1, 3rd Floor\r\nMercy Avenue\r\nWaterkloof Glen Ext 2 \r\nPretoria", "quantile": "4", "medium": "Dual medium", "emis_number": "999999999", "country": "South Africa", "province": "Gauteng", "tuition_languages": [ "Afrikaans", "English" ] }
{ "error": "Not found", "error_description": "No school record found" }
{ "error": "Unauthorized", "error_description": "Client access not authorised" }
{ "error": "Integration not activated", "error_description": "Please activate the Admin+ API for this client before making this request" }
<?php const BASE_URL = 'https://integrate.d6plus.co.za/api/v1/adminplus/school'; const SCHOOL_LOGIN_ID = '1000'; const API_USERNAME = getenv('API_USERNAME'); // Assuming you have these environment variables set const API_PASSWORD = getenv('API_PASSWORD'); $curl = curl_init(); $options = [ CURLOPT_URL => BASE_URL . '/' . SCHOOL_LOGIN_ID, CURLOPT_RETURNTRANSFER => true, CURLOPT_SSL_VERIFYPEER => true, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => [ "HTTP-X-USERNAME: " . API_USERNAME, "HTTP-X-PASSWORD: " . API_PASSWORD ], ]; curl_setopt_array($curl, $options); $response = curl_exec($curl); if (curl_errno($curl)) { throw new Exception('Curl error: ' . curl_error($curl)); } curl_close($curl); echo $response;
curl --location 'https://integrate.d6plus.co.za/api/v1/adminplus/school/1000' \ --header 'HTTP-X-USERNAME: your_username' \ --header 'HTTP-X-PASSWORD: your_password'