Get Staff Member(s)

Get one or more staff member records

GET https://integrate.d6plus.co.za/api/v1/adminplus/staffmembers/{school_login_id}

Use this endpoint to fetch one or more staff member records for the specified school. By default all current active staff members will be returned.

It is possible to retrieve a single staff member by providing the optional staff_member_id query parameter.

Path Parameters

Name	Type	Description
school_login_id*	Integer	The login ID of the school to retrieve data from

Query Parameters

Name	Type	Description
staff_member_id	Integer	The ID of a specific staff member

Headers

Name	Type	Description
HTTP-X-USERNAME*	String	As provided by d6
HTTP-X-PASSWORD*	String	As provided by d6

200 The request was successful.

[
    {
        "id": "1",
        "title": "Mr",
        "first_name": "John",
        "last_name": "Smith",
        "mobile_calling_code": "27",
        "mobile_number": "0823456789",
        "email_address": "[email protected]",
        "date_of_birth": "1967-02-14",
        "gender": "M",
        "ethnic_group": "White",
        "residential_address": "Plot 101\r\nDaffodil Street\r\nPretoria",
        "postal_address": "PO Box 12\r\nMenlyn\r\nPretoria",
        "home_language": "English",
        "nationality": "South Africa",
        "id_number": "6702145076084",
        "passport_number": "A0176543",
        "marital_status_id": "Married",
        "employment_category": "Finance",
        "is_educator": "Yes",
        "appointment_type": "Temporary",
        "paid_by": "Department of Education",
        "sace_number": "123456",
        "register_classes": "2A"
    },
    {
        "id": "2",
        "title": "Mrs",
        "first_name": "Jane",
        "last_name": "Smith",
        "mobile_calling_code": "27",
        "mobile_number": "0798765432",
        "email_address": "[email protected]",
        "date_of_birth": "1955-06-17",
        "gender": "F",
        "ethnic_group": "African/Black",
        "residential_address": "Plot 101\r\nDaffodil Street\r\nPretoria",
        "postal_address": "PO Box 12\r\nMenlyn\r\nPretoria",
        "home_language": "English",
        "nationality": "South Africa",
        "id_number": "5506170079082",
        "passport_number": "",
        "marital_status_id": "Married",
        "employment_category": "Head Of Department",
        "is_educator": "No",
        "appointment_type": "Permanent",
        "paid_by": "Governing Body",
        "sace_number": "234567",
        "register_classes": "1A,2B,5A"
    }
]

404: Not Found The resource was not found.

{
    "error": "Not found",
    "error_description": "No staff member records found"
}

401: Unauthorized The server understood the request, but is refusing it or access is not allowed.

{
    "error": "Unauthorized",
    "error_description": "Client access not authorised"
}

403: Forbidden The server understood the request, but the requested action is not allowed.

{
    "error": "Integration not activated",
    "error_description": "Please activate the Admin+ API for this client before making this request"
}

Examples

PHP

<?php

const BASE_URL = 'https://integrate.d6plus.co.za/api/v1/adminplus/staffmembers';
const SCHOOL_LOGIN_ID = '1000';
const PARAMS = ['staff_member_id' => 1];
const API_USERNAME = getenv('API_USERNAME'); // Assuming you have these environment variables set
const API_PASSWORD = getenv('API_PASSWORD');

$curl = curl_init();

$query = http_build_query(PARAMS);

$options = [
    CURLOPT_URL => BASE_URL . '/' . SCHOOL_LOGIN_ID . '?' . $query,
    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

curl --location 'https://integrate.d6plus.co.za/api/v1/adminplus/staffmembers/1000?staff_member_id=1' \
--header 'HTTP-X-USERNAME: your_username' \
--header 'HTTP-X-PASSWORD: your_password'