Dit is een oude revisie van het document!

Opvragen lijst met eigenschappen conform OpenZaak API

Op het endpoint base-url/api/zgw/catalogi/api/v1/eigenschappen/ kan met een GET een lijst opgevraagd worden van eigenschappen per zaaktype die aan een zaak toegevoegd kunnen worden. De base_url is de implementatie van OpenWave waar tegenaan gepraat moet worden, bijvoorbeeld: https://acc.rommeldam.open-wave.nl. Er kan ook informatie van één specifieke eigenschap gevraagd worden door de uuid van die eigenschap als path parameter toe te voegen: bijvoorbeeld base-url/api/zgw/catalogi/api/v1/eigenschappen/548358458459-0-9090-0

Gebaseerd op versie Open Zaak API 1.2

Whitelist

De zender die hier een de eigenschappen opvraagt zal gewhitelist moeten worden. Dit kan in de tabellen tbendpointlist en tbipauthorisationlist onder de tegel endpoints_whitelist op het nieuwe beheerportaal onder de kolom Gebruikers. In de tabel tbendpointlist zal minimaal het endpoint /api/zgw gedefinieerd moeten zijn met daaronder (in de tabel tbipauthorisationlist) het IP-adres van de zender.

Authorisation Token

In de Authorization header van dit GET bericht moet een valide JWT-token worden meegegeven onder Bearer Token. Zie voorbeeld bij creeer_zgw_zaak.

Voor het verkrijgen van een token (met beperkte geldigheidsduur!) zie: zgw_open_zaak_api_functionaliteit.

De token wordt opgezocht in de tabel tbaccesstoken en het tijdstip van aanvraag wordt getoetst aan de geldigheidsduur van de gevonden rij.

(robot) Medewerker moet gelinkt zijn aan endpoint

De gevonden token is gelinkt aan een (robot)-medewerker (degene onder wiens credentials het token is gecreëerd). Bij de betreffende medewerkers kaart moet de kolom Endpoint (robotmedewerker is gedefinieerd voor binnenkomende berichten op endpoint) (dnkeyendpointlist) in blok login verwijzen naar een kaart in tbendpointlist waarvan de inhoud van de kolom dvendpointurl een substring is van dit endpoint api/zgw/catalogus/api/v1/eigenschappen/ // waarop deze eigenschappenlijst wordt gevraagd: bijvoorbeeld: /api/zgw//

Path Parameter

Niet verplicht. Indien gevuld dan met een uuid van een specifieke eigenschap. Die uuid verwijst naar de kolom dvdsovraagid van tbdsospecvraagid Endpoint is dan bijvoorbeeld base-url/api/zgw/catalogi/api/v1/eigenschappen/548358458459-0-9090-0

Headers

Geen verplichte header.

Query Parameters

Niet verplicht. OpenWave ondersteunt de queryparameter zaaktype en zaaktypeidentificatie en status. Indien

  • zaaktype dan verwacht OpenWave als waarde een uuid van een zaaktype (dus een verwijzing naar de kolom dvzgwuuid van tbsoortomgverg of tbsoortovverg).
  • zaaktypeidentificatie dan verwacht OpenWave als waarde de URL verwijzing waaronder een zaaktype leeft (dus bijvoorbeeld baseurl/api/zgw/catalogi/api/v1/zaaktypen/1235444bcde-456f-5454-ghij-klmnopq5454rstuv).
  • status. OpenWave verwacht een van onderstaande waarden:
    • anders dan alles, concept of definitief dan worden alle de rijen uit tbdsospecvraagid opgenomen met ddvervaldatum is null of ddvervaldatum > vandaag (en met en gevulde dvdsovraagid en gekoppeld aan een zaaktype)
    • concept dan moet ddvervaldatum gevuld zijn met een waarde kleiner dan vandaag
    • definitief dan moet ddvervaldatum leeg zijn of groter dan vandaag
    • alles dan wordt niet naar ddvervaldatum gekeken

Andere query parameters mogen doorgegeven worden, maar OpenWave negeert deze.

Body

Geen body.

Responsebericht

Indien de eigenschappenlijst niet kon worden gegenereerd wordt een responsecode anders dan 200/201 geretourneerd met in de body de oorzaak van het falen.

Indien de eigenschappenlijst wel succesvol is gegenereerd wordt onder de responsecode 200 in de body een geneste array van eigenschappen opgesomd met hun identifiers en de zaaktypes waaraan ze verbonden zijn. De data komen uit de tabel tbdsospecvraagid (als lijstje in het detailscherm van de zaaktypes tbsoortomgverg en/of tbsoortovvverg in het zaakbeheerportaal) waarvoor geldt dat zij een gevulde uuid hebben in de kolom dvdsovraagid en dat de eigenschap is gekoppeld aan een niet vervallen omgevingzaaktype (tbsoortomgverg) of APV/Overig zaaktype (tbsoortovverg), die op hun beurt een gevuld kolom dvzgwuuid hebben. Verder gelden de restricties zoals hierboven beschreven bij de queryparameters van de GET.

Er wordt een geneste array gegenereerd van de gevonden eigenschappen, waarbij in het laatste deel van het item url de waarde wordt teruggeven van tbdsospecvraagid.dvdsovraagid en in het item zaaktypeindentificatie de uuid van het zaaktype waar de eigenschap aan verbonden is.

Onderstaand voorbeelden betekent dat de zender NA het aanmaken van een zaak onder het zaaktype-uuid 1235444bcde-456f-5454-ghij-klmnopq5454rstuv een vervolgbericht kan sturen om een domein door te geven en een inrichtingssleutel bij een eerder aangemaakte zaak. Dat gebeurt met het POST-bericht base-url/api/zgw/zaken/api/v1/zaken/{zaak_uuid}/zaakeigenschappen. Dat domein uit het eerste eigenschap van het voorbeeld responsebericht moet een string (specificatie:formaat) zijn van maximaal 60 tekens (specificatie:lengte) en hoeft niet uniek te zijn (specificatie.kardinaliteit) De kardinaliteit geeft het aantal mogelijke voorkomens van waarden van deze EIGENSCHAP bij een zaak van het betreffende ZAAKTYPE:

  • 0.n wil zeggen dat de waarde meerder keren of helemaal niet kan voorkomen
  • 0.1 wil zeggen dat de waarde één keer of helemaal niet kan voorkomen
  • 1 wil zeggen dat de waarde één keer moet voorkomen
  • 1.n wil zeggen dat de waarde minimaal één keer moet voorkomen

De inrichtingssleutel uit de tweede eigenschap van het voorbeeld responsebericht moet een string zijn van maximaal 40 tekens en hoeft ook niet uniek te zijn.

In Openwave in de tabel tbdsospecvraagid moet bij de betreffende eigenschappen een SQL-statement ingevoerd worden die de tabel en kolom en rij bepaalt waar de domeinwaarde en inrichtingssleutel moet worden opgeslagen.

Voorbeeld response body

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [{
        "url": "https://demo2.open-wave.nl:4444/api/zgw/catalogi/api/v1/eigenschappen/123abcde-456f-7890-ghij-klmnopqrstuv",
        "naam": "Zaakdomein",
        "catalogus": "http://example.com",
        "definitie": "Zaakdomein",
        "specificatie": {
            "formaat": "tekst",
            "lengte": "60",
            "kardinaliteit": "0.n"
        },
        "zaaktypeidentificatie": "1235444bcde-456f-5454-ghij-klmnopq5454rstuv",
        "zaaktype": "https://demo2.open-wave.nl:4444/api/zgw/catalogi/api/v1/zaaktypen/1235444bcde-456f-5454-ghij-klmnopq5454rstuv"
    },
    {
        "url": "https://demo2.open-wave.nl:4444/api/zgw/catalogi/api/v1/eigenschappen/1236547576547j-klmnopqrstuv",
        "naam": "Inrichtingssleutel",
        "catalogus": "http://example.com",
        "definitie": "Inrichtingssleutel",
        "specificatie": {
            "formaat": "tekst",
            "lengte": "40",
            "kardinaliteit": "0.n"
        },
        "zaaktypeidentificatie": "1235444bcde-456f-5454-ghij-klmnopq5454rstuv",
        "zaaktype": "https://demo2.open-wave.nl:4444/api/zgw/catalogi/api/v1/zaaktypen/1235444bcde-456f-5454-ghij-klmnopq5454rstuv"
    }
    ]
}