Giter VIP home page Giter VIP logo

maykinmedia / objects-api Goto Github PK

View Code? Open in Web Editor NEW
7.0 4.0 7.0 7.13 MB

API and admin interface to manage Objects of certain Objecttypes. An object can be anything whether its a monument, report, tree or a permit.

Home Page: https://opengem.nl/producten/overige-registraties/

License: Other

Dockerfile 0.46% Batchfile 0.11% Shell 1.12% Python 87.41% JavaScript 3.15% HTML 4.62% SCSS 2.78% Smarty 0.35%
commonground

objects-api's Introduction

Objects API

Version

2.3.1

Source

https://github.com/maykinmedia/objects-api

Keywords

objects, assets, zaakobjecten

Documentation Status

API to manage objects belonging to a certain object type. (Nederlandse versie)

Developed by Maykin Media B.V. commissioned by the Municipality of Utrecht.

Introduction

The Objects API aims to easily store various objects and make them available in standardized format. It can be used by any organization to manage relevant objects. An organization can also choose to use it to expose objects to the public as Open Data.

To define the format of objects, so called object types, organizations can use a national and/or local Objecttypes API.

API specification

Lint OAS Generate SDKs Generate Postman collection

Version Release date API specification

latest

n/a

ReDoc, Swagger, (diff)

2.3.1

2024-03-22

ReDoc, Swagger (diff)

2.3.0

2024-03-15

ReDoc, Swagger (diff)

2.2.1

2024-01-30

ReDoc, Swagger (diff)

2.1.1

2022-06-24

ReDoc, Swagger (diff)

2.1.0

2022-05-17

ReDoc, Swagger (diff)

2.0.0

2021-09-22

ReDoc, Swagger (diff)

1.3.0

2021-01-12

ReDoc, Swagger (diff)

1.2.0

2021-09-22

ReDoc, Swagger (diff)

1.1.1

2021-06-22

ReDoc, Swagger (diff)

1.1.0

2021-04-21

ReDoc, Swagger (diff)

1.0.0

2021-01-13

ReDoc, Swagger

Previous versions are supported for 6 month after the next version is released.

See: All versions and changes

Reference implementation

Build status Coverage Code style Docker image Supported Python version

The reference implementation is used to demonstrate the API in action and can be used for test and demo purposes. The reference implementation is open source, well tested and available as Docker image.

Quickstart

  1. Download and run the Objects API:

  2. In the browser, navigate to http://localhost:8000/ to access the admin and the API.

References

License

Copyright © Maykin Media, 2020 - 2021

Licensed under the EUPL

objects-api's People

Contributors

alextreme avatar annashamray avatar bart-maykin avatar dariomory avatar dependabot[bot] avatar erhancitil avatar joeribekker avatar lvdbrink avatar sergei-maertens avatar sjoerdie avatar stevenbal avatar viicos avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

objects-api's Issues

As productowner, I want a demo app to demonstrate the interactions of the APIs

Based on the existing ZGW demo app, we can extend this demo app to show Objects and Objecttypes functionalitities.

The existing app can be found here: https://zgw-demo.vng.cloud/
And on Github: https://github.com/VNG-Realisatie/gemma-zaken-demo

We'll use the current JSON-schema definitions that we have: Boom and Melding. Geo-coordinates need to be present in the Objects API to make this work and Boom should have them.

1600771114479

1. Open data -- A map showing objects of selected (public) objecttypes (ie. Boom)

Similar to: https://zgw-demo.vng.cloud/apps/opendata/

Instead of "zaaktypen" it should say "objecttypen". Only public objecttypes should be shown, so in this case: Trees.
Later, I want to add "Lamppost" as public Objecttype to the API and it should then show up in the list of objecttypes in the demo app. We also need a testset for this.

  • Add geocoordinates to objects api
  • Add Boom schema and add a demo set of (like 10 on a specific geo area)
  • Copy app to new app
  • Retrieve public Objecttypes and show as checkbox on the side, instead of Zaaktypes
  • Retrieve Objects (within geo-area?) of selected Objecttypes
  • Create lamppost schema and 10 demo items or so (in the same geo area as trees)

2. Melding Openbare Ruimte -- Make a Melding about a Boom

Extension on: https://zgw-demo.vng.cloud/apps/mor/

Instead of selecting an address, you can select a public objecttype (tree) and select a specific tree on the map. On submission, a Zaak of Zaaktype "Melding Openbare Ruimte" is created, with related ZaakObjecten: Boom and Melding.

  • Copy MOR app, to use for selecting objects
  • Retrieve public Objecttypes and show as pulldown
  • Retrieve Objects (within geo-area?) of selected Objecttype
  • Allow user to pick shown object
  • Submitting should create a zaak with related ZaakObject: Melding and Tree. The Melding should have some Melding specific values that are appropriate.
  • Bonus: Make a radio button to switch between selecting an address and selecting an object in the same MOR app.

3. ZAC -- Show related objects

Extension on: https://zgw-demo.vng.cloud/apps/zaakbeheer/a6811688-be0e-4676-83d5-5ec8ae0d855f/

As part of the Zaak detail screen, we can show the related ZaakObjecten.

  • Retrieve ZaakObjecten that are relelated to the Zaak, and show Objecttype name and maybe some generic data?
  • Bonus: When clicking a ZaakObject, a detail screen will show, showing all key-values of that object.

As productowner, I want to organize a workshop to retrieve user stories from stakeholders

Mogelijke onderwerpen:

  • bespreken initiele objecttypes

Mogelijke objecttypes:

  • Inkomen (GBI)
  • Vermogen (GBI)
  • Vorderingen (GBI)
  • Huishouden (Rotterdam)
  • Meldingen (VNG/Amsterdam)
  • Evenementenvergunningen (Utrecht)
  • Activiteiten (sociaal domein) (Utrecht)
  • Subsidies (Delft) [1]
  • Bomen (Delft) [2]

[1] Verankerd in het Gemeentelijke Gegevens Model: https://gemeente-delft.github.io/Gemeentelijk-Gegevensmodel/domeinen/subsidies/https://gemeente-delft.github.io/Gemeentelijk-Gegevensmodel/domeinen/subsidies/
[2] IMBOR model: https://gemeente-delft.github.io/Gemeentelijk-Gegevensmodel/domeinen/image/IMGeoVSIMBOR.png

  • verwijzingen naar buiten de Objects API
  • verwijzingen binnen de Objects API
  • verwijzingen heen en terug
  • historie van objecten
  • autorisatie op objecten
  • autorisatie op objecttypen
  • waar op filteren binnen objecten
  • genestheid/gelaagdheid van JSON-schemas
  • beheer gegevens / wie beheert
  • verwijderen van objecten
  • attributen onderverdelen in clusters/categorieen
  • bulk opvoeren
  • koppelen met registraties

Mogelijkheden:

  • Direct aansluiten op de bron
  • Direct bevragen via bestaande service
  • Periodiek automatisch synchroniseren
  • Periodiek handmatig uploaden

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.