doc.arkadia.com

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== <#Add_Lead> ======

Use this function to add a lead in the database. This function must be called only from 
[[en:public:developer:template_system:cfgpages]]. The Lead will be 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 
[[en:public:developer:template_system:reserved_parameters:ak__source]]
==== CfgPages configuration ====

<code xml>
<page name="add_lead">
  <cfg>
    <userrights>
      <userright name="ALLUSER"/>
    </userrights>
    <frames>
      <frame name="content" processname="add_lead"/>
    </frames>
    <maintemplate>maintemplates\maintemplate_empty.html</maintemplate>
    <content_type>&lt;#content_type&gt;</content_type>
  </cfg>
</page>
</code>

==== Parameters ====

Parameters are taken from tag (default) or from HTTP GET/Post

^ Name                                                        ^ Mandatory ^ Default             ^ Description       ^       
| <html><span style="color:#008000">Property.ID</span></html> | No        |                     | ID of the property on with the lead will be linked |
| <html><span style="color:#008000">Lead.type</span></html>   | Yes       |                     | Type of lead (2=Web or 4=Telephone) |

==== Error Codes ====

^ Code                                                ^ Description ^       
| <html><span style="color:#008000">111</span></html> | One mandatory parameter is missing |
| <html><span style="color:#008000">119</span></html> | Wrong parameter values |


==== Example ====

Ajax example on jQuery

<code javascript>

$.ajax({
    cache: false,
    type: "GET",
    data: { 
        Property.ID: 'CA-T1',
        Lead.type: 2
    },
    url: '<#url id="/api/add_lead/">',
    dataType: "xml",
    success: callbackfunction_on_success,
    error: function (jqXHR, textStatus, errorThrown) {}
});

function callbackfunction_on_success (response) {
  var $root = $('rsp',response);
  if ($root.attr('stat') == 'ok'){
    var leadid = $root.find('id').Html();
  }
}

</code>
doc.arkadia.com

User Tools

Site Tools

Page Tools
