Company administration service methods: Difference between revisions

← Older edit Newer edit →

VisualWikitext

@@ Line 13: / Line 13: @@
 <code>getCompanyParam</code> API method returns configuration value for specified key. Method return invalid params error (code [[Errors handling#Error codes|-32602]]) in case if specified key not allowed.
-Administration API inherits all [[Company public service methods#getCompanyParam|keys]] allowed for public API and extends this list with keys:
+----
+====getPluginStatuses====
+<code>getPluginStatuses(pluginNames)</code>
+Params:
+* '''pluginNames''' an array of strings
+Returns an associative array with strings as keys and booleans as values.
+Returns an associative array (a JSON object) with values from <code>pluginNames</code> parameter as keys and boolean values for each plugin. See [[Company public service methods#pluginName|description of public service <code>isPluginActivated</code> method]] for list of available plugin names.
+----
+====isPluginActivated====
+<code>isPluginActivated(pluginName)</code>
+Params:
+* '''pluginName''' string
+Returns boolean (1 or 0).
+Return plugin status true if status active, else false. <code>pluginName</code> parameter is a plugin. See [[Company public service methods#Plugin's identifiers|description of public service <code>isPluginActivated</code> method]] for list of available plugin names.
+==Constants==
+====Company params====
+Use these values to get configuration params for company with <code>[[#getCompanyParam|getCompanyParam]]</code> API method.
+Administration API inherits all [[Company public service methods#Company_param|keys]] allowed for public API and extends this list with keys:
 * attach_ical
@@ Line 160: / Line 193: @@
 * zooz_app_id
 * zooz_app_key
-----
-====getPluginStatuses====
-<code>getPluginStatuses(pluginNames)</code>
-Params:
-* '''pluginNames''' an array of strings
-Returns an associative array with strings as keys and booleans as values.
-Returns an associative array (a JSON object) with values from <code>pluginNames</code> parameter as keys and boolean values for each plugin. See [[Company public service methods#pluginName|description of public service <code>isPluginActivated</code> method]] for list of available plugin names.
-----
-====isPluginActivated====
-<code>isPluginActivated(pluginName)</code>
-Params:
-* '''pluginName''' string
-Returns boolean (1 or 0).
-Return plugin status true if status active, else false. <code>pluginName</code> parameter is a plugin. See [[Company public service methods#pluginName|description of public service <code>isPluginActivated</code> method]] for list of available plugin names.