○ API calls - Profiles
These API calls make it possible to:
- get information about existing profiles
- check which profiles a learner is linked to
- add users to profiles or remove them from the profiles
Context
aNewSpring has profiles and competencies. A profile is a way to link competencies to a learner. The learner will see the progress on the competencies per profile.
Support articles:
- Profiles & Competencies - Introduction
- P&C - Core concepts
- Example use cases for P&C
- Creating profiles and linking learners
- Profiles & competencies from the learner's perspective
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 Profile is called a Skill profile.
API calls
The Skill profile API calls are only available when the Profile functionality have been enabled by the Tenant at the tab Settings.
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.
GET requests
GET /getSkillProfiles
Use this to get all profiles.
GET /getStudentSkillProfiles/{userID}
or GET /getStudentSkillProfiles?userUID={userUID}
Use this to get all profiles that a user is linked to. You will need to use the external ID (userID) or UID (userUID) of the user.
POST requests
POST /addSkillProfileUsers/{skillProfileID}
or POST /addSkillProfileUsers?skillProfileUID={skillProfileUID}
Use this to link a user to an existing profile. You will need to use the external ID of the profile and the users, which can be sent as an array in the parameter user, by repeating the same parameter with different values. Instead of the external IDs of the users, you can also use the UIDs of the users as an array in the parameter userUID.
POST /deleteSkillProfileUsers/{skillProfileID}
or POST /deleteSkillProfileUsers?skillProfileUID={skillProfileUID}
Use this to unlink a user from an existing profile. You will need to use the external ID of the profile and external IDs of the users, which can be sent as an array in the parameter user, by repeating the same parameter with different values. Instead of the external IDs of the users, you can also use the UIDs of the users as an array in the parameter userUID.