Kaartmateriaal en registratie in de Objecten API

In dit formulier maken we gebruik van de “Kaart”-component om coördinaten van een locatie uit te vragen en te registreren. Het formulier wordt gekoppeld met de Objecten API voor het registreren van de inzendingsgegevens.

We gaan er van uit dat de koppeling met de Objecten API geconfigureerd is, en gebruiken als objecttype-URL https://objecttype-example.nl/api/v2/objecttype/123.

Formulier maken

We bouwen een formulier met twee kaarten - één kaart wordt gebruikt voor “dé” geometrie van het hele Object in de Objecten API en de andere kaart wordt als extra/vrije-vorm attribuut meegestuurd.

  1. Maak een formulier aan met de volgende gegevens:

    • Naam: Kaartgegevens registreren in de Objecten API

  2. Klik op het tabblad Stappen en velden.

  3. Klik aan de linkerkant op Stap toevoegen en selecteer Maak een nieuwe formulierdefinitie.

  4. Onder de sectie (Herbruikbare) stapgegevens vul het volgende in:

    • Naam: Kaarten

  5. Scrol naar beneden en klik de sectie Speciale velden aan.

  6. Sleep een Kaart component op het witte vlak en vul de volgende gegevens in:

    • Label: Hoofdgeometrie

  7. Klik vervolgens de Registratie tab aan en vul de volgende gegevens in:

    • Registratie-attribuut: Locatie > Coördinaten

  8. Druk daarna op Opslaan.

  9. Sleep een tweede Kaart component op het witte vlak, vul de volgende gegevens in en druk daarna op Opslaan:

    • Label: Extra geometrie

  10. Klik op het tabblad Registratie.

  11. Klik op Registratiepluginoptie toevoegen en vul de volgende gegevens in:

    • Naam: Objecten API

    • Registratiemethode: Objecten API registratie

    • Objecttype: https://objecttype-example.nl/api/v2/objecttype/123

    • JSON-inhoud sjabloon:

      {
          "extraGeometrie": {% as_geo_json variables.extraGeometrie %}
      }
      
  12. Druk daarna op Opslaan en opnieuw bewerken. Het formulier kan nu ingevuld en ingestuurd worden.

Note

Het inrichten van het Objecttype en de Objecten API is geen onderdeel van dit voorbeeld, maar wel essentieel om zonder fouten formulierinzendingen te kunnen verwerken.

Toelichting

De eerste kaart is ingesteld via de “Registratie” tab op het component. Dit zorgt ervoor dat de Objecten API-registratieplugin dit veld gebruikt voor “de” geometrie van het object in de Objecten API. Deze kent hiervoor namelijk één vast attribuut.

Echter, we kunnen extra geometrieën alsnog meesturen (als het objecttype dit modelleert), dit doen we door het als GeoJSON te formatteren met de {% as_geo_json ... %} sjablooncode.

Note

Het is niet de bedoeling dat meerdere kaarten via de “Registratie” tab gekoppeld worden aan het Locatie-attribuut - als je dit wel doet, dan zal er slechts één component meegestuurd worden.

Het resulterende object wat naar de Objecten API gestuurd wordt ziet er uit als:

{
    "type": "https://objecttype-example.nl/api/v2/objecttype/123",
    "record": {
        "typeVersion": "1",
        "data": {
            "extraGeometrie": {
                "type": "Point",
                "coordinates": [52.37403, 4.88969]
            }
        },
        "startAt": "2023-01-01",
        "geometry": {
            "type": "Point",
            "coordinates": [51.9225, 4.47917]
        }
    }
}

See also

De sjabloondocumentatie heeft een referentie van beschikbare template tags, met details voor de Objecten API registratie.