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, …')
 
 
(8 intermediate revisions by the same user not shown)
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>
=Usage=
* From '''MOR X4''' call: /api/system_version_get
* For Backwards-compatibility old name 'get_version' is also usable. Call: '''/api/get_version'''
* Methods: POST, GET(if allowed, not recomended)
<br><br>
===Parameters=== 
* 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'''.
<br><br>
===Returns===
'''Success:'''
<?xml version="1.0" encoding="UTF-8"?>
<page>
  <version>MOR GUI version</version>
</page>
'''Errors:'''
* '''Allow API globally''' setting is unchecked.
<?xml version="1.0" encoding="UTF-8"?>
<page>
    <status>
      <error>Access Denied</error>
    </status>
</page>
* User is not authorized.
<?xml version="1.0" encoding="UTF-8"?>
<page>
    <status>
      <error>Access Denied</error>
    </status>
</page>


[[MOR API]]
* Hash is not correct. Check API Secret Key and order or params while concatenating hash_string.


Get MOR version number
<?xml version="1.0" encoding="UTF-8"?>
<page>
    <status>
      <error>Access Denied</error>
    </status>
</page>


<br><br>
<br><br>
----
<br><br>
* Call: /api/get_version
* Methods: POST, GET(if allowed, not recomended)
* Params:
** u - username to login. '''Required'''.
** p - password 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'''.
**


* Returns:
=See also=
**Success
<version>version_number</version>


** 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.

Latest revision as of 14:15, 31 July 2013

Description

MOR API for getting MOR version number

Usage

  • From MOR X4 call: /api/system_version_get
  • For Backwards-compatibility old name 'get_version' is also usable. Call: /api/get_version
  • Methods: POST, GET(if allowed, not recomended)



Parameters



Returns

Success: 

<?xml version="1.0" encoding="UTF-8"?>
<page>
  <version>MOR GUI version</version>
</page>

Errors:

  • Allow API globally setting is unchecked.
<?xml version="1.0" encoding="UTF-8"?>
<page>
   <status>
      <error>Access Denied</error>
   </status>
</page>
  • User is not authorized.
<?xml version="1.0" encoding="UTF-8"?>
<page>
   <status>
      <error>Access Denied</error>
   </status>
</page>
  • Hash is not correct. Check API Secret Key and order or params while concatenating hash_string.
<?xml version="1.0" encoding="UTF-8"?>
<page>
   <status>
      <error>Access Denied</error>
   </status>
</page>



See also

Retrieved from "https://wiki.kolmisoft.com/index.php?title=MOR_API_system_version_get&oldid=16373"