Difference between revisions of "MOR API system version get"

From Kolmisoft Wiki
Jump to navigationJump to search
 
(7 intermediate revisions by the same user not shown)
Line 3: Line 3:


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


* Call: /api/system_version_get
* 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)
* Methods: POST, GET(if allowed, not recomended)
<br><br>
===Parameters===   
===Parameters===   
<br><br>
 
* u - username 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'''.
<br><br>
===Returns===
'''Success:'''


* Returns:
<?xml version="1.0" encoding="UTF-8"?>
**Success:
<page>
  <page>
  <version>MOR GUI version</version>
     <version>MOR GUI version</version>
</page>
  </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>


**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>
<br><br>
=See also=
=See also=


* [[MOR API]]
* [[MOR API]]

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"