HOE WERKT DE API WIJZIGEN KENMERKEN ZAAK/OBJECT/DOCUMENT

Transcriptie

1 HOE WERKT DE API WIJZIGEN KENMERKEN ZAAK/OBJECT/DOCUMENT Hoe werkt de API wijzigen kenmerken zaak/object/document? Pagina 1 van 6 Zie voor de algemene uitleg over binnenkomende koppelverzoeken het document Hoe werken binnenkomende koppelverzoeken?. Dit document geeft uitleg over de Mozard API Wijzigen kenmerkzaak die via een opdracht in een binnenkomend koppelverzoek geautomatiseerd kan worden uitgevoerd. Het nummer van deze API: 11. De hier besproken versie: Opus 7 Specifieke XML <moz_opdracht> <moz_opdrachtapi /> <moz_opdrachtreferentie /> <moz_attributen> <moz_dd_dossier> <moz_dd_dossier_waarde/> <moz_zk_volgnr_waarde/> <moz_zk_volgnr_indzojuistaangemaakt /> <moz_zk_volgnr_indeerstaangemaakt /> <moz_zk_volgnr_zaaktype_waarde /> <moz_zk_volgnr_zaaktype_string /> <moz_zk_volgnr_referentiebo /> <moz_obj_volgnr_waarde/> <moz_obj_volgnr_indzojuistaangemaakt /> <moz_obj_volgnr_indeerstaangemaakt /> <moz_obj_volgnr_registratie_waarde /> <moz_obj_volgnr_registratie_string /> <moz_obj_volgnr_bronreferentie /> <moz_obj_volgnr_bronidentificatie /> <moz_doc_document_volgnr_indzojuistaangemaakt /> </moz_dd_dossier> <moz_kenmerk> <moz_km_type_waarde/> <moz_km_type_string/>

2 Pagina 2 van 6 <moz_km_type_selectie/> <moz_km_type_referentie/> <moz_km_waarde/> <moz_km_waarde_bronidentifcatie/> <moz_huidigewaarde_waarde/> <moz_huidigewaarde_string/> <moz_indtoevoegen/> <moz_indverwijderen/> <moz_indwijzigen/> </moz_kenmerk> </moz_attributen> </moz_opdracht> Toelichting per kenmerk <moz_opdrachtapi /> (numeriek, 12) Moet waarde 11 hebben. <moz_opdrachtreferentie /> (alfanumeriek) Wordt teruggegeven bij het resultaat. <moz_dd_dossier_waarde/>(numeriek, 7) Nummer van het dossier dat gebruikt moet worden. <moz_zk/obj_volgnr_waarde /> (numeriek, 12) Nummer van zaak/object welke gebruikt moet worden. <moz_zk/obj_volgnr_indzojuistaangemaakt /> (JN) Zojuist aangemaakte zaak/object gebruiken. <moz_zk/obj_volgnr_indeerstaangemaakt /> (JN) Het zaak/objectnummer van de eerst aangemaakte zaak/object gebruiken. <moz_zk_volgnr_zaaktype_waarde/> (numeriek, 12) <moz_zk_volgnr_zaaktype_string/> (alfanumeriek, 80) Het zaaknummer bepalen via het zaaktype door middel van het nummer of door een string waarmee het zaaktype uniek te bepalen is. Dus de string moet tot één zaaktype leiden, niet tot nul of meer dan één. Wanneer deze methode gebruikt wordt is <moz_zk_volgnr_referentiebo /> tevens verplicht.

3 Hoe werkt de API wijzigen kenmerken zaak/object/document? Pagina 3 van 6 <moz_zk_volgnr_referentiebo /> (alfanumeriek, 240) Relevant om op basis van een referentie te kunnen bepalen welke zaak in een backofficetoepassing het betreft waarvan het zaaknummer gebruikt moet worden. Verplicht als <moz_zk_volgnr_zaaktype_waarde/> of <moz_zk_volgnr_zaaktype_string/> gevuld is. <moz_obj_volgnr_registratie_waarde /> (numeriek, 12) <moz_obj_volgnr_registratie_string /> (alfanumeriek, 80) Het objectnummer bepalen via de registratie door middel van het nummer of door een string waarmee de registratie uniek te bepalen is. Dus de string moet tot één registratie leiden, niet tot nul of meer dan één. Wanneer deze methode gebruikt wordt is <moz_obj_volgnr_bronreferentie /> of <moz_obj_volgnr_bronidentificatie /> tevens verplicht. <moz_doc_document_volgnr_indzojuistaangemaakt /> (JN) Zojuist toegevoegde document gebruiken. <moz_km_type_waarde/> (numeriek, 7) <moz_km_type_string/> (alfanumeriek, 80) Het kenmerktype bepalen door middel van het nummer of door een string waarmee het kenmerktype uniek te bepalen is. Dus de string moet tot één kenmerktype leiden, niet tot nul of meer dan één. Verplicht indien <moz_km_type_selectie/> of <moz_km_type_referentie/> niet gevuld is. <moz_km_type_selectie/> (numeriek, 12) <moz_km_type_referentie/> (alfanumeriek, 80) De kenmerkselectie bepalen door middel van het nummer of door een string waarmee de kenmerkselectie uniek te bepalen is. Dus de string moet tot één kenmerkselectie leiden, niet tot nul of meer dan één. Verplicht indien <moz_km_type_waarde/> of <moz_km_type_string/> niet gevuld is. <moz_km_waarde/> (3800) De nieuwe waarde van het kenmerk, het formaat is afhankelijk van het kenmerktype. <moz_km_waarde_bronidentifcatie/> (alfanumeriek, 100) De nieuwe waarde van het kenmerk bepalen aan de hand van een bronidentificatie bij een object. Dit kan alleen als het kenmerk van het type registratie is. <moz_huidigewaarde_waarde/> (numeriek, 12) <moz_huidigewaarde_string/> (3800)

4 Pagina 4 van 6 De huidige waarde van het te wijzigen of verwijderen kenmerk bepalen door middel van het nummer of door een string waarmee het kenmerk uniek te bepalen is. Dus de string moet tot één kenmerk leiden, niet tot nul of meer dan één. Het formaat van de string is afhankelijk van het kenmerktype. Verplicht als <moz_indverwijderen/> is J of <moz_indwijzigen/> is J en <moz_indtoevoegen> is leeg. <moz_indtoevoegen/> (J/N) <moz_indverwijderen/> (J/N) <moz_indwijzigen/> (J/N) Kenmerk bij zaak toevoegen, verwijderen of wijzigen. Wanneer zowel <moz_indtoevoegen/> en <moz_indwijzigen/> waarde J hebben is <moz_huidigewaarde_waarde/> of <moz_huidigewaarde_string/> niet verplicht. Het kenmerk wordt dan naar gelang bijgewerkt of toegevoegd. Verplicht. Specifieke foutmeldingen Zie voor de generieke foutmeldingen het document Hoe werken binnenkomende koppelverzoeken?. De specifieke foutmeldingen binnen deze API zijn: 10019: Een van de waarden moet J zijn : <xxx> niet kunnen bepalen : Kenmerk type is <xxx> ontvangen waarde <xxx> : Fout bij wijzigen/verwijderen kenmerk, hoort niet bij dit dossier of is verwijderd : Kenmerk niet gewijzigd omdat opgegeven waarde niet uniek voorkomt/te wijzigen record niet bepaald is. Voorbeeld xml Dit voorbeeld is ook als apart xml document beschikbaar. <?xml version="1.0" encoding="utf-8"?> <moz_koppelverzoek> <moz_generiek> <moz_koppelverzoekreferentie><![cdata[referentie]]></moz_koppelverzoekreferentie> <moz_koppelverzoekxxb>n4cnfmtkk6q42j4j8p36v77wxtgj0mmn8cnf7tm41oiaoli8yvsj5fjk XS7F8F8SIEJADRNAEMGKSQ4WO UUG9VWK22L9</moz_koppelverzoekxxb> <moz_koppelverzoekxxc>2</moz_koppelverzoekxxc> <moz_koppelverzoekxxd></moz_koppelverzoekxxd> <moz_koppelverzoekxxe></moz_koppelverzoekxxe> <moz_indxmlcheck>n</moz_indxmlcheck> <moz_inddirectstarten>j</moz_inddirectstarten> <moz_urlresultaat>

5 Pagina 5 van 6 <moz_urlresultaat_url><![cdata[ <moz_urlresultaat_uid/> <moz_urlresultaat_ww/> </moz_urlresultaat> </moz_generiek> <moz_opdrachten> <moz_opdracht> <moz_opdrachtreferentie><![cdata[aanmaken nieuwe zaak]]></moz_opdrachtreferentie> <moz_opdrachtapi>1</moz_opdrachtapi> <moz_attributen> <moz_dos_naam><![cdata[voorlopige naam]]></moz_dos_naam> <moz_dos_omschrijving><![cdata[omschrijving van de zaak]]></moz_dos_omschrijving> <moz_zk_zaaktype> <moz_zk_zaaktype_waarde></moz_zk_zaaktype_waarde> <moz_zk_zaaktype_string>koppelvlak</moz_zk_zaaktype_string> </moz_zk_zaaktype> <moz_zk_gerelateerdezaak></moz_zk_gerelateerdezaak> <moz_zk_zaaktypedeelvervolgzaaktype> <moz_zk_zaaktypedeelvervolgzaaktype_waarde></moz_zk_zaaktypedeelvervolgzaaktype_waarde > <moz_zk_zaaktypedeelvervolgzaaktype_string></moz_zk_zaaktypedeelvervolgz aaktype_string> </moz_zk_zaaktypedeelvervolgzaaktype> <moz_zk_datumgestart></moz_zk_datumgestart> <moz_zk_kanaal> <moz_zk_kanaal_waarde></moz_zk_kanaal_waarde> <moz_zk_kanaal_string></moz_zk_kanaal_string> </moz_zk_kanaal> <moz_zk_kenmerkopaanvraag><![cdata[referentie op aanvraag]]></moz_zk_kenmerkopaanvraag> <moz_zk_datumopaanvraag> </moz_zk_datumopaanvraag> <moz_zk_referentiebo><![cdata[referentie backoffice]]></moz_zk_referentiebo> <moz_zk_sorteerprio>3</moz_zk_sorteerprio> <moz_zk_aandachtspunten><![cdata[aandachtspunten]]></moz_zk_aandachtspunten> <moz_zk_indcorrespondentie>n</moz_zk_indcorrespondentie> </moz_attributen> </moz_opdracht> <moz_opdracht> <moz_opdrachtreferentie><![cdata[wijzigen kenmerken zaak]]></moz_opdrachtreferentie> <moz_opdrachtapi>11</moz_opdrachtapi> <moz_attributen> <moz_dd_dossier>

6 Pagina 6 van 6 <moz_zk_volgnr_indzojuistaangemaakt>j</moz_zk_volgnr_indzojuistaangemaakt> </moz_dd_dossier> <moz_kenmerk> <moz_km_type_string><![cdata[bedrag alfa]]></moz_km_type_string> <moz_km_waarde><![cdata[65]]></moz_km_waarde> <moz_indtoevoegen>j</moz_indtoevoegen> </moz_kenmerk> </moz_attributen> </moz_opdracht> </moz_opdrachten> </moz_koppelverzoek>