Koppelprofiel Zaakinformatie bevragen: verschil tussen versies

Uit ZaaksysteemWiki
Ga naar: navigatie, zoeken
(Nieuwe pagina aangemaakt met '__TOC__ = Inleiding = BuitenBeter is een dienst waarmee burgers eenvoudig via een smartphone een melding kunnen indienen over de woon- of leefomgeving bij de geme...')
 
 
(2 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 1: Regel 1:
 
__TOC__
 
__TOC__
  
 +
===== Korte uitleg (Zaken obv JSON) =====
 +
Zaaksysteem biedt een mogelijk om zaakinformatie op te vragen van zaken die door middel van een publieke zoekopdracht te benaderen. De resultaten (zaakinformtie) van deze zoekopdracht worden terug gegeven in JSON-formaat en kunnen daarna gepresenteerd worden bijvoorbeeld door een CMS.<br>
 +
<br>
 +
===== Welke data kan opgevraagd worden? =====
 +
De resultaten van zaken in een (publiek gepubliceerde) zoekopdracht. Hierbij is een set van gegevens op te vragen, namelijk:<br>
  
−
= Inleiding =
+
* Zaaknummer (zaak.id)
−
BuitenBeter is een dienst waarmee burgers eenvoudig via een smartphone een melding kunnen indienen over de woon- of leefomgeving bij de gemeente. Het versturen van een melding betekent dat er automatisch een zaak wordt geregistreerd in het zaaksysteem en dat melder een bericht ontvangt over de voortgang van de behandeling.
+
* Zaaktype (zaaktype.naam)
−
 
+
* Registratiedatum
−
= Inrichting zaaksysteem =
+
* Afhandeldatum
−
Het inrichten van een koppeling met BuitenBeter kan geheel zelfstandig worden uitgevoerd door gebruik te maken van het koppelprofiel.
+
* Status (zaak.status)
−
 
+
* Fase (naam)
−
= Inrichting extern systeem =
+
* Extra informatie (zaak.onderwerp)
−
= Testscenario =
+
* Resultaat (zaak.resultaat)
−
 
+
<br>
−
== Koppelprofiel beheren ==
+
===== Hoe wordt de data ontvangen? =====
−
* Als beheerder wil ik
+
De data wordt gerouterneerd in JSON formaat. De zaken zelf staan in de property 'result', wat altijd een array is. In het geval van een foutmelding is het eerste object in de 'result' array een foutmeldingobject. In principe wordt de HTTP status code in dit geval ook op 500 gezet. Deze status code zit ook in het antwoord in de property 'status_code'. In de properties 'next' en 'prev' staan de URLs waarmee volgende en vorige pagina's kunnen worden opgevraagd, 'at' is de huidige pagina, 'num_rows' het totaal aantal zaken wat aan de zoekopdrachten voldoet, en 'rows' is het aantal zaken wat in dit antwoord wordt teruggegeven.<br>
−
 
+
<br>
−
== Meldingen behandelen ==
+
===== Hoe kan data worden bevraagd? =====
−
* Als behandelaar wil ik
+
De url van de call is {host}/public/search_case/?search_query_id={id}, waarbij {host} bijvoorbeeld 'https://mintlab.zaalsysteem.nl' is, en {id} het id van de gepubliceerde zoekopdracht.<br>
−
 
+
<br>
−
= Beheer en onderhoud =
+
===== Hoe moet data worden verwerkt? =====
−
beheerders van het zaaksysteem kunnen de werking van de koppeling goed in de gaten houden. Alle berichten die worden ontvangen en verstuurd, worden opgeslagen in de transactielog. In de transactielog is terug te vinden of de verwerking van een bericht is gelukt, of dat deze mislukt is en een fout heeft gegenereerd.
+
De data komt terug in een JSON string, die geparsed moet worden. De hashes met de kenmerken van de gevonden zaken staan in de property 'result' in een array.<br>
−
= Voorbeeldbestanden =
+
<br>
−
= Overige documentatie =
+
===== Voorbeeldvraag =====
 +
https://quarterly.zaaksysteem.nl/public/search_case/?search_query_id=1<br>
 +
<br>
 +
===== Voorbeeldantwoord =====
 +
<pre>
 +
{
 +
"next": null,
 +
"comment": "This is not a DBIx::Class::ResultSet and does NOT support paging.",
 +
"prev": null,
 +
"at": null,
 +
"num_rows": 1,
 +
"rows": null,
 +
"result": [
 +
[
 +
{
 +
"afhandeldatum": null,
 +
"zaaktype": "bagtest",
 +
"status": "new",
 +
"fase": "Naam van Fase komt hier",
 +
"onderwerp": null,
 +
"registratiedatum": "2013-09-05T12:33:57",
 +
"resultaat": null,
 +
"id": 155
 +
}
 +
]
 +
]
 +
}
 +
</pre>

Huidige versie van 3 mrt 2014 om 06:34

Korte uitleg (Zaken obv JSON)

Zaaksysteem biedt een mogelijk om zaakinformatie op te vragen van zaken die door middel van een publieke zoekopdracht te benaderen. De resultaten (zaakinformtie) van deze zoekopdracht worden terug gegeven in JSON-formaat en kunnen daarna gepresenteerd worden bijvoorbeeld door een CMS.

Welke data kan opgevraagd worden?

De resultaten van zaken in een (publiek gepubliceerde) zoekopdracht. Hierbij is een set van gegevens op te vragen, namelijk:

  • Zaaknummer (zaak.id)
  • Zaaktype (zaaktype.naam)
  • Registratiedatum
  • Afhandeldatum
  • Status (zaak.status)
  • Fase (naam)
  • Extra informatie (zaak.onderwerp)
  • Resultaat (zaak.resultaat)


Hoe wordt de data ontvangen?

De data wordt gerouterneerd in JSON formaat. De zaken zelf staan in de property 'result', wat altijd een array is. In het geval van een foutmelding is het eerste object in de 'result' array een foutmeldingobject. In principe wordt de HTTP status code in dit geval ook op 500 gezet. Deze status code zit ook in het antwoord in de property 'status_code'. In de properties 'next' en 'prev' staan de URLs waarmee volgende en vorige pagina's kunnen worden opgevraagd, 'at' is de huidige pagina, 'num_rows' het totaal aantal zaken wat aan de zoekopdrachten voldoet, en 'rows' is het aantal zaken wat in dit antwoord wordt teruggegeven.

Hoe kan data worden bevraagd?

De url van de call is {host}/public/search_case/?search_query_id={id}, waarbij {host} bijvoorbeeld 'https://mintlab.zaalsysteem.nl' is, en {id} het id van de gepubliceerde zoekopdracht.

Hoe moet data worden verwerkt?

De data komt terug in een JSON string, die geparsed moet worden. De hashes met de kenmerken van de gevonden zaken staan in de property 'result' in een array.

Voorbeeldvraag

https://quarterly.zaaksysteem.nl/public/search_case/?search_query_id=1

Voorbeeldantwoord
{
	"next": null,
	"comment": "This is not a DBIx::Class::ResultSet and does NOT support paging.",
	"prev": null,
	"at": null,
	"num_rows": 1,
	"rows": null,
	"result": [
		[
			{
				"afhandeldatum": null,
				"zaaktype": "bagtest",
				"status": "new",
				"fase": "Naam van Fase komt hier",
				"onderwerp": null,
				"registratiedatum": "2013-09-05T12:33:57",
				"resultaat": null,
				"id": 155
			}
		]
	]
}
Overgenomen van "http://wiki.zaaksysteem.nl/index.php?title=Koppelprofiel_Zaakinformatie_bevragen&oldid=4852"