Algemene query parameters

Extern id

Evalytics ondersteunt de mogelijkheid om gebruik te maken van een extern id. Als in uw eigen systeem een docent een id heeft, dan kun je dat meesturen als externalId. Bij ons wordt er nog altijd gebruik gemaakt van een interne id, maar hierdoor kun je wel op onderdelen zoeken of aanpassingen doen met het externe id. Dit werkt alleen voor modellen waarbij een externalId bij het aanmaken is meegegeven.

De onderdelen die dit nu ondersteunen zijn: Concept gebruikers, Docenten, Cursussen en Groepen.

Organisation

Als je gebruik maakt van de API is het meesturen van een organisation verplicht. Zo weet Evalytics in welke organisatie (opleiding of faculteit) je wilt aanspreken

query parameter	Omschrijving
organisationExternalId	Als je zoekt naar objecten binnen een organisatie zal de organisationId die je meestuurt gecheckt worden op externalId in plaats van het interne id van Evalytics
external	Bij het updaten of ophalen van een enkel item zal er gezocht worden op het externe id in plaats van het interne id van Evalytics
organisation (verplicht)	Als je gebruik maakt van de API is het verplicht om een organisation mee te geven. Dit kan extern id zijn of het id van Evalytics. Bij het aanmaken, bewerken, ophalen van items is het nodig om een organisation mee te geven, zodat Evalytics weet waar deze geplaatst moet worden.

Voorbeeld

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

Path Parameters

Name	Type	Description
id	string	intern/extern id van de group

Query Parameters

Name	Type	Description
organisationIsExternalId	boolean	organisation param is een extern id
external	boolean	Zoek op extern id
organisation	string	intern/extern id van de organisatie

200

{
  "participants": [
    {
      "deleted": false,
      "createdBy": "1",
      "modifiedBy": null,
      "name": "",
      "email": "[e-mail]",
      "externalId": null,
      "id": 12345,
      "createdAt": "2021-01-14T11:10:17.000Z",
      "updatedAt": "2021-01-14T11:10:17.000Z",
      "group": 10
    }
  ],
  "organisation": 2,
  "topOrganisation": 1,
  "deleted": false,
  "createdBy": "3",
  "modifiedBy": null,
  "externalId": null,
  "archived": false,
  "name": "Voorbeeld",
  "description": "Voorbeeld omschrijving",
  "id": 10,
  "createdAt": "2021-01-14T11:10:17.000Z",
  "updatedAt": "2021-01-14T11:10:17.000Z"
}