⚠️ This connector is not tested with HelloID or with a Presentis environment! >
⚠️ Note that this connector is "a work in progress" and therefore not ready to use in your production environment.
| ℹ️ Information |
|---|
| This repository contains the connector and configuration code only. The implementer is responsible to acquire the connection details such as username, password, certificate, etc. You might even need to sign a contract or agreement with the supplier before implementing this connector. Please contact the client's application manager to coordinate the connector requirements. |
HelloID-Conn-Prov-Source-Presentis is a source connector. Presentis provides a set of REST API's that allow you to programmatically interact with its data. The HelloID connector uses the API endpoints listed in the table below.
| Endpoint | Description | | ./schoollocaties | ophalen van alle schoollocaties | | ./leerlingen?schoollocatie= | students (leerlingen) per locatie | | ./klassen?schoollocatie= | classes per locatie | | ./leerlingklassen?leerlingid | classes per student (leerling) | | ./leerlingen?schoollocatie= | students per locatie | | ./personen?schoollocatie= | persons per locatie |
The following settings are required to connect to the API.
| Setting | Description | Mandatory |
|---|---|---|
| ClientId | The ClientId to connect to the API | Yes |
| ClientSecret | The Clientsecret to connect to the API | Yes |
| Environment | radio butten to choose test of production environment | Yes |
| IsDebug | The URL to the API | Yes |
No special requirements
-
persons.ps1 contains the code for collecting general persons
-
students.ps1 contains the code for collecting the studends.
-
"In"- and "uitschrijfdatum" determine the primary contract of the student ContractType = "inschrijving" "Schoollocatie" (naam + id) is available on all contracts of this type
-
"Klassen" for each "klas" of an student there is a separate contract on the student ContractType = "klas" "Schoollocatie" (naam + id) is available on all contracts of this type
"Cursussen" for each course of a student there is a separate contract ContractType = "cursus" "Schoollocatie" is not available of contracts of this type
no special requirements, the source mapping given is only a default example, and will need to be changed as required.
For more information on how to configure a HelloID PowerShell connector, please refer to our documentation pages
If you need help, feel free to ask questions on our forum
The official HelloID documentation can be found at: https://docs.helloid.com/