Difference between revisions of "MOR API phonebook edit"

From Kolmisoft Wiki
Jump to navigationJump to search
(Undo revision 12112 by Mindaugasm (Talk))
Line 1: Line 1:
''This functionality is available from [[MOR 12| MOR 12]]''
''This functionality is available from [[MOR 11| MOR 11]]''




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


Credit note update
Phonebook edit


<br><br>
<br><br>
Line 10: Line 10:
<br><br>
<br><br>


* Call: /api/credit_note_update
* Call: /api/phonebook_edit
* Methods: POST, GET(if allowed, not recomended)
* Methods: POST, GET(if allowed, not recomended)
* Params:
* Params:
** credit_note_id - Credit note ID in MOR database. '''Required'''.
** phonebook_id - Phonebook ID in MOR database. '''Required'''.
** u - username to login. '''Required'''.
** u - username to login. '''Required'''.
** p - password to login. '''Required'''.
** p - password to login. '''Required'''.
** status - status of credit note, posible values are 'paid', 'unpaid'. '''Optional'''
** comment - unlimited length text. '''Optional'''
** [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
** [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
** number
** name
** speeddial


* Returns:
* Returns:
**Success
**Success
*** <status>Credit note updated</status>
*** <status>Phonebook saved</status>
** Errors:
** Errors:
*** <error>Credit note was not saved</error>
*** <error>Phonebook was not saved</error>
*** <error>Bad login</error>
**** <message>problem message</message>  
*** <error>Credit note was not found</error> - credit note was not found using phonebook_id. Use correct phonebook id.
*** <error>Phonebook was not found</error> - Phonebook  was not found using phonebook_id. Use correct phonebook id.
*** <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
*** <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
 
*** <error>Dont be so smart</error> - User with UNIQUEHASH not found or params id not send. Enter correct id.
<br><br>
<br><br>
----
----
*Example:
*Example:
**We have credit_note_id = 123, API Secret Key = 456789
**We have phonebook_id = 123, API Secret Key = 456789
**Hash string to be converted: "123456789"
**Hash string to be converted: "123456789"
**We send:
**We send:
***/api/credit_note_update?u=admin&p=admin&credit_note_id=123&status=paid&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
***/api/phonebook_edit?u=admin&p=admin&phonebook_id=123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
'''* Note that username and password are not included in hash'''
'''* Note that username and password are not included in hash'''

Revision as of 14:26, 12 January 2012

This functionality is available from MOR 11


MOR API

Phonebook edit





  • Call: /api/phonebook_edit
  • Methods: POST, GET(if allowed, not recomended)
  • Params:
    • phonebook_id - Phonebook ID in MOR database. Required.
    • u - username to login. Required.
    • p - password to login. Required.
    • hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required.
    • number
    • name
    • speeddial
  • Returns:
    • Success
      • <status>Phonebook saved</status>
    • Errors:
      • <error>Phonebook was not saved</error>
        • <message>problem message</message>
      • <error>Phonebook was not found</error> - Phonebook was not found using phonebook_id. Use correct phonebook id.
      • <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
      • <error>Dont be so smart</error> - User with UNIQUEHASH not found or params id not send. Enter correct id.



  • Example:
    • We have phonebook_id = 123, API Secret Key = 456789
    • Hash string to be converted: "123456789"
    • We send:
      • /api/phonebook_edit?u=admin&p=admin&phonebook_id=123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441

* Note that username and password are not included in hash

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