From 045f115d950b7a45434ed4bcd7f5c3e21d0b4026 Mon Sep 17 00:00:00 2001
From: marcos <marcos.alconada@artica.es>
Date: Mon, 13 Apr 2020 10:54:37 +0200
Subject: [PATCH] documented api function

---
 pandora_console/include/functions_api.php | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/pandora_console/include/functions_api.php b/pandora_console/include/functions_api.php
index f9d0111919..c0e671e8d1 100644
--- a/pandora_console/include/functions_api.php
+++ b/pandora_console/include/functions_api.php
@@ -15992,6 +15992,19 @@ function util_api_check_agent_and_print_error($id_agent, $returnType, $access='A
 }
 
 
+/**
+ * Function for get event id and node id, then we get in return the Metaconsole event ID.
+ *
+ * @param [string] $server_id        id server (Node)
+ * @param [string] $console_event_id console Id node event in tmetaconsole_event
+ * @param [string] $trash2           don't use
+ * @param [string] $returnType
+ *
+ * Example
+ * api.php?op=get&op2=event_mcid&return_type=json&id=0&id2=0&apipass=1234&user=admin&pass=pandora
+ *
+ * @return void
+ */
 function api_get_event_mcid($server_id, $console_event_id, $trash2, $returnType)
 {
     global $config;