vtiger CRM 二次开发接口Webservice调用实例

过程：

网络调用过程：

GET /vtigercrm/webservice.PHP?operation=getchallenge&username=admin


HTTP/1.1 200 OK
Content-Type: application/json
{"success":true,"result":{"token":"5081cda1715be","serverTime":1350684065,"expireTime":1350684365}}


POST /vtigercrm/webservice.PHP
operation=login&username=admin&accessKey=a04xxxxxxxxxxxxxxxxxxxxxxxxxxxx


HTTP/1.1 200 OK
Content-Type: application/json
{"success":true,"result":{"sessionName":"26d6184e5081cda23c6de","userId":"19x1","version":"0.22","vtigerVersion":"5.3.0"}}


GET /vtigercrm/webservice.PHP?operation=listtypes&sessionName=26d6184e5081cda23c6de


HTTP/1.1 200 OK
Content-Type: application/json
{"success":true,"result":{"types":["Calendar","Leads","Accounts","Contacts","Potentials","Products","Documents","Emails","HelpDesk","Faq","vendors","PriceBooks","Quotes","PurchaSEOrder","SalesOrder","Invoice","Campaigns","Events","Users","PBXManager","Services","ServiceContracts","ModComments","SMSNotifier","Assets","ProjectMilestone","ProjectTask","Project","Groups","Currency","DocumentFolders","CompanyDetails"],"@R_563_4045@ion":{"Calendar":{"isEntity":true,"label":"Calendar","singular":"To Do"},"Leads":{"isEntity":true,"label":"Leads","singular":"Lead"},"Accounts":{"isEntity":true,"label":"Accounts","singular":"Account"},"Contacts":{"isEntity":true,"label":"Contacts","singular":"Contact"},"Potentials":{"isEntity":true,"label":"Potentials","singular":"Potential"},"Products":{"isEntity":true,"label":"Products","singular":"Product"},"Documents":{"isEntity":true,"label":"Documents","singular":"Document"},"Emails":{"isEntity":true,"label":"Email","singular":"Email"},"HelpDesk":{"isEntity":true,"label":"Trouble Tickets","singular":"Ticket"},"Faq":{"isEntity":true,"label":"FAQ","singular":"Faq"},"vendors":{"isEntity":true,"label":"vendors","singular":"vendor"},"PriceBooks":{"isEntity":true,"label":"Price Books","singular":"PriceBook"},"Quotes":{"isEntity":true,"label":"Quotes","singular":"Quote"},"PurchaSEOrder":{"isEntity":true,"label":"Purchase Order","singular":"Purchase Order"},"SalesOrder":{"isEntity":true,"label":"Sales Order","singular":"Sales Order"},"Invoice":{"isEntity":true,"label":"Invoice","singular":"Invoice"},"Campaigns":{"isEntity":true,"label":"Campaigns","singular":"Campaign"},"Events":{"isEntity":true,"label":"Events","singular":"Event"},"Users":{"isEntity":true,"label":"Users","singular":"User"},"PBXManager":{"isEntity":true,"label":"PBX Manager","singular":"SINGLE_PBXManager"},"Services":{"isEntity":true,"label":"Services","singular":"Service"},"ServiceContracts":{"isEntity":true,"label":"Service Contracts","singular":"Service Contract"},"ModComments":{"isEntity":true,"label":"Comments","singular":"Comment"},"SMSNotifier":{"isEntity":true,"label":"SMSNotifier","singular":"SMS Info"},"Assets":{"isEntity":true,"label":"Assets","singular":"Asset"},"Project Milestone":{"isEntity":true,"label":"Project Milestones","singular":"Project Milestone"},"ProjectTask":{"isEntity":true,"label":"Project Tasks","singular":"Project Task"},"Project":{"isEntity":true,"label":"Projects","singular":"Project"},"Groups":{"isEntity":false,"label":"Groups","singular":"Groups"},"Currency":{"isEntity":false,"label":"Currency","singular":"Currency"},"DocumentFolders":{"isEntity":false,"label":"DocumentFolders","singular":"DocumentFolders"},"CompanyDetails":{"isEntity":false,"label":"CompanyDetails","singular":"CompanyDetails"}}}}


GET /vtigercrm/webservice.PHP?operation=describe&elementType=HelpDesk&sessionName=26d6184e5081cda23c6de




HTTP/1.1 200 OK
Content-Type: application/json
{"success":true,"result":{"label":"Trouble Tickets","name":"HelpDesk","createable":true,"updateable":true,"deleteable":true,"retrieveable":true,"fields":[{"name":"ticket_no","label":"Ticket No","mandatory":false,"type":{"name":"string"},"nullable":false,"editable":false,"default":""},{"name":"assigned_user_id","label":"Assigned To","mandatory":true,"type":{"name":"owner"},"editable":true,"default":"0"},{"name":"parent_id","label":"Related To","type":{"refersTo":["Accounts","Contacts"],"name":"reference"},"nullable":true,{"name":"ticketpriorities","label":"Priority","type":{"picklistValues":[{"label":"Low","value":"Low"},{"label":"normal","value":"normal"},{"label":"High","value":"High"},{"label":"Urgent","value":"Urgent"}],"defaultValue":"Low","name":"picklist"},{"name":"product_id","label":"Product Name","type":{"refersTo":["Products"],{"name":"ticketseverities","label":"Severity","type":{"picklistValues":[{"label":"Minor","value":"Minor"},{"label":"Major","value":"Major"},{"label":"Feature","value":"Feature"},{"label":"Critical","value":"Critical"}],"defaultValue":"Minor",{"name":"ticketstatus","label":"Status","type":{"picklistValues":[{"label":"Open","value":"Open"},{"label":"In Progress","value":"In Progress"},{"label":"Wait For Response","value":"Wait For Response"},{"label":"Closed","value":"Closed"}],"defaultValue":"Open",{"name":"ticketcategories","label":"Category","type":{"picklistValues":[{"label":"Big Problem","value":"Big Problem"},{"label":"Small Problem","value":"Small Problem"},{"label":"Other Problem","value":"Other Problem"}],"defaultValue":"Big Problem",{"name":"update_log","label":"Update History","type":{"name":"text"},{"name":"hours","label":"Hours","type":{"name":"integer"},{"name":"days","label":"Days",{"name":"createdtime","label":"Created Time","type":{"name":"datetime"},{"name":"modifiedtime","label":"Modified Time",{"name":"ticket_title","label":"Title",{"name":"description","label":"Description",{"name":"solution","label":"Solution",{"name":"id","label":"ticketid","type":{"name":"autogenerated"},"default":""}],"idPrefix":"9","isEntity":true,"labelFields":"title"}}


POST /vtigercrm/webservice.PHP
operation=create&format=json&sessionName=26d6184e5081cda23c6de&elementType=HelpDesk&element=%7B%22ticketpriorities%22%3A%22Low%22%2C%22ticketseverities%22%3A%22Minor%22%2C%22ticketstatus%22%3A%22Open%22%2C%22ticketcategories%22%3A%22Big%20Problem%22%2C%22ticket_title%22%3A%22my%20ticket%20001%E4%B8%AD%E6%96%87002%22%2C%22assigned_user_id%22%3A%2219x1%22%7D


HTTP/1.1 200 OK
Content-Type: application/json
{"success":true,"result":{"ticket_no":"TT4","assigned_user_id":"19x1","parent_id":"","ticketpriorities":"Low","product_id":"","ticketseverities":"Minor","ticketstatus":"Open","ticketcategories":"Big Problem","update_log":"","hours":"0","days":"0","createdtime":"2012-10-19 22:01:42","modifiedtime":"2012-10-19 22:01:42","ticket_title":"my ticket 001\u4e2d\u6587002","description":"","solution":"","id":"9x6"}}

参考资料：

Webservices tutorials

vtiger CRM Webservices 

vtiger CRM plugin for firefox 5.3版本