Organisation

Het object Organisation beschrijft een onderwijsaanbieder die als administratieve eenheid beschikbaar is in het Administratiesysteem onderwijsdeelnemer.

The organisation model

The organisation model contains all the information about your organisation, such as locations, boards, name.

Properties

  • Name
    id
    Type
    string
    Description

    De primaire identifier voor een onderwijsaanbieder.

  • Name
    organisationIds
    Type
    string
    Description

    Een lijst van secundaire identifiers die gehanteerd kan worden als de primaire identifier ontbreekt.

  • Name
    name
    Type
    string
    Description

    De naam van de onderwijsaanbieder.

  • Name
    boards
    Type
    array
    Description

    Referenties naar de onderwijsbesturen waaronder deze onderwijsaanbieder valt.

  • Name
    locations
    Type
    array
    Description

    Referentie naar de onderwijslocaties waar deze onderwijsaanbieder onderwijs aanbiedt.

  • Name
    sourceId
    Type
    string
    Description

    Een unieke identifier die gegenereerd is door het Administratiesysteem onderwijsdeelnemer.

    *De sourceId wordt gebruikt om informatie over dit object op te vragen in de koppelvlakspecificatie.

  • Name
    status
    Type
    enum
    Description

    De status van dit object.

  • Name
    dateCreated
    Type
    timestamp
    Description

    Datum en tijdstip waarop de entiteit is aangemaakt

  • Name
    dateLastModified
    Type
    timestamp
    Description

    Tijdstempel waarop één of meerdere van de hierboven genoemde attributen het laatst zijn gewijzigd

GET/v1/organisations

List all organisations

This endpoint allows you to retrieve a paginated list of all organisation that have granted access to you.

Optional attributes

  • Name
    limit
    Type
    integer
    Description

    Limit the number of organisations returned.

Request

GET
/v1/organisations
curl -G https://api.wimpel.nl/v1/organisations \
  -H "Authorization: Bearer {token}" \
  -d active=true \
  -d limit=10

Response

[
    {
      "id": "16SK",
      "organisationIds": [
        {
          organisationId: "16SK00",
          type: "verstigingserkenning"
        }
      ],
      "name": "Liemers College SGM voor LYC HAVO MAVO VBO LWOO",
      "boards": [
        {
          "id": 13554,
          "name": "Stichting Quadraam"
        },
        // ...
      ],
      "locations": [
        {
          "id": "16SK00",
          "name": "Liemers College SGM voor LYC HAVO MAVO VBO LWOO",
          "type": "hoofdlocatie"
        },
        {
          "id": "16SK01",
          "name": "Liemers College Scholengemeenschap voor LYC HAVO MAVO VBO LWOO",
          "type": "locatie"
        },
        // ...
      ]
      "sourceId": "xgQQXg3hrtjh7AvZ",
      "status": "active",
      "dateCreated": "2025-04-18 10:02:28.000Z",
      "dateLastModified": "2025-04-18 10:02:28.000Z"
    },
    {
      // ...
    }
]
POST/v1/organisations

Create a organisation

This endpoint allows you to add a new organisation to your list.

Required attributes

  • Name
    id
    Type
    string
    Description

    De primaire identifier voor een onderwijsaanbieder.

  • Name
    name
    Type
    string
    Description

    The name of the organisation

  • Name
    sourceId
    Type
    string
    Description

    Een unieke identifier die gegenereerd is door het Administratiesysteem onderwijsdeelnemer.

Request

POST
/v1/organisations
curl https://api.wimpel.nl/v1/contacts \
  -H "Authorization: Bearer {token}" \
  -d id="16SK07" \
  -d name="Liemers College SGM voor LYC HAVO MAVO VBO LWOO" \
  -d sourceId="saoe89wZq"

Response

{
  "id": "16SK07",
  "name": "Liemers College SGM voor LYC HAVO MAVO VBO LWOO",
  "sourceId": "saoe89wZq",
  ...
  "dateCreated": "2025-04-18 10:02:28.000Z",
  "dateLastModified": "2025-04-18 10:02:28.000Z"
}
GET/v1/organisations/:id

Retrieve a organisation

This endpoint allows you to retrieve a organisation by providing their id. Refer to the list at the top of this page to see which properties are included with organisation objects.

Request

GET
/v1/organisations/16SK
curl https://api.wimpel.nl/v1/organisations/16SK \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "16SK07",
  "name": "Liemers College SGM voor LYC HAVO MAVO VBO LWOO",
  "sourceId": "saoe89wZq",
  ...
  "dateCreated": "2025-04-18 10:02:28.000Z",
  "dateLastModified": "2025-04-18 10:02:28.000Z"
}
PUT/v1/organisations/:id

Update a organisation

This endpoint allows you to perform an update on a organisation. Currently, the only attribute that can be updated on organisations is the sourceId attribute which controls how a organisation is known in your eco system.

Optional attributes

  • Name
    sourceId
    Type
    string
    Description

    The organisation sourceId. Een unieke identifier die gegenereerd is door het Administratiesysteem onderwijsdeelnemer.

Request

PUT
/v1/organisations/16SK07
curl -X PUT https://api.wimpel.nl/v1/contacts/16SK07 \
  -H "Authorization: Bearer {token}" \
  -d sourceId="WAz8eIbvDR60rouK"

Response

{
  "id": "16SK07",
  "name": "Liemers College SGM voor LYC HAVO MAVO VBO LWOO",
  "sourceId": "WAz8eIbvDR60rouK",
  ...
  "dateCreated": "2025-04-18 10:02:28.000Z",
  "dateLastModified": "2025-04-18 10:02:28.000Z"
}
DELETE/v1/organisations/:id

Delete a organisation

This endpoint allows you to delete organisations from your list in Wimpel. Note: This will also delete your history.

Request

DELETE
/v1/organisations/16SK
curl -X DELETE https://api.wimpel.nl/v1/organisations/16SK \
  -H "Authorization: Bearer {token}"

Was this page helpful?