Overview: The Access API category provides the necessary endpoints to enable external partners to generate simulation deep-links.
Simulation Deep-links
Deep links are URLs that users can copy and paste into their browser to directly access and run a specific simulation in SymTrain. This endpoint generates and returns simulation deep links based on the provided request parameters.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
organizationIdstring · requiredUnique identifier of the Organization.
userIdstring · requiredUsername of the user in Symtrain.
tagsstring[] · requiredList of tags attached to the simulations we want to generate the deep-links for.
mustIncludeAllTagsbooleanIf true, the deep-links will only be generated for simulations that have all the tags in the list. If false, the deep-links will be generated for simulations that have at least one of the tags in the list.
Responses
Successful response with simulation deep links
simulationsobject[] · required
Completion data
This endpoint will retrieve the Completion Data for a specific user and simulation, we can utilize this information to analyze the performance and progress of users in their training.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
organizationIdstring · requiredUnique identifier of the Organization.
userIdstring · requiredUsername of the user in Symtrain.
simulationIdstring · requiredUnique identifier of the simulation.
Responses
Successful response with simulation deep links
completionDataobject[] · required