Document toolboxDocument toolbox

Endpoints

  • Algemene informatie:

    • TNI omgeving host: api.tni.webidm.vlaanderen.be

    • Productie omgeving host: api.prod.webidm.vlaanderen.be

  • Mandaatbeheerders opvragen

GET /api/workrelation/email/mandaatbeheerders?kboNumber=<kboNumber>

GET /api/workrelation/email/mandaatbeheerders?kboNumber=<kboNumber>

 

kboNumber

String

0990919336

Responses

Code

Description

Example

200

OK
(List of results)

["voornaam.familienaam@vlaanderen.be","info@info.be","info@test.com"]

200

OK

(No results)

[]
  • Organisatie opvragen

GET /api/organisations?code=<code>&source=<source>

GET /api/organisations?code=<code>&source=<source>

 

code

String

0990919336

 

source

String

KBO

Responses

Code

Description

Example

200

OK

{ "name": "Naam van de Organisatie" }

404

NOT FOUND

 

  • E-mailadres van werkrelatie wijzigen

PUT /api/workrelations/contacts/email/primary?voId=<voId>&organisationCode=<organisationCode>&organisationSource=<organisationSource>

PUT /api/workrelations/contacts/email/primary?voId=<voId>&organisationCode=<organisationCode>&organisationSource=<organisationSource>

 

voId

String

550e8400-e29b-41d4-a716-446655440000

 

organisationCode

String

12345678

 

organisationSource

String

Onderwijs

 

RequestBody

Responses

Code

Description

Example

200

OK

 

400

BAD REQUEST

(geen of invalid reason)

400

BAD REQUEST

(invalid email)

404

NOT FOUND

(geen werkrelatie gevonden)

  • E-mailadres van meerdere werkrelaties wijzigen
    Wijzig het e-mailadres op tot 100 werkrelaties van 1 identity.
    Werkrelaties die niet gevonden worden of waar de caller niet voldoende rechten tot heeft, worden overgeslagen.

POST /api/workrelations/contacts/email/primary/bulk

POST /api/workrelations/contacts/email/primary/bulk

 

RequestBody

Responses

Code

Description

Example

202

ACCEPTED

 

400

BAD REQUEST

(geen of invalid reason)

400

BAD REQUEST

(invalid email)

400

BAD REQUEST

(meer dan 100 organisaties gegeven)

 

Relevante pagina's

Relevante pagina's

Technische functionaliteiten (IDM)

Public-API

Authorization

OpenAPI

Search

Vragen of suggesties, contacteer ons via: integraties@vlaanderen.be 

Heb je nood aan ondersteuning bij het gebruik van de toepassing, contacteer de 1700.