MKG API Notifications/Activities

This article contains the frequently used API calls for Notifications/Activities.

Tested on API V3 and MKG Version 005.91.014.


Table of Contents


Data Dictionary
For information on endpoints, fields, and actions, see this article.

 

Postman
For examples of API calls, see this article.

 

Retrieve

 

Notification Type

To retrieve a notification type, use the following 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

 

Notification

To retrieve a notification, use the following 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

 

Notification Response

To retrieve a notification response, use the following 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

 

Activity

To retrieve activities, use the following call: 

GET {{restUrl}}/Documents/acti

{{restUrl}}/Documents/acti

 

Specific Activity

To retrieve a specific activity, use the following 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

 

Create

 

Notification

To create a notification, use the following 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"
                }
            ]
        }
    }
}

 

Notification with Response

To create a notification with response, use the following 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 yes/no", 
                    "pmla_waarde": "yes"
                    },
                    { 
                    "parm_code": "API choice list",
                    "pmla_waarde": "1"
                    },
                    {
                    "parm_code": "API text", 
                    "pmla_waarde": "API autotest" 
                    }
            ]
        }
    }
}
 
 
 

Activity

To create an activity, use the following 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": "Call",
                "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
                }
            ]
        }
    }
}
 

Actions

 

Change Activity Status

To change the active status of an activity, use the following 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
                }
            ]
        }
    }
}

 

To change the active status of multiple activities, use the following call:

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

 

Start Activity

To start an activity, use the following call:

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

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

 

Complete Activity

To complete an activity, use the following call:

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

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