These API calls should only be used if your learning environment has been set up to use submanagement. This is a feature that is not enabled by default and has a major impact on how the administration part of the learning environment works. It can only be enabled after contact with aNewSpring. More information

The API calls make it possible to

  • (Un)link events and subenvironments
  • (Un)link user groups and subenvironments
  • (Un)link templates and subenvironments
  • (Un)link users and subenvironments

Context

If submanagement is enabled, everything that can be managed in the learning environment can be separated per subenvironment.
A learning environment can have multiple subenvironments and this will always be the case if submanagement has been enabled for a learning environment. These subenvironments are separate "entrances" for the learning environment. Administrators can have administrations rights for one or more subenvironments and will only see entities that are linked to the subenvironments that their administration rights give access to.

The entities that you can link to a subenvironment are events, user groups, templates and users.

There are more possibilities with the API for these entities, which you will find here:

  • API calls - Events
  • API calls - User groups
  • API calls - Courses (for templates)
  • API calls - Users

Support articles:

  • Submanagement
  • Subenvironments

For historical reasons and to continue to support old API integrations, the terminology of the API and the front-end for administrators does not always match completely. In the API:

  • A Subenvironment is called a Reseller. The "Reseller" entity is not to be confused with the reseller user role.
  • An Event is called a BookableEvent. This is not to be confused with Calendar items, which are called "Event" in the API. Calendar items are not part of the API calls in the support article.

API calls

You can view more information and an example of each API call in the API Documentation by clicking the titles below. However, all links go to the /apidocs page of a demo environment that you cannot use for your own testing purposes.
To test the API calls, you will need to change the first part of the URL to match the right learning environment.

POST requests

POST /addResellerBookableEvents/{resellerID}
Use this to link events to a subenvironment. You will need to use the external ID of the subenvironment (resellerID) and the external IDs of the events, which can be sent as an array in the parameter event, by repeating the same parameter with different values.

POST /addResellerGroups/{resellerID}
Use this to link user groups to a subenvironment. You will need to use the external ID of the subenvironment (resellerID) and the external IDs of the user groups, which can be sent as an array in the parameter group, by repeating the same parameter with different values.

POST /addResellerTemplates/{resellerID}
Use this to link templates to a subenvironment. You will need to use the external ID of the subenvironment (resellerID) and the external IDs of the templates, which can be sent as an array in the parameter template, by repeating the same parameter with different values.

POST /addResellerUsers/{resellerID}
Use this to link users to a subenvironment. You will need to use the external ID of the subenvironment (resellerID) and the external IDs of the users, which can be sent as an array in the parameter user, by repeating the same parameter with different values.

POST /deleteResellerBookableEvents/{resellerID}
Use this to unlink events from a subenvironment. You will need to use the external ID of the subenvironment (resellerID) and the external IDs of the events, which can be sent as an array in the parameter event, by repeating the same parameter with different values.

POST /deleteResellerGroups/{resellerID}
Use this to unlink user groups from a subenvironment. You will need to use the external ID of the subenvironment (resellerID) and the external IDs of the user groups, which can be sent as an array in the parameter group, by repeating the same parameter with different values. 

POST /deleteResellerTemplates/{resellerID}
Use this to unlink templates from a subenvironment. You will need to use the external ID of the subenvironment (resellerID) and the external IDs of the templates, which can be sent as an array in the parameter template, by repeating the same parameter with different values.

POST /deleteResellerUsers/{resellerID}
Use this to unlink users from a subenvironment. You will need to use the external ID of the subenvironment (resellerID) and the external IDs of the users, which can be sent as an array in the parameter user, by repeating the same parameter with different values.

There is no API call in this list to link courses to subenvironments, because you can only do this when the course is created (instantiated) from the template. You can use the API call /instantiate/{templateID}/{courseID} which you will find in this article.