Ethnic Group(s)
Get the list of available ethnic groups
GET
https://integrate.d6plus.co.za/api/v1/adminplus/lookup/ethnicgroup/{ethnic_group_id}
Use this endpoint to retrieve the list of available ethnic groups within the d6+ SAMS. The list is generic across all d6+ SAMS clients. By default all available ethnic groups are returned.
It is possible to retrieve the information for a single ethnic group by providing the optional ethnic_group_id
query parameter.
Path Parameters
Name
Type
Description
ethnic_group_id
Integer
The ID of the ethnic group to retrieve
Headers
Name
Type
Description
HTTP-X-USERNAME*
String
As provided by d6
HTTP-X-PASSWORD*
String
As provided by d6
[
{
"id": "1",
"name": "African/Black"
},
{
"id": "2",
"name": "Coloured"
},
{
"id": "3",
"name": "Indian"
},
{
"id": "4",
"name": "White"
},
{
"id": "5",
"name": "Other"
},
{
"id": "6",
"name": "Asian"
}
]
Examples
<?php
const BASE_URL = 'https://integrate.d6plus.co.za/api/v1/adminplus/lookup/ethnicgroup';
const ETHNIC_GROUP_ID = '1';
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 . '/' . ETHNIC_GROUP_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;
Last updated