Difference between revisions of "MOR API system version get"

From Kolmisoft Wiki
Jump to navigationJump to search
(Created page with ''This functionality is available from MOR 8'' MOR API Get MOR version number <br><br> ---- <br><br> * Call: /api/get_version * Methods: POST, GET(if allowed, …')
 
Line 1: Line 1:
'This functionality is available from [[MOR 8| MOR 8]]''
<!---This functionality is available from [[MOR 8| MOR 8]]--->
=Description=


[[MOR API]] for getting MOR version number
<br><br>
=Configuration=


[[MOR API]]
Go to '''SETTINGS –> Setup –> Settings''' select API tab and check '''Allow API globaly'''. 
 
Get MOR version number
 
<br><br>
----
<br><br>
<br><br>
=Usage=


* Call: /api/get_version
* Call: /api/system_version_get
* Methods: POST, GET(if allowed, not recomended)
* Methods: POST, GET(if allowed, not recomended)
* Params:
===Parameters=== 
** u - username to login. '''Required'''.
<br><br>
** p - password to login. '''Required'''.
* u - username to login. '''Required'''.
** [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
*[[MOR API hash construction | hash]] SHA1 hash constructed using '''API Secret Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
**


* Returns:
* Returns:
**Success
**Success:
<version>version_number</version>
  <page>
    <version>MOR GUI version</version>
  </page>
 
**Errors:
*** <error>API Requests are disabled</error> – '''Allow API globally''' setting is unchecked.
*** <error>Access Denied</error> – User was not authorized.
*** <error>Incorrect hash</error> – Hash was not correct. Check API Secret Key and order or params while concatenating hash_string.
Example:
  <status>
    <error>API Requests are disabled</error>
  </status>
<br><br>
=See also=


** Errors:
* [[MOR API]]
*** <error>Bad login</error> - User supplied bad login or password.
*** <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.

Revision as of 14:26, 19 May 2013

Description

MOR API for getting MOR version number

Configuration

Go to SETTINGS –> Setup –> Settings select API tab and check Allow API globaly.

Usage

  • Call: /api/system_version_get
  • Methods: POST, GET(if allowed, not recomended)

Parameters



  • Returns:
    • Success:
 <page>
   <version>MOR GUI version</version>
 </page>
    • Errors:
      • <error>API Requests are disabled</error> – Allow API globally setting is unchecked.
      • <error>Access Denied</error> – User was not authorized.
      • <error>Incorrect hash</error> – Hash was not correct. Check API Secret Key and order or params while concatenating hash_string.

Example:

 <status>
   <error>API Requests are disabled</error>
 </status>



See also