Get Communication Type(s)

Retrieve debtor note types

GET https://integrate.d6plus.co.za/api/v1/finplus/debtmanagement/debtornotes/communicationtypes/{school_login_id}

Use this endpoint to retrieve the list of available debtor note communication types. By default all available communication types are returned.

It is possible to retrieve the information for a single communication type by providing the optional communication_type_id query parameter.

Path Parameters

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

Headers

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

Query Parameters

Name	Type	Description
communication_type_id	Integer	The id of the communication type to retrieve

Reponse Examples

200 The request was successful.

[
    {
        "id": "1",
        "name": "SMS"
    },
    {
        "id": "2",
        "name": "E-mail"
    },
    {
        "id": "3",
        "name": "Telephonic"
    },
    ...
]

404: Not Found The resource was not found.

{
    "error": "Not Found",
    "error_description": "The communication type does not exist"
}

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 Finance+ API for this client before making this request"
}

Code Samples

PHP

<?php

const BASE_URL = 'https://integrate.d6plus.co.za/api/v1/finplus/debtmanagement/debtornotes/notetypes';
const SCHOOL_LOGIN_ID = '1000';
const PARAMS = [
    'note_type_id' => 2
    ];
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/finplus/debtmanagement/debtornotes/notetypes/1000?note_type_id=2' \
--header 'HTTP-X-USERNAME: your_username' \
--header 'HTTP-X-PASSWORD: your_password'