# 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.<br>

**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

<mark style="color:blue;">`GET`</mark> `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 |

{% tabs %}
{% tab title="200 " %}

```
{
  "participants": [
    {
      "deleted": false,
      "createdBy": "1",
      "modifiedBy": null,
      "name": "",
      "email": "voorbeeld@evalytics.nl",
      "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"
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.evalytics.nl/algemeen/algemene-query-parameters.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.