Dear customers,
Dokeos works daily to improve the performance of its LMS. With this in mind, the product team has been working relentlessly for several months on several aspects of the platform, in particular the API points.
If you use Dokeos to integrate with other systems and use APIs to make exchanges, this article is important and you may need to carry out some checks on your mechanisms.
Of course, we won't leave you to your own devices, and we're more than happy to guide you through these changes. Please do not hesitate to contact your Dokeos project manager, who will arrange a meeting with the people concerned.`
Attention, the changes mentioned above will be applied on production on September 30 2024. If you want to test and validate before, please tell your project manager.
Decommissioning API V1
By consulting your API documentation, you can select API V1 or API V2 in the top right-hand corner. By default, the second version is displayed. It's also the one that benefits from all new features, updates, etc.
Version 1 will be completely withdrawn from our services on September 30, 2024.
To find out whether you're on V1 or V2, simply check the value of your “ACCEPT” in the header of your API calls.
ACCEPT = application/vnd.dokeos+json;version=1
This means you're in V1.
ACCEPT = application/vnd.dokeos+json;version=2
This means you are already in V2.
To migrate your system from V1 to V2, please consult the respective documentation for each version to see the changes.
Please note that some calls will also be subject to other changes mentioned below.
In addition to this deprecation, we changed some elements on calls from the API V2. Here are the details :
GET /participations
By default, a page will contain 20 elements
The “progressions” attribute, which contains a learner's progress by module, will no longer be returned by default. If you need to read the progressions, you'll need to add to the call
?response_attributes=progressions
The “training_ids” field can contain no more than 5 elements.
The “user_ids” field can contain no more than 5 elements.
GET/ participations/:id
The “progressions” attribute, which contains a learner's progress by module, will no longer be returned by default. If you need to read the progressions, you'll need to add to the call
?response_attributes=progressions
GET /users
By default, a page will contain 20 elements
The attributes “group_ids”, “role_names”, “tag_ids” and “skills” are no longer returned by default. If you need to read this information, you'll need to add to the call
?response_attributes=group_ids,role_names,tag_ids,skills
DELETE /user/:id
The deletion process is performed asynchronously. The API will return a “job_id” value, allowing you to check the status of the request. This “job_id” has a lifetime of one week.
To check the status of the request, a new call point has been created:/jobs/:job_id
PUT /presence_sessions/:id/sync & PUT /presence_sessions/sync
PUT /webinar_sessions/:id/sync & PUT /webinar_sessions/sync
The synchronization process will be performed asynchronously. The API will return a “job_id” value for each session, enabling you to check the status of the request.
This “job_id” has a lifetime of one week.
To check the status of the request, a new call point has been created:/jobs/:job_id
GET /groups
By default, a page will contain 20 elements
POST/PUT /groups
The following actions will be performed asynchronously. The API will return a “job_id” value, allowing you to check the status of the request.
This “job_id” has a lifetime of one week.
To check the status of the request, a new call point has been created:/jobs/:job_id
Add/delete a learner
Add/delete a manager
Creation/deletion of a participation
PUT /training_gate/:id
Modifying the training_gate will be done asynchronously. The API will return a “job_id” value, allowing you to check the status of the request.
This “job_id” has a lifetime of one week.
To check the status of the request, a new call point has been created:/jobs/:job_id
Thank you for your comprehension and collaboration on this subject.
Rest assured that we are completely devoted to make things more reliable and powerful.
We remain at your service to provide you all the help needed.
The Dokeos Product Team.