Groepen

Groepen bevatten de gegevens (minimaal e-mailadres) van de studenten/respondenten bij evaluaties op uitnodiging. Vinden er alleen evaluaties live in de klas plaats, dan zijn groepen niet van toepassing.

Overzichtstabel termen

Naam	Type	Verplicht	Omschrijving
name	string	Ja	Eigen naam (identificatie) voor de studentengroep
description	string	Nee	Omschrijving van de cursus
externalId	string	Nee	Dit kan een id van de groep in het eigen systeem zijn. Zie het onderdeel over externalId voor meer informatie. Dit veld is wel verplicht als je gebruik maakt van externalId voor groepen
participants	array	Nee	Een lijst met participanten die aan de groep toegevoegd kunnen worden. Geef per participant een e-mailadres mee en optioneel een naam of externalId. Let op: Op het portaal is het wel verplicht om deelnemers toe te voegen Het is ook mogelijk om participanten te labelen. Deze labels kunnen eind gebruikers vervolgens gebruiken om resultaten te filteren. Wijzigingen in labels bij deelnemers worden alleen toegepast op nieuwe evaluaties. Oude resultaten blijven ongewijzigd.
organisation	int	n.v.t.	De organisatie waar de groep aan gekoppeld is
topOrganisation	int	n.v.t.	Geeft aan wat de hoofdorganisatie is waar de groep aan gekoppeld is
id	int	Ja*	Alleen nodig bij updaten
importLock	boolean	Nee	Zorgt ervoor dat op de frontend de groepen 'gelocked' worden. Hierdoor kunnen de groepen niet zomaar aangepast worden door gebruikers. Alleen een functioneel beheerder heeft de mogelijkheid om de groep aan te passen.
integrations	array	Nee	Nodig als er gebruik wordt gemaakt van de LTI integratie

Groepen ophalen (Lijst)

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

Haalt een lijst op met groepen die aan de organisatie zijn gekoppeld

Query Parameters

Name	Type	Description
archived	boolean	Filteren op gearchiveerde of niet gearchiveerde groepen
q	string	Zoeken binnen groepen (naam, omschrijving, externalId)
status	string array	Filter op active, archived, deleted (default = active)

200

{
  "metadata": {
    "timestamp": "2021-02-08T20:35:30.186Z",
    "resultSet": {
      "count": 4,
      "limit": 30
    }
  },
  "results": [
    {
      "organisation": 101,
      "topOrganisation": 100,
      "deleted": false,
      "createdBy": "2144",
      "modifiedBy": null,
      "externalId": "group1",
      "archived": false,
      "name": "Groep studenten",
      "description": "Studenten",
      "id": 1233,
      "createdAt": "2020-12-21T16:17:55.000Z",
      "updatedAt": "2020-12-21T16:17:55.000Z",
      "totalParticipants": 10
    },
    {
      "organisation": 101,
      "topOrganisation": 100,
      "deleted": false,
      "createdBy": "1234",
      "modifiedBy": null,
      "externalId": "group2",
      "archived": false,
      "name": "groep 2",
      "description": "Example groep 2",
      "id": 1234,
      "createdAt": "2021-02-08T20:35:11.000Z",
      "updatedAt": "2021-02-08T20:35:11.000Z",
      "totalParticipants": 5
    }
  ]
}

Groep ophalen (item)

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

Hiermee kan je een enkele groep ophalen. De lijst met deelnemers wordt ook meegestuurd in de response

Path Parameters

Name	Type	Description
id	string	Interne of externalId van de groep

200

{
  "participants": [
    {
      "deleted": false,
      "createdBy": "3",
      "modifiedBy": null,
      "name": "",
      "email": "[email protected]",
      "externalId": null,
      "id": 12345,
      "createdAt": "2021-01-14T11:10:17.000Z",
      "updatedAt": "2021-01-14T11:10:17.000Z",
      "group": 1234
    }
  ],
  "organisation": 101,
  "topOrganisation": 100,
  "deleted": false,
  "createdBy": "3",
  "modifiedBy": null,
  "externalId": null,
  "archived": false,
  "name": "New group",
  "description": "Groep met studenten",
  "id": 1234,
  "createdAt": "2021-01-14T11:10:17.000Z",
  "updatedAt": "2021-01-14T11:10:17.000Z"
}

Groep aanmaken

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

Maak een groep aan. Het meesturen van participants is niet verplicht.

200

{
  "name": "Groep voorbeeld",
  "description": "Groep voorbeeld omschrijving",
  "externalId": "abcd",
  "createdBy": "123",
  "organisation": 101,
  "topOrganisation": 100,
  "deleted": false,
  "archived": false,
  "createdAt": "2021-04-08T11:10:21.000Z",
  "updatedAt": "2021-04-08T11:10:21.000Z",
  "id": 1234,
  "modifiedBy": null,
  "importLock": false
}

{
  "name": (string - verplicht),
  "description": (string),
  "externalId": (string)
  "participants": [
    {
       "externalId": (string),
       "name": (string),
       "email": (string - email - verplicht),
       "labels": [{
          "name": (string - verplicht)
       }],
       "integrations": [{
          "type": "sisIntegrationId",
          "id": (string)
       }]
    }
  ],
  "importLock": (boolean)
}

Groep bijwerken

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

Bijwerken van een groep

Path Parameters

Name	Type	Description
id	string	interne of externalId van de groep

200

{
  "name": "Groep voorbeeld",
  "description": "Groep voorbeeld omschrijving",
  "externalId": "abcd",
  "createdBy": "123",
  "organisation": 101,
  "topOrganisation": 100,
  "deleted": false,
  "archived": false,
  "createdAt": "2021-04-08T11:10:21.000Z",
  "updatedAt": "2021-04-08T11:10:21.000Z",
  "id": 1234,
  "modifiedBy": null,
  "importLock": false
}

{
  "name": (string - verplicht),
  "description": (string),
  "externalId": (string)
  "participants": [
    {
       "externalId": (string),
       "name": (string),
       "email": (string - email - verplicht),
       "labels": [{
          "name": (string - verplicht)
       }],
       "integrations": [{
          "type": "sisIntegrationId",
          "id": (string)
       }]
    }
  ],
  "importLock": (boolean)
}

Groep verwijderen

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

Verwijderen van een groep. Door undo=true mee te geven kan je de actie ongedaan maken

Path Parameters

Name	Type	Description
id	string	Id of externalId van de groep

Query Parameters

Name	Type	Description
undo	boolean	Door undo=true mee te geven maak je de verwijder actie ongedaan

200

Groep archiveren

POST https://api-portal.evalytics.nl/group/:id/archive

Groep archiveren

Path Parameters

Name	Type	Description
id	string	Id of externalId van de groep

Query Parameters

Name	Type	Description
undo	string	Door undo=true mee te geve maak je de archivering ongedaan

200

Deelnemer toevoegen aan groep

POST https://api-portal.evalytics.nl/group/:id/participant

Voeg een nieuwe deelnemer toe aan een groep. Indien de deelnemer al bestaat, krijg je geen foutmelding maar een 200 OK terug. Kan beheerd worden op basis van extern id.

Met participantUpdateType=email|externalId kan je de check of een deelnemer al bestaat op externalId of op email (default) uitvoeren. Als een deelnemer al bestaat worden de andere gegevens (name, labels, ...) overschreven.

Het is niet mogelijk om meerdere deelnemers met hetzelfde e-mail toe te voegen.

Path Parameters

Name	Type	Description
id*	string	Interne id of externalId van de groep
participantUpdateType	string	externalId of email (default = email)

200

{
  "deleted": false,
  "createdBy": "1",
  "modifiedBy": null,
  "name": "pascal",
  "email": "[email protected]",
  "externalId": "exampleExternalId",
  "group": 123,
  "id": 456,
  "createdAt": "2021-03-02T08:54:25.000Z",
  "updatedAt": "2021-03-02T08:54:36.000Z"
}

{
  "name": (string),
  "email": (string - verplicht),
  "externalId": (string),
  "labels": [{
          "name": (string)
  }], 
  "integrations": [{
          "type": "sisIntegrationId",
          "id": (string)
  }]
}

Deelnemer toevoegen aan groep (identifier)

POST https://api-portal.evalytics.nl/group/participant/identifier/externalId

Voeg een deelnemer toe aan een groep met als identifier het externalId TODO: Meer typen zijn mogelijk

200

{
  "deleted": false,
  "createdBy": "123",
  "modifiedBy": null,
  "name": "example",
  "email": "[email protected]",
  "externalId": "exampleExternalId",
  "group": 1234,
  "id": 123456,
  "createdAt": "2021-03-02T08:54:25.000Z",
  "updatedAt": "2021-03-02T08:54:36.000Z"
}

{
  "identifier": {
    "externalId": (string - verplicht - externalId van de groep)
  },
  "data": {
    "name": (string),
    "email": (string - verplicht),
    "externalId": (string - verplicht - externalId van de deelnemer),
    "labels": [{
          "name": (string)
    }]
  }
}

Deelnemer verwijderen van groep

DELETE https://api-portal.evalytics.nl/group/:id/participant/:participantId

Verwijderd een deelnemer uit een groep. Als het gelukt is krijg je een 200 OK terug

Path Parameters

Name	Type	Description
participantId	string	Interne id of externalId van de deelnemer
id	string	Interne id of externalId van de groep

200

{
  "removed": {
    "id": "92294",
    "group": "7397"
  }
}

Deelnemer verwijderen van groep (identifier)

DELETE https://api-portal.evalytics.nl/group/participant/identifier/externalId

Verwijderd een deelnemer van een groep op basis van identifier. TODO: meerdere identifiers zijn mogelijk

200

{
	"identifier": {
		"externalId": (string - verplicht - externalId van de groep),
		"participant": {
				"externalId": (string - verplicht - externalId van de deelnemer)
		}
	}
}

Deelnemers in bulk importeren

POST https://api-portal.evalytics.nl/group/bulkImportParticipants

Hiermee is het mogelijk om in bulk deelnemers toe te voegen aan groepen doormiddel van een CSV import. Als de groupId een externalId is, voeg dan external=true toe.

Path Parameters

Name	Type	Description
external	boolean	De groupId in het bestand is een externId

Headers

Name	Type	Description
Content-Type	string	multipart/form-data

Request Body

Name	Type	Description
file	object	Het CSV bestand

200

27B

importGroupParticipants.csv

Open

Import example

• Bestaande deelnemers in de import worden eventueel bijgewerkt

Deelnemer in groep bijwerken

PUT https://api-portal.evalytics.nl/group/:id/participant

Update een deelnemer in een groep. Als identifier kan je email of externalId gebruiken.

Path Parameters

Name	Type	Description
id*	String	id of externalId

200: OK

[
	{
		"id": 1,
		"email": "[email protected]",
		"integrations": [
			{
				"type": "sisIntegrationId",
				"id": "1234"
			}
		],
		"name": "Dev student"
	}
]

{
	"identifier": {
		"externalId": (string - required of gebruik id)
		"id": (number - required of gebruik externalId)
	},
	"data": {
		"externalId": (string),
		"name": (string),
		"email": (string),
		"labels": [{
			"name": (string - required)
		}],
		"integrations": [{
		          "type": "sisIntegrationId",
		          "id": (string)
		 }]
	}
}