Create new releases or re-release existing courses.
| Note: Before using this call, you'll need to authenticate against the API as detailed in Making your first call to the Project API. |
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 table details the parameters available:
| Parameters | Possible values | Description |
|---|---|---|
| project_code | (text) | A unique code that identifies the project |
| release_mode | ('online-public', 'online-private', 'scorm', 'offline-backup') | The type of release to be made |
| release_code | (text) | (Optional) If the release is intended as a re-release, this will be the unique code used to identify the original release |
| description | (text) | (Optional) A human friendly note that can be used to identify this release |
| xapi_lrs_endpoint_url | (url) | (Optional) URL to your own Tincan/xapi endpoint (will use the project configuration if not given) |
| xapi_lrs_endpoint_username | (text) | (Optional) Tincan/xapi endpoint username (will use the project configuration if not given) |
| xapi_lrs_endpoint_password | (text) | (Optional) Tincan/xapi endpoint password (will use the project configuration if not given) |
| learner_access | ('any', 'identify', 'restricted') | (Optional) Who can access the course: 'any' - allow unrestricted access 'identify' - learners must identify themselves via email 'restricted' - learners must have a valid invitation via the API (will use the project configuration if not given) |
PHP
$nonce = get_nonce('https://api.elucidat.com/v2/releases/create', 'PUBLIC_KEY', 'PRIVATE_KEY');
$headers = auth_headers('PUBLIC_KEY', $nonce);
$fields = array(
'project_code' => $arg1,
'release_mode' => $arg2,
'release_code' => $arg3,
'simulation_mode' => 'simulation'
);
$result = call_elucidat($headers, $fields, 'POST', 'https://api.elucidat.com/v2/releases/create', 'PRIVATE_KEY');
echo ("HTTP status code: " . $result['status'] . "\n");
print_r($result['response']);Python 3.9
endpoint = '/v2/releases/create'
method = 'POST'
data = {'project_code': 'arg1',
'release_mode': 'arg2',
'simulation_mode': 'simulation'}
params = {}
api = Api(api_root, endpoint, method, params, data, private_key, public_key)
api.call_elucidat()Response
{
"release_code": "example-release-code",
"message": "Release is being prepared."
}