Change Client Integration State

Change the state of the client integration

PATCH https://integrate.d6plus.co.za/api/v1/settings/clients/{school_login_id}

Use this endpoint to change the state of the integration for a client who has authorised your integration in their d6+ SAMS instance. This state indicates whether you are actively servicing the client or not.

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

Request Body

Name	Type	Description
state*	Integer	The state you would like to set the integration to
api_type_id*	Integer	The api_type_id returned by the Get Clients endpoint

200 The request was successful.

[]

404: Not Found The resource was not found.

{
    "error": "Not found",
    "error_description": "No client-authorised integrations found"
}

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

{
    "error": "Unauthorized",
    "error_description": "Client access not authorised for this API type"
}

500: Internal Server Error The server experienced an error while attempting to perform the requested action.

{
    "error": "Internal Server Error",
    "error_description": "Failed to update the integration state"
}

400: Bad Request The request was invalid. Normally due to missing or malformed parameters.

{
    "error": "Bad Request",
    "error_description": "Invalid integration state provided"
}

204: No Content The request was understood and processed, but no changes were made.

[]

Examples

PHP

<?php

const BASE_URL = 'https://integrate.d6plus.co.za/api/v1/settings/clients';
const SCHOOL_LOGIN_ID = '1000';
const API_USERNAME = getenv('API_USERNAME'); // Assuming you have these environment variables set
const API_PASSWORD = getenv('API_PASSWORD');

$data = [
    "api_type_id" => 8,
    "state" => 1
]; 
$jsonData = json_encode($data);

$curl = curl_init();

$query = http_build_query(PARAMS);

$options = [
    CURLOPT_URL => BASE_URL . '/' . SCHOOL_LOGIN_ID,
    CURLOPT_URL => BASE_URL,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_SSL_VERIFYPEER => true,
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    CURLOPT_POSTFIELDS => $jsonData,    
    CURLOPT_HTTPHEADER => [
        "HTTP-X-USERNAME: " . API_USERNAME,
        "HTTP-X-PASSWORD: " . API_PASSWORD,
        "Content-Type: application/json",
        "Content-Length: " . strlen($jsonData)        
    ],
];

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 --request PATCH 'https://integrate.d6plus.co.za/api/v1/settings/clients/1000' \
--header 'HTTP-X-USERNAME: YOUR_API_USERNAME' \
--header 'HTTP-X-PASSWORD: YOUR_API_PASSWORD' \
--header 'Content-Type: application/json' \
--data '{"api_type_id": 8, "state": 1}'