[Vtigercrm-commits] [vtiger development] #6209: Web Services API documentation issues

[vtiger development]

#6209: Web Services API documentation issues
---------------------------------------+------------------------------------
 Reporter:  vitalidze                  |       Owner:  developer
     Type:  defect                     |      Status:  new      
 Priority:  unassigned                 |   Milestone:  5.1.1    
Component:  vtwsclib                   |     Version:  5.1.0    
 Keywords:  documentation web service  |  
---------------------------------------+------------------------------------
 In documentation
 ([http://www.vtiger.com/archives/validation/5.1/2008.10/VtigerCRM_5.1.0_Webservices_Tutorial.pdf
 Tutorial] and
 [http://www.vtiger.com/archives/validation/5.1/2008.10/VtigerCRM_5.1.0_Webservices.pdf
 Reference]) there are several issues described below:

 1) On page 3 of
 [http://www.vtiger.com/archives/validation/5.1/2008.10/VtigerCRM_5.1.0_Webservices_Tutorial.pdf
 Tutorial] there is an example of logging in to vTiger CRM through web
 services:
 {{{
 ...
 $sessionId = $jsonResponse['result']['sessionId']
 ...
 }}}
 Also on page 2 of
 [http://www.vtiger.com/archives/validation/5.1/2008.10/VtigerCRM_5.1.0_Webservices.pdf
 Reference] there is description of LoginResult object:
 {{{
 LoginResult{
     sessionId:String //Unique Identifier for the session
 }}}

 It references to 'sessionId' field of LoginResult object. There is no such
 field here, but there is an sessionName field, which actually means the
 same.

 2) On page 2 of
 [http://www.vtiger.com/archives/validation/5.1/2008.10/VtigerCRM_5.1.0_Webservices.pdf
 Reference] there is description of ErrorObject:
 {{{
 ErrorObject{
     errorCode:String //String representation of the error type
     errorMessage:String
 }
 }}}

 Instead of '''errorCode''' and '''errorMessage''' fields it contains
 simply '''code''' and '''message''' fields.

 3) On page 2 of
 [http://www.vtiger.com/archives/validation/5.1/2008.10/VtigerCRM_5.1.0_Webservices_Tutorial.pdf
 Tutorial] there is description of '''Describe Object''' operation. Also it
 is referenced on page 7 of
 [http://www.vtiger.com/archives/validation/5.1/2008.10/VtigerCRM_5.1.0_Webservices.pdf
 Reference] with the same issue. The operation code provided is
 '''describeobject''', which should be '''describe'''.

-- 
Ticket URL: <http://trac.vtiger.com/cgi-bin/trac.cgi/ticket/6209>
vtiger development <http://trac.vtiger.com/>
vtigerCRM