GetLeadInformation

Returns information for all leads associated with the account. The lead information comes from the Verizon Partner Resource Management (PRM) tool. If the information is incomplete or inaccurate, you must use the PRM tool to update it, and it will be synchronized with the M2M Platform within an hour. This API is for use by Verizon Partner Program (VPP) partners only.

Uses and Requirements

Use this API along with the ChangeDeviceState - Activate API to credit service activations to the right leads for compensation.

  1. Call GetLeadInformation to verify that the leads that need to be credited for pending activations (step 4) are associated with the account.
  2. If a lead is not associated with the account, verify that it has been entered in the PRN tool. Lead information is synchronized between the PRM tool and the M2M Platform once a day, so you may need to wait 24 hours before information about new leads is returned by the GetLeadInformation API.
  3. Store the returned Lead IDs and their associated AddressZipCode values.
  4. When you call ChangeDeviceState to activate devices, include the ID of the lead to be compensated in the LeadId parameter, and put the ZIP code associated with that lead in the MdnZipCode parameter. (The MdnZipCode value is used when calculating compensation.)

Lead IDs do not change, so only repeat steps 1-3 when new leads are qualified for the account.

Request Parameters

Parameter Type Description
AccountName
required
string The name of the account for which you want lead information. An account name is usually numeric, and must include any leading zeros.
StartRowNumber
optional
string

The starting row number to use for pagination, which is useful when the response might contain a large number of leads. Each response will contain a maximum of 1,000 leads. If the account has more than 1,000 leads, you must specify StartRowNumber to get all of the leads.

For the first request, set StartRowNumber to 1. Check the value of the IsComplete extended attribute for the last lead returned in the response. If it's "true" then you have received all of the leads. If IsComplete is "false," send another request with StartRowNumber set to the value of the RowNumber extended attribute plus 1. Continue adjusting the StartRowNumber value and sending requests until IsComplete is "true."

Response Parameters

Returns a list of the leads associated with the specified account, with this information for each lead:

Parameter Type Description
Leads Lead The list of leads associated with the account.
LeadIdentificationNumber string Lead tracking number entered when the device was activated, or from an external system.
LeadState string The current state of the lead, such as "Qualified" or "Closed."
AddressLine1
AddressLine2
AddressCity
AddressState
AddressZipCode
strings Separate strings containing the address information for the lead.
ExtendedAttributes ExtendedAttributesObj Key-Value pairs for pagination control.
Key
Value
string
string
RowNumber
The row number of the current lead.
Key
Value
string
boolean
IsComplete
Boolean indicating whether information for all leads has been returned. If IsComplete is false for the last lead in a response, call this API again and retrieve the next block of leads by setting the StartRowNumber to the largest RowNumber value that was returned, plus 1. You can ignore this value for all leads in a response except the last one.
Key
Value
string
string
CustomerName
The name of the customer associated with the lead.

Example SOAP Request

<soapenv:Body>
  <v2:GetLeadInformation>
    <v2:Input>
      <nph:Account>account_name</nph:Account>
      <nph:StartRowNumber>1</nph:StartRowNumber>
    </v2:Input>
  </v2:GetLeadInformation>
</soapenv:Body>

Example SOAP Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetLeadInformationResponse xmlns="http://nphase.com/unifiedwebservice/v2">
      <Output xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:a="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.AccountService">
        <a:Leads>
          <a:Lead>
            <a:LeadIdentificationNumber>L-10001</a:LeadIdentificationNumber>
            <a:LeadState>Qualified</a:LeadState>
            <a:AddressLine1>1600 Pennsylvania Avenue</a:AddressLine1>
            <a:AddressLine2/>
            <a:AddressCity>Washington</a:AddressCity>
            <a:AdddressState>DC</a:AdddressState>
            <a:AddressZipCode>20500</a:AddressZipCode>
            <a:ExtendedAttributes xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
              <b:ExtendedAttributesObj>
                <b:Key>RowNumber</b:Key>
                <b:Value>1</b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>IsComplete</b:Key>
                <b:Value>False</b:Value>
              </b:ExtendedAttributesObj>
            </a:ExtendedAttributes>
          </a:Lead>
          <a:Lead>
            <a:LeadIdentificationNumber>L-10003</a:LeadIdentificationNumber>
            <a:LeadState>Closed</a:LeadState>
            <a:AddressLine1>2000 Las Vegas Blvd S</a:AddressLine1>
            <a:AddressLine2/>
            <a:AddressCity>Las Vegas City</a:AddressCity>
            <a:AdddressState>Nevada</a:AdddressState>
            <a:AddressZipCode>89104-0001</a:AddressZipCode>
            <a:ExtendedAttributes xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
              <b:ExtendedAttributesObj>
                <b:Key>RowNumber</b:Key>
                <b:Value>2</b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>IsComplete</b:Key>
                <b:Value>True</b:Value>
              </b:ExtendedAttributesObj>
            </a:ExtendedAttributes>
          </a:Lead>
        </a:Leads>
      </Output>
    </GetLeadInformationResponse>
  </s:Body>
</s:Envelope>

Request Schema Diagram

Response Schema Diagram