Je kunt teacherOptions meegeven die worden gebruikt als je een conceptgebruiker omzet naar een docent:
Werkstudenten/gast docenten hebben minder rechten dan een echte docent en kunnen bijvoorbeeld minder resultaten inzien.
| ## Concept gebruiker ophalen (lijst) `GET` `https://api-portal.evalytics.nl/draftUser` Haal de conceptgebruikers op. Normaal gesproken worden alle concept gebruikers opgehaald die nog **niet** zijn omgezet naar docenten. Je kunt forTopicType=2 (2= type docent) mee geven aan de url om alle concept gebruikers op te halen die **wel** zijn omgezet. #### Query Parameters | Name | Type | Description | | --------------- | ------- | --------------------------------------------------------------------------------------------------- | | convertedToUser | boolean | Haal alle concept gebruikers op die gekoppeld zijn aan een gebruiker | | q | string | Zoeken naar conceptgebruikers (Voornaam, Achternaam, code, email, externalId | | forTopicType | integer | Door topicType=2 mee te geven worden alle concept gebruikers opgehaald die zijn omgezet naar docent | {% tabs %} {% tab title="200 " %} ``` { "metadata": { "timestamp": "2021-02-25T09:51:20.547Z", "resultSet": { "count": 1 } }, "results": [ { "id": 1, "title": "Dhr.", "firstName": "Example", "prefix": "", "lastName": "user", "code": "EU", "email": "example@evalytics.nl" "organisation": 100, "topOrganisation": 100, "externalId": "ABC", "altId": "", "user": null } ] } ``` {% endtab %} {% endtabs %} ## Conceptgebruikers ophalen (item) `GET` `https://api-portal.evalytics.nl/draftUser/:id` Een gebruiker kan gevonden worden op basis van het interne of externe id. Hierbij geeft onze API de interne id en organisatie id terug. #### Path Parameters | Name | Type | Description | | ---- | ------ | ----------------------------------------------- | | id | string | Intern id of externalId van de conceptgebruiker | {% tabs %} {% tab title="200 " %} ``` { "id": 1, "title": "Dhr", "firstName": "Example", "prefix": "", "lastName": "user", "code": "EU", "email": "example@evalytics.nl" "organisation": 100, "topOrganisation": 100, "externalId": "ABC", "altId": "", "user": null } ``` {% endtab %} {% endtabs %} ## Maak een conceptgebruiker aan `POST` `https://api-portal.evalytics.nl/drafUser` Maak een conceptgebruiker aan #### Path Parameters | Name | Type | Description | | ---- | ------ | ----------- | | | string | | {% tabs %} {% tab title="200 " %} ``` { "id": 1, "title": "Dhr.", "firstName": "Example", "prefix": "", "lastName": "user", "code": "EU", "email": "example@evalytics.nl" "organisation": 100, "topOrganisation": 100, "externalId": "ABC", "altId": "", "user": null } ``` {% endtab %} {% endtabs %} ``` { "title": "(string)", "firstName":"(string - required)", "lastName":"(string - required)", "prefix":"(string)", "code":"(string - required)", "email": (string - required), "altId": (string), "externalId": (string), "teacherOptions": { "isWorkingStudent": (boolean), "isGuestTeacher": (boolean) } } ``` {% hint style="info" %} Conceptgebruikers worden altijd op het hoogste niveau aangemaakt. Meestal is dit de school waar de faculteiten en opleidingen aan gekoppeld zijn. Je kunt ze bij alle onderliggende opleidingen/faculteiten ophalen. {% endhint %} ## Conceptgebruiker bijwerken `POST` `https://api-portal.evalytics.nl/draftUser/:id` Indien het gewenst is dat de update van de gebruiker propageert met het systeem (naar de gekoppelde docenten en cursussen), dan kan je dat aangeven met de optie propagate=true.\ \ **Voorbeeld**: Er vindt een naamswijziging plaats van Emma de Vries naar Emma de Vries - janssen. De naam wordt gewijzigd bij de volgende onderdelen:\ \- Concept gebruiker\ \- Gebruiker\ \- De docent\ \- Alle cursussen waar de docent aan gekoppeld is. #### Path Parameters | Name | Type | Description | | ---- | ------ | ---------------------------------------------- | | id | string | Intern id of extern id van de conceptgebruiker | #### Query Parameters | Name | Type | Description | | --------- | ------- | ---------------------------------------------------------------- | | propagate | boolean | Voer update door bij gekoppelde gebruiker, docent en cursussen. | {% tabs %} {% tab title="200 " %} ``` { "id": 1, "title": "Dhr.", "firstName": "Example", "prefix": "", "lastName": "user", "code": "EU", "email": "example_updated@evalytics.nl" "organisation": 100, "topOrganisation": 100, "externalId": "ABC", "altId": "", "user": null } ``` {% endtab %} {% endtabs %} ``` { "title": "(string)", "firstName":"(string)", "lastName":"(string)", "prefix":"(string)", "code":"(string)", "email": (string), "altId": (string), "externalId": (string), "teacherOptions": { "isWorkingStudent": (boolean), "isGuestTeacher": (boolean) } } ``` ## Conceptgebruiker omzetten naar docent `POST` `https://api-portal.evalytics.nl/draftUser/:id/toTeacher` Als je een concept gebruiker wilt gebruiken als docent, zal deze eerst omgezet moet worden. Er wordt een docent aangemaakt op de organisatie waar je de call op aanroept, dus niet altijd de hoofdorganisatie zoals concept gebruikers. Bij het aanmaken van een docent zal er ook direct een gebruiker aangemaakt worden. De gebruiker krijgt daarnaast ook de rol docent binnen de opleiding. #### Path Parameters | Name | Type | Description | | ---- | ------ | ------------------------------------ | | id | string | intern of extern id van de gebruiker | {% tabs %} {% tab title="200 Als response krijg je de docent terug die is aangemaakt." %} ``` { "type": 2, "organisation": 3, "topOrganisation": 2, "user": 3, "deleted": false, "createdBy": "3", "modifiedBy": null, "externalId": "exampleExternalId", "archived": false, "parent": null, "name": "Pascal Examp;e", "description": null, "data": { "title": "Dhr.", "firstName": "Pascal", "lastName": "Example", "prefix": "", "code": "ee", "emailAddress": "example@evalytics.nl" }, "id": 4 } ``` {% endtab %} {% endtabs %} ## Concept gebruiker verwijderen `DELETE` `https://api-portal.evalytics.nl/draftUser/:id` Een gebruiker kan worden verwijderd door middel van een delete. De delete kan op basis van het eerder meegegeven extern id. Indien het gewenst is dat de delete van de gebruiker propageert in het systeem (naar gekoppelde docenten/cursussen) dan dient dit aangegeven te worden met de optie “propagate = true”. Let hierbij wel op dat de docent dan bij alle opleidingen wordt verwijderd, inclusief gerelateerde cursussen en de gebruiker. Mocht het nodig zijn dat een docent wordt verwijderd bij een specifieke opleiding dan dient dit uitgevoerd te worden via de docent API. Tevens wordt een lopende evaluatie niet aangepast (de functie propageert niet naar lopende evaluaties).- false (default): Anonymize only for the current organisation. The teacher will be anonymized from the current organisation. The (draft)user will only be anonymized when it is not linked to other organisations.
- true: The teacher and (draft)user will be anonymized for all organisations.