MKG API Meldingen/Activiteiten

Dit artikel bevat de veelgebruikte API-aanroepen voor Meldingen/Activiteiten.

Getest op API V3 en MKG Versie 005.91.014.


Inhoudsopgave


Data dictionary
Voor informatie over endpoints, velden en acties, zie dit artikel.

 

Postman
Voor voorbeelden van API-aanroepen, zie dit artikel.

 

Opvragen

 

Meldingstype

Voor het opvragen van een een meldingstype kan gebruik worden gemaakt van de volgende call: 

GET {{restUrl}}/Documents/mldn/?Filter=mldn_actief = true&FieldList=mldn_num,mldn_oms

{{restUrl}}/Documents/mldn/?Filter=mldn_actief = true&FieldList=mldn_num,mldn_oms

 

Melding

Voor het opvragen van een melding kan gebruik worden gemaakt van de volgende call: 

GET {{restUrl}}/Documents/pmld/{{pmld_code}}?FieldList=pmld_oms,pmld_memo,pmld_memo_extern,pmld_memo_samenvatting

{{restUrl}}/Documents/pamt/?Filter=part_num = {{part_num}}&FieldList=part_num,pamt_type&Sort=pamt_type

 

Meldingsantwoord

Voor het opvragen van een meldingsantwoord kan gebruik worden gemaakt van de volgende call: 

GET {{restUrl}}/Documents/pmla/?Filter=pmld_code = {{pmld_code}}&FieldList=pmla_waarde&Sort=pmla_waarde

{{restUrl}}/Documents/pmla/?Filter=pmld_code = {{pmld_code}}&FieldList=pmla_waarde&Sort=pmla_waarde

 

Activiteit

Voor het opvragen van activiteiten kan gebruik worden gemaakt van de volgende call: 

GET {{restUrl}}/Documents/acti

{{restUrl}}/Documents/acti

 

Activiteit specifiek

Voor het opvragen van een specifieke activiteit kan gebruik worden gemaakt van de volgende call: 

GET {{restUrl}}/Documents/geac/{{geac_rowkey}}?FieldList=geac_actief,geac_status,geac_dat_gestart,geac_tijd_gestart,geac_prioriteit

{{restUrl}}/Documents/geac/{{geac_rowkey}}?FieldList=geac_actief,geac_status,geac_dat_gestart,geac_tijd_gestart,geac_prioriteit

 

Aanmaken

 

Melding

Voor het aanmaken van een melding kun je gebruikmaken van de volgende call:

POST {{restUrl}}/Documents/pmld

{{restUrl}}/Documents/pmld

Request body:

{
    "request": {
        "InputData": {
            "pmld": [
                {
                "mldn_num": 9999,
                "gebr_code": "{{gebr_code}}",
                "pmld_oms": "API autotest",
                "pmld_memo": "API autotest",
                "pmld_memo_extern": "API autotest",
                "pmld_memo_samenvatting": "API autotest"
                }
            ]
        }
    }
}

 

Melding met meldingsantwoord

Voor het aanmaken van een melding met meldingsantwoord kun je gebruik maken van de volgende call:

POST {{restUrl}}/Documents/pmld/ 

{{restUrl}}/Documents/pmld/

Request body:

{
    "request": {
        "InputData": {
            "pmld": [
                {
                "gebr_code": "{{gebr_code}}",
                "mldn_num": 9998,
                "pmld_oms": "API autotest",
                "pmld_memo": "API autotest",
                "pmld_memo_extern": "API autotest",
                "pmld_memo_samenvatting": "API autotest"
                }
                    ],
                    "pmld_pmla": [
                    {
                    "parm_code": "API ja/nee", 
                    "pmla_waarde": "ja"
                    },
                    { 
                    "parm_code": "API keuzelijst",
                    "pmla_waarde": "1"
                    },
                    {
                    "parm_code": "API tekst", 
                    "pmla_waarde": "API autotest" 
                    }
            ]
        }
    }
}
 
 
 

Activiteit

Voor het aanmaken van een activiteit kun je gebruikmaken van de volgende call:

POST {{restUrl}}/Documents/geac

{{restUrl}}/Documents/geac

Request body:

{
    "request": {
        "InputData": {
            "geac": [
                {
                "geac_todo": true,
                "geac_agenda": true,
                "gebr_code": "{{gebr_code}}",
                "grpn_num": 1,
                "acti_num": {{acti_num}},
                "geac_oms": "Bellen",
                "geac_tijd_van": 36000,
                "geac_tijd_tot": 39600,
                "geac_dat_tot": "2025-01-01",
                "geac_dat_van": "2025-01-01",
              "geac_prioriteit": 2,
              "geac_status": 2,
                "geac_dat_gestart": "2023-04-28",
                "geac_tijd_gestart": 32400,
                "geac_volgorde": 0,
              "geac_start_type": 0,
              "geac_herplan_type": 0
                }
            ]
        }
    }
}
 

Acties

 

Activiteit actief wijzigen

Voor het wijzigen van het actief zijn van een activiteit maak je gebruik van de volgende call:

PUT{{restUrl}}/Documents/geac/{{geac_num}}/Service/s_actief

{{restUrl}}/Documents/geac/{{geac_num}}/Service/s_actief

Request body:

{
    "request": {
        "InputData": {
            "geac": [
                {
                "RowKey": 1,
                "t_activeer_activiteiten": false
                }
            ]
        }
    }
}

 

Voor het wijzigen van het actief zijn van meerdere activiteiten kun je gebruikmaken van de volgende call:

{
    "request": {
        "InputData": {
            "geac": [
                {
                "RowKey": 1,
              "t_activeer_activiteiten": true
                }
            ],
            "t_selected_rows": [
                {
                  "t_value": "0x0000000000725f85"
                },
                {
                    "t_value": "0x0000000000725f86"
                }
            ]
        }
    }
}

 

Activiteit starten

Voor het starten van een activiteit maak je gebruik van de volgende call:

PUT{{restUrl}}/Documents/geac/{{geac_num}}/Service/s_start

{{restUrl}}/Documents/geac/{{geac_num}}/Service/s_start

 

Activiteit gereedmelden

Voor het gereedmelden van een activiteit kun je gebruikmaken van de volgende call:

PUT{{restUrl}}/Documents/geac/{{geac_num}}/Service/s_gereed

{{restUrl}}/Documents/geac/{{geac_num}}/Service/s_gereed