This is an old revision of the document!
Use this function to add a lead in the database. This function must be called only from cfgpages. The Lead will be also connected to the current web user as the Buyer. The ID of the referrer (if any) of the lead will be extracted from the cookie ak__source
<page name="My_Add_lead_Api_Function"> <cfg> <userrights> <userright name="ALLUSER"/> </userrights> <frames> <frame name="mainframe" processname="Add_lead" preload="1"/> </frames> </cfg> </page>
The ArKadia API currently supports a RESTful interface, that essentially means you can send an HTTP GET or POST to call exposed methods, and you'll get back an XML document in return.
When you call this function, you'll get a response in XML that looks like this:
<rsp stat="ok" version="1.0"> [Data in XML format - see individual method docs] </rsp>
If there's an error, you'll get a response with an error message about the problem.
<rsp stat="fail"> <error msg="Error Message" /> <rsp>
Name | Mandatory | Default | Description |
---|---|---|---|
Property.ID | No | ID of the property on with the lead will be linked | |
Lead.type | Yes | Type of lead (2=Web or 4=Telephone) |
Code | Description |
---|---|
111 | One mandatory parameter is missing |
119 | Wrong parameter values |