API: Get Release Details

Gives additional details about a given release.

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:

release_code - arg1 - The code for the release you would like to retrieve the details for.

PHP

Python

Response

PHP

$nonce = get_nonce('https://api.elucidat.com/v2/releases/details', 'PUBLIC_KEY', 'PRIVATE_KEY');
$headers = auth_headers('PUBLIC_KEY', $nonce);
$fields = array(
    'release_code' => $arg1,
    'simulation_mode' => 'simulation'
);
$result = call_elucidat($headers, $fields, 'GET', 'https://api.elucidat.com/v2/releases/details', 'PRIVATE_KEY');
echo ("HTTP status code: " . $result['status'] . "\n");
print_r($result['response']);

Python 3.9

     endpoint = '/v2/releases/details'
     method = 'GET'
     params = {'release_code': 'arg1',
               'simulation_mode': 'simulation'}
     data = {}
     api = Api(api_root, endpoint, method, params, data, private_key, public_key)
     api.call_elucidat()

Response

HTTP status code: 200
Array
(
    [release_code] => 6373624bbd9xx
    [created] => 2022-11-15 09:56:27
    [modified] => 2022-11-15 09:57:23
    [status] => complete
    [description] => 
    [release_views] => 0
    [release_views_this_month] => 0
    [release_passes] => 0
    [release_fails] => 0
    [release_last_view] => 
    [version_number] => 1
    [release_mode] => online-public
    [lrs_endpoint] => https://cloud.scorm.com/lrs/UA5HB0SRP700/statements
    [lrs_endpoint_username] => X
    [learner_access] => identify
    [release_type] => standard
    [project] => Array
        (
            [name] => Home Automation on a Budget
            [project_code] => 6033d7b58ca2g
            [last_bookmark_clearing_edit] => 2021-12-07 11:05:04
        )

    [timezone] => UTC
    [cosmetic_rerelease_available] => 1
    [download_url] => 
    [launch_url] => https://learning.elucidat.com/course/6033d7b58ca2g-6373624bbd9xx
    [edit_url] => https://app.elucidat.com/projects/edit/6033d7b58ca2g
    [user] => Array
        (
            [email] => test@elucidat.com
            [name] => Test User
        )

)