POST api/business/leads?trackingId={trackingId}

Lead Qualification

Request Information

URI Parameters

Name	Description	Type	Additional information
trackingId	An ID supplied by the client to track or name this request	string	Required

Body Parameters

Business match criteria

LeadCriteria

Name	Description	Type	Additional information
MaxLeads	Maximum number of Leads to return	integer	None.
BuildingKey	Midas Building Key Business are in	integer	None.
BusinessName	Business Name or known portion of Business Name	string	None.
ContactLastName	Contact Name or known portion of Contact Name	string	None.
Suite	Suite information about Business	string	None.
Phone	Phone Number of Business	string	None.
Email	Email address of business	string	None.

Request Formats

application/json, text/json

Sample:

{
  "maxLeads": 1,
  "buildingKey": 2,
  "businessName": "sample string 3",
  "contactLastName": "sample string 4",
  "suite": "sample string 5",
  "phone": "sample string 6",
  "email": "sample string 7"
}

application/xml, text/xml

Sample:

<LeadCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twc.Models">
  <BuildingKey>2</BuildingKey>
  <BusinessName>sample string 3</BusinessName>
  <ContactLastName>sample string 4</ContactLastName>
  <Email>sample string 7</Email>
  <MaxLeads>1</MaxLeads>
  <Phone>sample string 6</Phone>
  <Suite>sample string 5</Suite>
</LeadCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

success

LeadQualificationResponse

Name	Type	Additional information
TrackingID	string	None.
LeadCandidateList	LeadQualificationResponseLeadCandidateList	None.
ServiceReturnStatus	ServiceReturnStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "trackingID": "sample string 1",
  "leadCandidateList": {
    "leadCandidate": [
      {
        "businessKey": 1,
        "rankOrder": 2,
        "itemNumber": "sample string 3"
      },
      {
        "businessKey": 1,
        "rankOrder": 2,
        "itemNumber": "sample string 3"
      }
    ],
    "count": "sample string 1"
  },
  "serviceReturnStatus": {
    "returnCode": 1,
    "returnMessage": "sample string 2",
    "responseTypeCode": 3,
    "responseTypeCodeSpecified": true,
    "responseTypeMessage": "sample string 5",
    "currentPeriodRequestsUsed": 6,
    "currentPeriodRequestsAvailable": 7
  }
}

application/xml, text/xml

Sample:

<LeadQualificationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twc.MidasWebServices">
  <LeadCandidateList>
    <countField>sample string 1</countField>
    <leadCandidateField>
      <LeadQualificationResponseLeadCandidateListLeadCandidate>
        <businessKeyField>1</businessKeyField>
        <itemNumberField>sample string 3</itemNumberField>
        <rankOrderField>2</rankOrderField>
      </LeadQualificationResponseLeadCandidateListLeadCandidate>
      <LeadQualificationResponseLeadCandidateListLeadCandidate>
        <businessKeyField>1</businessKeyField>
        <itemNumberField>sample string 3</itemNumberField>
        <rankOrderField>2</rankOrderField>
      </LeadQualificationResponseLeadCandidateListLeadCandidate>
    </leadCandidateField>
  </LeadCandidateList>
  <ServiceReturnStatus>
    <currentPeriodRequestsAvailableField>7</currentPeriodRequestsAvailableField>
    <currentPeriodRequestsUsedField>6</currentPeriodRequestsUsedField>
    <responseTypeCodeField>3</responseTypeCodeField>
    <responseTypeCodeFieldSpecified>true</responseTypeCodeFieldSpecified>
    <responseTypeMessageField>sample string 5</responseTypeMessageField>
    <returnCodeField>1</returnCodeField>
    <returnMessageField>sample string 2</returnMessageField>
  </ServiceReturnStatus>
  <TrackingID>sample string 1</TrackingID>
</LeadQualificationResponse>