API: Edit a Project

Edits an existing project within an account

All of these examples have simulation mode turned on. Once you are ready to use in a production environment, you can remove the simulation parameter. Any changes will then affect your account.

The following arguments are available against this endpoint:

project_code - arg1 - The code for the project you would like to edit.

name - arg2 - A new name for the project (this is optional).

folder - arg3 - Id of the folder that the project should be assigned to. (this is optional).

PHP

Python

Response

PHP

$nonce = get_nonce('https://api.elucidat.com/v2/projects', 'PUBLIC_KEY', 'PRIVATE_KEY');
$headers = auth_headers('PUBLIC_KEY', $nonce);
$fields = array(
    'project_code' => $_arg1,
    'name' => $arg2,
    'folder' => $arg3,
    'simulation_mode' => 'simulation'
);
$result = call_elucidat($headers, $fields, 'POST', 'https://api.elucidat.com/v2/projects/edit', 'PRIVATE_KEY');
echo ("HTTP status code: " . $result['status'] . "\n");
print_r($result['response']);

Python 3.9

     endpoint = '/v2/projects/edit'
     method = 'POST'
     params = {}
     data = {'project_code': 'arg1',
                'name': 'arg2',
                'folder': 'arg3',
                'simulation_mode': 'simulation'}
     api = Api(api_root, endpoint, method, params, data, private_key, public_key)
     api.call_elucidat()

Response

{
HTTP status code: 200
Array
(
    [id] => 608354
    [project_code] => 639b267f8hd1b
    [user_profile_id] => 15998
    [name] => Test Course
    [template_id] => 0
    [theme] => master_theme
    [theme_translations] => 
    [theme_version_number] => 1
    [created] => 2022-12-15 13:51:59
    [modified] => 
    [created_by] => 367900
    [modified_by] => 
    [last_destructive_change] => 2023-02-20 10:36:09
    [published] => 1
    [project_type] => master_course
    [deleted] => 0
    [allow_completed_pages] => 1
    [allow_future_pages] => 1
    [allow_retakes] => 1
    [global_pass_rate] => 70
    [questionnaire_pass_rate] => 70
    [scorm_mode] => tincan
    [auto_shuffle_pools] => 1
    [pass_action] => completed
    [project_views] => 0
    [project_views_this_month] => 0
    [project_passes] => 0
    [project_fails] => 0
    [project_last_view] => 
    [global_completion_rate] => 90
    [project_key] => a5651ad6-7c7f-11ed-a3a3-02b9cdc
    [project_completions] => 0
    [google_analytics_code] => 
    [language] => en-GB
    [screengrab] => 
    [wizard_options] => 
    [lrs_endpoint] => https://cloud.scorm.com/lrs/UA5HB0SRP800/statements
    [lrs_endpoint_username] => X
    [lrs_endpoint_password] => Y
    [learner_access] => any
    [learner_identify_email] => 
    [learner_identify_subject] => 
    [colorway] => 
    [no_partial_scores] => 0
    [theme_skin_id] => 40975
    [obfuscate_learner_data] => 0
    [last_translation_import] => 0000-00-00 00:00:00
    [last_translation_export] => 2021-11-29 09:27:30
    [name_in_release] => 
    [project_description] => 
    [enable_success_factors_support] => 0
    [blueprint_project_code] => 
    [use_learner_service] => 0
    [is_locked] => 0
    [config_inheritance] => no_variations_inherit
    [enable_xapi_for_scorms] => 1
    [template] => 
    [template_code] => 
    [learner_restrict_domains] => Array
        (
        )

)

}