API: Configure Project

This API call allows you to change the settings of a Project as controlled in the Configure page such as the Project's tracking mode, or its completion and pass rates.

Before you begin

If you haven't already, you should authenticate against the API as explained in Making your first call to the Project API.

Parameters

There are a number of options available, all of which are optional. The options are detailed in the table below.

Examples

All of these examples have simulation mode turned on. Once you are ready to use in a production environment, remove the simulation parameter (simulation_mode) to allow the changes to apply to your Project.

1. PHP

2. Python

3. Response

PHP

$nonce = get_nonce('https://api.elucidat.com/v2/projects/configure', 'PUBLIC_KEY', 'PRIVATE_KEY');
$headers = auth_headers('PUBLIC_KEY', $nonce);
$fields = array(
    'project_code' => $argv1,
    'allow_completed_pages' => $argv2, // (0-1)
    'allow_future_pages' => $argv3, // (0-1)
    'global_pass_rate' => $argv4, //(0-100)
    'allow_retakes' => $argv5, //(0-1)
    'global_completion_rate' => $argv5, //(0-100)
    'no_partial_scores' => $argv6, //(0-1)
    'tracking_mode' => $argv7, //('scorm_1_2' || 'scorm_2004' || 'scorm_2004_3rd' || 'scorm_2004_4th ||'xapi')
    'scorm_1_2_pass_action' => $argv8, //('passed' || 'completed')
    'xapi_lrs_endpoint_url' => $argv9, //(valid url)
    'xapi_lrs_endpoint_username' => $argv10, //(text)
    'xapi_lrs_endpoint_password' => $argv11, //(text)
    'learner_access' => $argv12, //('any' || 'identify' || 'restricted')
    'simulation_mode' => 'simulation'
);
$result = call_elucidat($headers, $fields, 'POST', 'https://api.elucidat.com/v2/projects/configure', 'PRIVATE_KEY');
echo ("HTTP status code: " . $result['status'] . "\n");
print_r($result['response']);

Python 3.9

     endpoint = '/v2/projects/configure'
     method = 'POST'
     params = {}
     data = {'project_code': '61b64d4492fb7',
            'allow_completed_pages': 1,
            'allow_future_pages': 1,
            'global_pass_rate': 70,
            'allow_retakes': 1,
            'global_completion_rate': 60,
            'no_partial-scores': 0,
            'tracking_mode': 'scorm_1_2',
            'learner_access': 'identify',
            'simulation_mode': 'simulation'}
     api = Api(api_root, endpoint, method, params, data, private_key, public_key)
     api.call_elucidat()
)

Response

{
"message": "Configuration saved"
}