De API (en andere soorten koppelingen) maken gebruik van externe ID's in aNewSpring. Op deze manier weet de koppeling bijvoorbeeld op welke gebruiker of uitvoering deze zich moet richten bij het uitvoeren van een automatische handeling.

Hieronder wordt uitgelegd hoe en waar je de externe ID van elk concept kunt instellen:

Activiteit (activityID)

Als je de template opent en dan op Aanpassen klikt bij een activiteit, ga dan naar de tab Eigenschappen en scroll naar Geavanceerde instellingen om de externe ID in te stellen:

Agendapunt (UID)

De externe ID's van agendapunten kun je niet inzien of handmatig instellen. De externe ID kun je alleen instellen wanneer je een nieuw agendapunt toevoegt via de API:
POST /addEvent/{courseID}/{UID}

Contentbibliotheek (contentLabelID)

Ga naar de tab Content en klik bij de contentbibliotheek op Eigenschappen. Scroll dan naar Geavanceerde instellingen en daar kun je de externe ID instellen:

Event (eventID)

Ga naar de tab Events en klik bij een event op Open. Onder de tab Details bij Geavanceerde instellingen kun je de externe ID instellen:

Gebruiker (userID, teacherID)

Ga naar de tab Gebruikers en klik bij een bestaande gebruiker op Gegevens. Je kunt hier de externe ID invullen:

Het veld Extern ID is standaard verborgen. Neem contact met ons op via support@anewspring.nl als je dit veld zichtbaar wilt maken voor je beheerders. Wij kunnen dit veld alleen inschakelen als het verzoek afkomstig is van het e-mailadres van een omgevingsbeheerder.

Gebruikersgroep (groupID)

Ga naar de tab Gebruikers, klik op de knop Groepen, kies een van de tabbladen (Begeleiders, Deelnemers of Mentoren), klik op Aanpassen en ga dan naar de tab Instellingen. Als je Geavanceerd openklapt, kun je de externe ID instellen:

Subomgeving (resellerID)

Subomgevingen hebben standaard geen externe ID. Helaas kun je dit niet zelf instellen, maar als je contact opneemt met support@anewspring.nl, kunnen wij deze voor je instellen.

Template (templateID)

Als je naar de template gaat en dan naar de tab Template-instellingen, scroll dan naar beneden en bij Geavanceerde instellingen kun je de externe ID instellen:

Toegangscodegroep (groupID)

De externe ID van een toegangscodegroep kun je niet handmatig instellen. De externe ID stel je in via de API wanneer je een nieuwe toegangscodegroep aanmaakt:
POST /addAccessCodeGroup/{ID}

Uitvoering (courseID)

Als je naar de tab Templates gaat en de template openklapt, klik dan op Meer bij de uitvoering en dan op Instellingen. Scroll naar beneden voor de Geavanceerde instellingen en daar kun je de externe ID instellen: