Gebruikers

Overzichttabel termen

Naam	Type	Verplicht bij aanmaken	Omschrijving
name	string	Ja	Naam van de gebruiker
title	string	Nee	Titel van de gebruiker. Bijv. Mevr. of Dhr.
firstName	string	Nee	Voornaam van de gebruiker
prefix	string	Nee	Tussenvoegsel
lastName	string	Nee	Achternaam van de gebruiker
email	string (email)	Ja	E-mailadres van de gebruiker. Hier logt de gebruiker mee in
roles	array	Ja	Je kunt rollen aan de gebruiker toevoegen. Per organisatie kan een rol verschillen. Als voorbeeld: Een gebruiker kan docent zijn bij opleiding A en functioneel kwaliteitsmanager bij een andere faculteit
organisations / linkedOrganisations	array	n.v.t.	Naast rollen wordt er ook een lijst met organisaties meegegeven bij het ophalen van gebruiker(s). Hierin staat welke organisaties gekoppeld zijn aan de gebruiker
additionalPermissionGroups	array	Nee	In Evalytics zijn er extra permissies mogelijk die je bij een gebruiker kan instellen. Zoals bijvoorbeeld: Evaluatiebeheer, cursusbeheer of docentbeheer.
noSurf	boolean	nee	Als de docent geen gebruik kan maken van saml, kan je noSurf meegeven. De gebruiker krijgt dan een inlog en wachtwoord.
lastActivationMail	timestamp	n.v.t.	Geeft aan wanneer er voor het laatst een activeringsmail is verstuurd
activated	boolean	n.v.t.	Geeft aan of een gebruiker geactiveerd is. De gebruiker krijgt, als je noSurf = true meegeeft, bij het aanmaken van een gebruiker een activerings e-mail. Na het activeren wordt activated op true gezet.
externalId	string	nee	Het externe id van de gebruiker

Gebruikers en docenten

Gebruikers en docenten zijn nauw met elkaar verbonden. Op het moment dat je een docent aanmaakt binnen de opleiding, zal er automatisch ook een gebruiker aangemaakt worden. Hetzelfde geldt voor concept gebruikers. Als je een concept gebruiker omzet naar docent, zal er automatisch ook een gebruiker aangemaakt worden. De gebruiker en docent zijn met elkaar gekoppeld.

Gebruikers ophalen (lijst)

GET https://api-portal.evalytics.nl/user

Hiermee kan je zoeken op gebruikers binnen de organisatie. Bij de gebruikers zullen ook de onderliggende rollen en organisaties toegevoegd worden aan de response

Query Parameters

Name	Type	Description
includeChildOrganisations	boolean	Haal ook gebruikers op uit organisaties die onder de huidige organisatie staan
role	array	Filter de users op een bepaalde role. Je kunt hier de ids van de rolen meegeven waarop je wilt filteren
q	string	Zoeken binnen gebruikers op naam, code en e-mail

200

{
  "metadata": {
     ...
  },
  "results": [
    {
      "organisations": [
        {
          "parent": 100,
          "topOrganisation": 100,
          "name": "TestFaculteit",
          "code": "tf",
          "type": "faculty",
          "availableModules": null,
          "modules": null,
          "externalId": "ABC",
          "id": 1
        }
      ],
      "roles": [
        {
          "id": 123,
          "user": 567,
          "evaluator": null,
          "role": 13,
          "organisation": 100
        }
      ],
      "organisation": 100,
      "topOrganisation": 100,
      "name": "Example user",
      "title": "",
      "firstName": "Example",
      "prefix": "",
      "lastName": "user",
      "email": "[e-mail]",
      "altId": null,
      "externalId": "ABC",
      "activated": true,
      "lastActivationMail": "2020-12-29T10:15:09.000Z",
      "id": 567
    }
  }]
}

Gebruiker ophalen (item)

GET https://api-portal.evalytics.nl/user/:id

Haal een enkele gebruiker op. Organisaties en rollen waar de gebruiker aan gekoppeld is worden ook toegevoegd.

Path Parameters

Name	Type	Description
id	string	Intern id of extern id van de gebruiker

200

{
  "linkedOrganisations": [
    {
      "parent": 100,
      "topOrganisation": 100,
      "name": "TestFaculteit",
      "code": "tf",
      "type": "faculty",
      "availableModules": null,
      "modules": null,
      "externalId": "ABC",
      "id": 1
    }],
   "roles": [
     {
       "id": 123,
       "user": 567,
       "evaluator": null,
       "role": 13,
       "organisation": 100
     }
    ],
    "organisation": 100,
    "topOrganisation": 100,
    "name": "Example user",
    "title": "",
    "firstName": "Example",
    "prefix": "",
    "lastName": "user",
    "email": "[e-mail]",
    "altId": null,
    "activated": true,
    "lastActivationMail": "2020-12-29T10:15:09.000Z",
    "id": 567
  }
}

Gebruiker aanmaken

POST https://api-portal.evalytics.nl/user

Als je een gebruiker aanmaakt moet het e-mailadres uniek zijn. Het is niet mogelijk om meerdere gebruikers aan te maken met hetzelfde e-mailadres

200

{
  "deleted": false,
  "createdBy": "3",
  "modifiedBy": "3",
  "name": "pascal api docs",
  "title": "",
  "firstName": "Pascal",
  "prefix": "",
  "lastName": "api docs",
  "email": "[e-mail]",
  "altId": null,
  "activated": false,
  "lastActivationMail": "2021-02-25T10:21:39.000Z",
  "organisation": 100,
  "topOrganisation": 100,
  "id": 123
}

{
  "name": (string - required when you do not use firstName/lastName field),
  "title": "(string)",
  "firstName": "(string - required when you do not use the name field)",
  "prefix": "(string)",
  "lastName": "(string - required when you do not use the name field)",
  "email": (string - required),
  "noSurf":(boolean),
  "externalId: (string),
  "additionalPermissionGroups":[
  {
    “organisation”: (integer),
    “additionalPermissionGroup”:  (integer)
  }
  ],
  “roles”: [
   {
     “organisation”: (number - at least one role required),
     “role”: (number)
   },
   {
     “organisation”: (integer - at least one role required),
     “role”: (integer)
   }
  ]
}

Gebruiker bijwerken

POST https://api-portal.evalytics.nl/user/:id

Het is mogelijk om een gebruiker bij te werken. Je kunt de gebruiker bijvoorbeeld extra rollen geven of de naam aanpassen. Het aanpassen van het e-mailadres is niet mogelijk.

Path Parameters

Name	Type	Description
id	string	Intern id of extern id van de gebruiker

200

{
  "deleted": false,
  "createdBy": "3",
  "modifiedBy": "3",
  "name": "pascal api docs updated name",
  "title": "",
  "firstName": "Pascal",
  "prefix": "",
  "lastName": "api docs updated name",
  "email": "[e-mail]",
  "altId": null,
  "activated": false,
  "lastActivationMail": "2021-02-25T10:21:39.000Z",
  "organisation": 100,
  "topOrganisation": 100,
  "id": 123
}

{
  "externalId": (string),
  "name": (string - required when you do not use firstName/lastName field),
  "title": "(string)",
  "firstName": "(string - required when you do not use the name field)",
  "prefix": "(string)",
  "lastName": "(string - required when you do not use the name field)",
  "noSurf":(boolean),
  "additionalPermissionGroups":[
  {
    “organisation”: (integer),
    “additionalPermissionGroup”:  (integer)
  }
  ],
  “roles”: [
   {
     “organisation”: (number),
     “role”: (number)
   },
   {
     “organisation”: (integer),
     “role”: (integer)
   }
  ]
}

Gebruiker verwijderen

DELETE https://api-portal.evalytics.nl/user/:id

Path Parameters

Name	Type	Description
id	string	Intern id of extern id van de gebruiker

Query Parameters

Name	Type	Description
undo	boolean	Maakt de verwijderingsactie ongedaan

200

Als je een gebruiker verwijderd, kan de gebruiker daarna ook niet meer inloggen in het systeem

Block user

POST https://api-portal.evalytics.nl/user/:id/block

Block a user in Evalytics. When a user is blocked: - The user is not able to login - The user will not receive notifications in the period the user is blocked - The linked organisations and roles will not be removed

Path Parameters

Name	Type	Description
id	string	Internal or external id

Query Parameters

Name	Type	Description
undo	boolean	Undo the block action

200