Versions Compared

Old Version 7

changes.mady.by.user Alessia Krioutchkova

Saved on

compared with

New Version Current

changes.mady.by.user Michiel Van Cauwenberge

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

  • Algemene informatie:

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

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

  • Mandaatbeheerders opvragen

Status
titleGET
/api/workrelation/email/mandaatbeheerders?kboNumber=<kboNumber>

kboNumber

String

0990919336

Responses

Code

Description

Example

200

OK
(List of results)

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

200

OK

(No results)

Code Block
languagejson
[]

  • Organisatie opvragen

Status
titleGET
/api/organisations?code=<code>&source=<source>

code

String

0990919336

source

String

KBO

Responses

Code

Description

Example

200

OK

Code Block
languagejson
{
  "name": "Naam van de Organisatie"
}

404

NOT FOUND

  • E-mailadres van werkrelatie wijzigen

Status
titlePUT
/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

Code Block
{
 "value": "no-reply@vlaanderen.be",
 "metadata": {
    "reason": "Verklaring waarom de aanpassing werd uitgevoerd."
  }
}

Responses

Code

Description

Example

200

OK

400

BAD REQUEST

(geen of invalid reason)

Code Block
{
  "errorKey": "WORKRELATION_NO_REASON_PROVIDED"
}

400

BAD REQUEST

(invalid email)

Code Block
{
  "errorKey": "VALIDATION_FAILED"
}

404

NOT FOUND

(geen werkrelatie gevonden)

Code Block
{
  "errorKey": "WORKRELATION_NOT_FOUND"
}

  • 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.

Status
titlePOST
/api/workrelations/contacts/email/primary/bulk

RequestBody

Code Block
{
  "value": "no-reply@vlaanderen.be",
  "voId": "<voId>",
  "organisations": [
    {
      "code": "<organisationCode>",
      "source": "<organisationSource>"
    }
  ],
  "metadata": {
    "reason": "Verklaring waarom de aanpassing werd uitgevoerd."
  }
}

Responses

Code

Description

Example

202

ACCEPTED

400

BAD REQUEST

(geen of invalid reason)

Code Block
{
  "errorKey": "WORKRELATION_NO_REASON_PROVIDED"
}

400

BAD REQUEST

(invalid email)

Code Block
{
  "errorKey": "VALIDATION_FAILED"
}

400

BAD REQUEST

(meer dan 100 organisaties gegeven)

Code Block
{
  "errorKey": "VALIDATION_FAILED"
}

Relevante pagina's

Technische functionaliteiten (IDM)

Public-API

Authorization

OpenAPI

Live Search
spaceKeyGAEP

Info

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

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