Voor de meeste API calls heb je een externe ID nodig. Externe ID's worden handmatig ingesteld door een beheerder en/of ontwerper in de leeromgeving. Als je externe ID's niet handmatig wilt instellen, kun je in veel gevallen ook een automatisch gegenereerde UID gebruiken. Er zijn uitzonderingen voor API calls waarbij je iets nieuws (bijvoorbeeld een nieuwe gebruiker of uitvoering) aanmaakt, omdat je daar dan wel een extern ID voor moet instellen.

Voor de meeste API calls is het altijd verplicht om of een externe ID of een UID te gebruiken (als die mogelijkheid er is). Je kunt een overzicht van toegestane parameters vinden voor elke API call op de /apidocs-pagina. UID's staan aangegeven als query parameters (in plaats van path) en soms als formData.

Als je een UID in de URL van de API call wilt gebruiken, moet dit altijd een query parameter zijn. Alleen externe IDs mogen als path parameter worden gebruikt. Deze laatste is de standaard manier waarop API calls staan weergegeven in onze documentatie.

Voorbeeld van een externe ID als path parameter

https://demo.anewspring.com/api/updateUser/{userID}

cURL:

curl -H "X-API-Key: ************************************" -H "Content-Type: application/x-www-form-urlencoded" -X POST -d "login=testuser&firstName=test&lastName=test" https://demo.anewspring.com/api/updateUser/testid

Voorbeeld van een externe ID als query parameter

https://demo.anewspring.com/api/updateUser?userID={userID}

cURL:

curl -H "X-API-Key: ************************************" -H "Content-Type: application/x-www-form-urlencoded" -X POST -d "login=testuser&firstName=test&lastName=test" https://demo.anewspring.com/api/updateUser?userID=testid

Voorbeeld van een UID als query parameter

https://demo.anewspring.com/api/updateUser?userUID={userUID}

cURL:

curl -H "X-API-Key: ************************************" -H "Content-Type: application/x-www-form-urlencoded" -X POST -d "login=testuser&firstName=test&lastName=test" https://demo.anewspring.com/api/updateUser?userUID=c21f7c68-7682-11eb-b67e-06575dd7e8c5

UID van activiteiten

UID's worden automatisch gegenereerd en zijn altijd uniek. De UID van activiteiten zijn echter alleen uniek per template en niet per uitvoering. Dat houdt in dat dezelfde activiteit in elke uitvoering van die template dezelfde UID heeft.

Je kunt de structuur van de uitvoering of template opvragen met de API call GET /getCourseStructure/{ID} of GET /getCourseStructure?UID={UID}. De respons zal een overzicht van de blokken en activiteiten bevatten. Voor elke activiteit krijg je dan o.a. de UID en de externe ID (als deze handmatig is ingesteld).