SDB ECD API (Release 2026.13)
Release 2026.13 gaat op maandag 23 november 2026 in acceptatie en op maandag 7 december 2026 in productie.
overzicht endpoints die worden uitgefaseerd
Het kan gebeuren dat een endpoint om een bepaalde reden wordt uitgefaseerd. Dit maken we kenbaar in onderstaande tabel. Per endpoint wordt de release aangegeven vanaf welke release het endpoint niet meer beschikbaar is. Je hebt altijd minimaal één jaar de tijd om ervoor te zorgen dat het betreffende endpoint niet meer wordt aangeroepen.
| Release | Endpoint |
| 2026.02 | api/clients/{{clientId}}/reports/ovz |
| 2026.11 | api/clients/{id}key-arrangements |
| 2027.05 | api/v2/clients/{id}/reports/ovz |
| 2027.08 | api/v2/clients/{id}/stakeholders Vervangend endpoint: api/clients/{id}/network |
| 2027.10 | api/clients/{id}/care-plan Vervangend endpoint: api/v2/clients/{id}/care-plan |
| 2027.10 | api/clients/{id}/care-plan/mikzo Vervangend endpoint: api/v2/clients/{id}/care-plan/mikzo |
| 2027.12 | api/clients/{id}/network Vervangend endpoint: api/v1/clients/{id}/network |
| 2027.12 | api/clients/{id}/stakeholder Vervangend endpoint: api/v1/clients/{id}/stakeholder |
| 2027.12 | api/clients/{id}/stakeholder/{stakeholderId} Vervangend endpoint: api/v1/clients/{id}/stakeholder/{stakeholderId} |
functionaliteiten - OPEn Systeem
Vragenlijsten bij metingen beschikbaar via de API
Externe applicaties kunnen via de SDB ECD API vragenlijsten bij metingen ophalen, antwoorden registreren en opgeslagen antwoorden weer opvragen. Dit geldt ook voor de vaste vragenlijsten van de Barthel-index, DOS-score en SNAQrc.
Vragen en antwoordopties ophalen
Via GET /api/master-measurements en GET /api/clients/{id}/master-measurements kun je de vragen en antwoordopties ophalen van vragenlijsten die aan metingen zijn gekoppeld. Ook de vaste vragenlijsten van de Barthel-index, DOS-score en SNAQrc worden meegeleverd.
Antwoorden registreren en wijzigen
Bij het registreren of wijzigen van een meting kun je antwoorden op de gekoppelde vragenlijst meesturen via:
- POST /api/v1/clients/{id}/measurements/registered
- PUT /api/v1/clients/{id}/measurements/registered/{registeredMeasurementId}
SDB ECD valideert de antwoorden en berekent waar mogelijk de meetwaarde.
Opgeslagen antwoorden ophalen
Via GET /api/v3/clients/{id}/measurements/registered kun je de opgeslagen antwoorden opvragen. Hierbij worden ook de vraagteksten en gekozen antwoordopties teruggegeven.
SNAQrc-codetabellen
De SNAQrc-codetabellen zijn beschikbaar via GET /api/code-categories en GET /api/code-categories/codes. Hiermee kunnen externe applicaties de beschikbare SNAQrc-antwoordmogelijkheden ophalen.
Uitbreiding API voor defecatiemetingen
Vanaf deze release zijn de API-endpoints voor defecatiemetingen uitgebreid met kleur en de hoeveelheid Onbekend.
Via POST /api/v1/clients/{id}/measurements/registered kun je bij een defecatiemeting ook de kleur en de hoeveelheid Onbekend meesturen. Bij de hoeveelheden Weinig, Normaal en Veel is consistentie verplicht. Zonder consistentie wordt de registratie afgewezen.
Dezelfde mogelijkheden en validatie gelden bij het wijzigen van een defecatiemeting via PUT /api/v1/clients/{id}/measurements/registered/{registeredMeasurementId}. Dit geldt ook voor bestaande registraties: bij Weinig, Normaal of Veel moet bij het opnieuw opslaan een consistentie zijn ingevuld.
Daarnaast retourneert GET /api/clients/{id}/master-measurements bij Defecatie voortaan ook de gekoppelde codetabel Defecatie: kleur. De beschikbare hoeveelheden en kleuren kun je ophalen via GET /api/code-categories/codes.
Hoofd-OE cliënt - GET-endpoint
Via het GET-endpoint /api/clients/{id}/head-organizational-unit kun je de hoofd-OE van een cliënt opvragen. De respons bevat het OE-nummer en de omschrijving. Als er geen hoofd-OE is geselecteerd, is Location leeg.
Organisatorische eenheden - GET-endpoints
De bestaande GET-endpoints /api/OrganizationalUnits en /api/OrganizationalUnits/{regionId}/departments geven voortaan ook het telefoonnummer en e-mailadres van de organisatorische eenheid terug.
Daarnaast kun je één organisatorische eenheid opvragen via het GET-endpoint /api/OrganizationalUnits/{number}, waarbij {number} het OE-nummer is.
Voor alle drie de Organizational Units-endpoints is voortaan permissie Beheer-Stambestanden vereist. API-gebruikers zonder dit recht ontvangen een 401-respons. De bestaande OE-autorisatie blijft van toepassing.
Medewerker opvragen - GET-endpoint
Het endpoint GET /api/employees/{id} vereist niet langer altijd de autorisatie Basis. Een gebruiker kan een medewerker opvragen met Basis óf met minimaal één leesrecht onder Privégegevens, zoals Adres, Overige telefoonnummer(s), Werktelefoonnummer, E-mail, Geboortedatum of Functie. Gebruikers kunnen hun eigen medewerkersrecord blijven opvragen volgens de bestaande regels.
De API retourneert alleen de gegevens waarvoor de gebruiker bevoegd is. De identificatie- en naamgeg0evens (Id, Name, PartnerName en NameNotation) worden altijd teruggegeven. Velden zoals geslacht, UPN, AGB, aanhef en BIG-nummer worden alleen gevuld met Basis. Adres-, e-mail- en geboortedatumgegevens vereisen elk hun eigen autorisatie. Voor telefoonnummers gelden de regels van Werktelefoonnummer en Overige telefoonnummer(s); zonder het passende recht is PhoneNumbers leeg (null). Gegevens waarvoor de gebruiker geen recht heeft, worden eveneens als null teruggegeven. Zonder Basis of een leesrecht onder Privégegevens kan een gebruiker geen gegevens van een andere medewerker opvragen; het endpoint geeft dan 401 terug. Een onbekend medewerkersnummer geeft 404.
praktisch
Wil je graag op de hoogte blijven van de API's uit SDB ECD? Stuur dan een mailtje naar ecd@sdbgroep.nl om je aan te melden. Graag ontvangen we je voornaam, naam en e-mailadres. Je wordt dan per e-mail op de hoogte gebracht van de Release Notes van SDB ECD API's.