Access API (2.0.0)

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.

This endpoint retrieves Completion Data for all simulation executions (started, interrupted, and completed) for a specific user and simulation, we can utilize this information to analyze the performance and progress of users in their training.

Important: The response includes all execution attempts, regardless of their completion status. To distinguish between completed and incomplete executions:

• Completed executions: Both completedAt and completionTime fields will have valid values
• Incomplete executions: Both completedAt and completionTime fields will be null

Score fields (symScore, accuracyScore, keywordScore, clickScore, and sentimentScores) will also be null for incomplete executions.

This comprehensive data allows you to analyze both successful completions and execution patterns, including incomplete attempts.

This endpoint will return all simulations available in the SymTrain library for a specific organization. The items in the response will be filtered by the organizationId, the provided tags, the searchTerm and pagination parameters.

This endpoint allows you to assign or unassign a specific simulation to/from a user. When assigning a simulation, the endpoint returns the simulation details including a deep-link URL for direct access. When unassigning, it simply returns a success status with no response body.

To access SymTrain application without the need of entering their credentials on the login page, this endpoint generates a short-lived access token (valid for 1 hour) that allows impersonation of users. The token can be used as a query parameter in simulation deep-links to provide seamless access.

Usage Example: If you have a simulation deep-link from the simulation assignment endpoint, add the token as a query parameter: https://symtrain.com/your-org-id/simulation/532339d1-e3ac-4613-a259-34ec24936d56?token=your_token_here

This endpoint allows you to bulk import users by uploading a CSV file containing user data. The import process is asynchronous and returns a taskId that can be used to track the import status using the bulk import status endpoint.

Request Format:

• Content-Type: multipart/form-data
• Include organizationId field and CSV file in the form data

CSV File Requirements:

• Must include proper headers
• Should contain user information in the expected format
• Maximum of 750 records allowed per file
• A taskId will only be generated if the CSV file contains at least one valid user

Process Flow:

1. Upload CSV file with organizationId
2. Receive taskId for tracking (only if valid users exist in the file)
3. Use /v2/access-api/user/bulk-import/status to monitor progress

The User Bulk import endpoint will return a generated async taskId, in order to validate if the import of the valid user records were successful, we must use this taskId and create a polling mechanism that calls this new endpoint to validate the status of the asynchronous task.

Status Flow:

• On success: SCHEDULED → STARTED → COMPLETED
• On error: SCHEDULED → STARTED → FAILED

This endpoint validates if a user exists in the specified organization and returns their data. If the user does not exist, it creates a new trainee user and returns the created user data.

Important Notes:

• Only supports creating users with the 'trainee' role
• Email and username must be identical
• Returns existing user data if user already exists
• Creates new user if user doesn't exist