Integrate
Integrate v2
Integrate v2
  • Getting Started
    • 🤝Authorisation & Activation
    • 🔗API v2 URL
    • 🔢Versioning
    • 🔐Authentication
    • 🟰Additional Headers
    • 🆗Response Status Codes
    • 🛑Rate Limiting
    • ⁉️Errors and Bad Requests
    • 📖Pagination
    • ⏭️Upgrading to v2
  • Reference
    • Settings
      • Client Integrations
        • Get Client Integrations
        • Change Client Integration State
    • Finance+
      • Debt Management
        • Debtor Notes
          • Get Communication Type(s)
          • Get Note Type(s)
          • Get Note(s)
          • Create Note
          • Update Note
          • Delete Note
          • Get Promise To Pay Record(s)
          • Delete Promise To Pay
        • Age Analysis Report
        • Financial Transactions Report
        • Get Schools
        • Get Accountable Person(s)
        • Get Learner(s)
        • Get Transaction Type(s)
        • Get Transaction Category(s)
Powered by GitBook
On this page
  • Get the list of available languages
  • Examples
  1. Reference
  2. Administration+
  3. Lookups

Language(s)

Get the list of available languages

GET https://integrate.d6plus.co.za/api/v1/adminplus/lookup/language/{language_id}

Use this endpoint to retrieve the list of available languages within the d6+ SAMS. The list is generic across all d6+ SAMS clients. By default all available languages are returned.

It is possible to retrieve the information for a single languages by providing the optional language_id query parameter.

Path Parameters

Name
Type
Description

language_id

Integer

The ID of the language 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": "Afrikaans"
    },
    {
        "id": "2",
        "name": "English"
    },
    {
        "id": "3",
        "name": "Ndebele"
    },
    {
        "id": "4",
        "name": "Swazi"
    },
    {
        "id": "5",
        "name": "Xhosa"
    }
]
{
    "error": "Not found",
    "error_description": "No language(s) found"
}
{
    "error": "Unauthorized",
    "error_description": "Request not authorised"
}

Examples

<?php

const BASE_URL = 'https://integrate.d6plus.co.za/api/v1/adminplus/lookup/language';
const LANGUAGE_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 . '/' . LANGUAGE_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/lookup/language/1' \
--header 'HTTP-X-USERNAME: your_username' \
--header 'HTTP-X-PASSWORD: your_password'
❗
❗
❗