Exigo Web Services API v2022.12.19.1

 Search

GetCustomerLeads

Gets a list of customer leads.

Input Properties

GetCustomerLeadsRequest
PropertyData TypeNotes
CustomerIDInt32Unique numeric identifier for customer record.
CustomerLeadIDInt32Optional. Optionally pull just one customer lead by ID.
GreaterThanCustomerLeadIDInt32Optional. Paging controller.
BatchSizeInt32Optional. Defaults to 100 at a time.
CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

Output Properties

GetCustomerLeadsResponse
PropertyData TypeNotes
CustomerLeadsCustomerLeadsResponse[]
CustomerLeadsResponse
PropertyData TypeNotes
CustomerIDInt32Unique numeric identifier for customer record.
CustomerLeadIDInt32Unique identifier for a customer lead record.
FirstNameString
LastNameString
MiddleNameString
CompanyString
PhoneString
Phone2String
MobilePhoneString
FaxString
EmailString
Address1String
Address2String
CityString
State String
ZipString
Country String
BirthDateDateTime
NotesString
CustomerKeyStringUnique alpha numeric identifier for customer record .

Http Request

GET https://yourcompany-api.exigo.com/3.0/customerlead?customerID=1
  &customerLeadID=1
  &greaterThanCustomerLeadID=1
  &batchSize=1
  &customerKey=1
Authorization: Basic base64Encoded

Http Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length


{
  "customerLeads": null,
  "result": null
}

Soap Request

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: totallife-api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.exigo.com/GetCustomerLeads"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
      xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
      xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <ApiAuthentication xmlns="http://api.exigo.com/">
      <LoginName>string</LoginName>
      <Password>string</Password>
      <Company>string</Company>
      <Identity>string</Identity>
      <RequestTimeUtc>dateTime</RequestTimeUtc>
      <Signature>string</Signature>
    </ApiAuthentication>
  </soap:Header>
  <soap:Body>
    <GetCustomerLeadsRequest xmlns="http://api.exigo.com/">
      <CustomerID>int</CustomerID>
      <CustomerLeadID>int</CustomerLeadID>
      <GreaterThanCustomerLeadID>int</GreaterThanCustomerLeadID>
      <BatchSize>int</BatchSize>
      <CustomerKey>string</CustomerKey>
    </GetCustomerLeadsRequest>
  </soap:Body>
</soap:Envelope>

Soap Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
      xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
      xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCustomerLeadsResult xmlns="http://api.exigo.com/">
      <CustomerLeads>
        <CustomerLeadsResponse>
          <CustomerID>int</CustomerID>
          <CustomerLeadID>int</CustomerLeadID>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <MiddleName>string</MiddleName>
          <Company>string</Company>
          <Phone>string</Phone>
          <Phone2>string</Phone2>
          <MobilePhone>string</MobilePhone>
          <Fax>string</Fax>
          <Email>string</Email>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Country>string</Country>
          <BirthDate>dateTime</BirthDate>
          <Notes>string</Notes>
          <CustomerKey>string</CustomerKey>
        </CustomerLeadsResponse>
      </CustomerLeads>
    </GetCustomerLeadsResult>
  </soap:Body>
</soap:Envelope>

C# Rest Client

Install Nuget package Exigo.Api.Client

try

{

    //Create Api Client

    var api = new ExigoApiClient("yourcmpany", "yourlogin", "yourpassword");

 

    //Create Request

    var req = new GetCustomerLeadsRequest();

 

    req.CustomerID = 1;             //Unique numeric identifier for customer record.

    req.CustomerLeadID = 1;         //Optionally pull just one customer lead by ID

    req.GreaterThanCustomerLeadID = 1;//Paging controller

    req.BatchSize = 1;              //Defaults to 100 at a time

    req.CustomerKey = "1";          //Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

 

    //Send Request to Server and Get Response

    var res = await api.GetCustomerLeadsAsync(req);

 

    //Now examine the results:

 

    foreach (var customerLeads in res.CustomerLeads)

    {

        Console.WriteLine("CustomerID: {0}", customerLeads.CustomerID);

        Console.WriteLine("CustomerLeadID: {0}", customerLeads.CustomerLeadID);

        Console.WriteLine("FirstName: {0}", customerLeads.FirstName);

        Console.WriteLine("LastName: {0}", customerLeads.LastName);

        Console.WriteLine("MiddleName: {0}", customerLeads.MiddleName);

        Console.WriteLine("Company: {0}", customerLeads.Company);

        Console.WriteLine("Phone: {0}", customerLeads.Phone);

        Console.WriteLine("Phone2: {0}", customerLeads.Phone2);

        Console.WriteLine("MobilePhone: {0}", customerLeads.MobilePhone);

        Console.WriteLine("Fax: {0}", customerLeads.Fax);

        Console.WriteLine("Email: {0}", customerLeads.Email);

        Console.WriteLine("Address1: {0}", customerLeads.Address1);

        Console.WriteLine("Address2: {0}", customerLeads.Address2);

        Console.WriteLine("City: {0}", customerLeads.City);

        Console.WriteLine("Zip: {0}", customerLeads.Zip);

        Console.WriteLine("BirthDate: {0}", customerLeads.BirthDate);

        Console.WriteLine("Notes: {0}", customerLeads.Notes);

        Console.WriteLine("CustomerKey: {0}", customerLeads.CustomerKey);

    }

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

C# Soap Client

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    GetCustomerLeadsRequest req = new GetCustomerLeadsRequest();

 

    req.CustomerID = 1;             //Unique numeric identifier for customer record.

    req.CustomerLeadID = 1;         //Optionally pull just one customer lead by ID

    req.GreaterThanCustomerLeadID = 1;//Paging controller

    req.BatchSize = 1;              //Defaults to 100 at a time

    req.CustomerKey = "1";          //Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

 

    //Send Request to Server and Get Response

    GetCustomerLeadsResponse res = api.GetCustomerLeads(req);

 

    //Now examine the results:

 

    foreach (CustomerLeadsResponse customerLeads in res.CustomerLeads)

    {

        Console.WriteLine("CustomerID: {0}", customerLeads.CustomerID);

        Console.WriteLine("CustomerLeadID: {0}", customerLeads.CustomerLeadID);

        Console.WriteLine("FirstName: {0}", customerLeads.FirstName);

        Console.WriteLine("LastName: {0}", customerLeads.LastName);

        Console.WriteLine("MiddleName: {0}", customerLeads.MiddleName);

        Console.WriteLine("Company: {0}", customerLeads.Company);

        Console.WriteLine("Phone: {0}", customerLeads.Phone);

        Console.WriteLine("Phone2: {0}", customerLeads.Phone2);

        Console.WriteLine("MobilePhone: {0}", customerLeads.MobilePhone);

        Console.WriteLine("Fax: {0}", customerLeads.Fax);

        Console.WriteLine("Email: {0}", customerLeads.Email);

        Console.WriteLine("Address1: {0}", customerLeads.Address1);

        Console.WriteLine("Address2: {0}", customerLeads.Address2);

        Console.WriteLine("City: {0}", customerLeads.City);

        Console.WriteLine("Zip: {0}", customerLeads.Zip);

        Console.WriteLine("BirthDate: {0}", customerLeads.BirthDate);

        Console.WriteLine("Notes: {0}", customerLeads.Notes);

        Console.WriteLine("CustomerKey: {0}", customerLeads.CustomerKey);

    }

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new GetCustomerLeadsRequest()

 

    req.CustomerID = 1

    req.CustomerLeadID = 1

    req.GreaterThanCustomerLeadID = 1

    req.BatchSize = 1

    req.CustomerKey = "1"

 

    'Send Request to Server and Get Response

    Dim res As GetCustomerLeadsResponse = api.GetCustomerLeads(req)

 

    'Now examine the results:

 

    For Each customerLeads As CustomerLeadsResponse In res.CustomerLeads

        Console.WriteLine("CustomerID: {0}", customerLeads.CustomerID)

        Console.WriteLine("CustomerLeadID: {0}", customerLeads.CustomerLeadID)

        Console.WriteLine("FirstName: {0}", customerLeads.FirstName)

        Console.WriteLine("LastName: {0}", customerLeads.LastName)

        Console.WriteLine("MiddleName: {0}", customerLeads.MiddleName)

        Console.WriteLine("Company: {0}", customerLeads.Company)

        Console.WriteLine("Phone: {0}", customerLeads.Phone)

        Console.WriteLine("Phone2: {0}", customerLeads.Phone2)

        Console.WriteLine("MobilePhone: {0}", customerLeads.MobilePhone)

        Console.WriteLine("Fax: {0}", customerLeads.Fax)

        Console.WriteLine("Email: {0}", customerLeads.Email)

        Console.WriteLine("Address1: {0}", customerLeads.Address1)

        Console.WriteLine("Address2: {0}", customerLeads.Address2)

        Console.WriteLine("City: {0}", customerLeads.City)

        Console.WriteLine("Zip: {0}", customerLeads.Zip)

        Console.WriteLine("BirthDate: {0}", customerLeads.BirthDate)

        Console.WriteLine("Notes: {0}", customerLeads.Notes)

        Console.WriteLine("CustomerKey: {0}", customerLeads.CustomerKey)

    Next

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->CustomerID = 1;

    $req->CustomerLeadID = 1;

    $req->GreaterThanCustomerLeadID = 1;

    $req->BatchSize = 1;

    $req->CustomerKey = "1";

 

    //Send Request to Server and Get Response

    $res = $api.GetCustomerLeads($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    GetCustomerLeadsRequest req = new GetCustomerLeadsRequest();

 

    req.setCustomerID(1);

    req.setCustomerLeadID(1);

    req.setGreaterThanCustomerLeadID(1);

    req.setBatchSize(1);

    req.setCustomerKey("1");

 

    //Send Request to Server and Get Response

    GetCustomerLeadsResponse res = api.getExigoApiSoap().getCustomerLeads(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method does not support csv output.