POST api/Routing/RouteLeads

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CompanyId	integer	None.
PageNumber	integer	None.
NumberOfRecords	integer	None.
Requestor	string	Required

Request Formats

application/json, text/json

Sample:

{
  "CompanyId": 1,
  "PageNumber": 2,
  "NumberOfRecords": 3,
  "Requestor": "sample string 4"
}

application/xml, text/xml

Sample:

<RouteLeadPacket xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMK.CSK.API.Models">
  <Requestor>sample string 4</Requestor>
  <CompanyId>1</CompanyId>
  <NumberOfRecords>3</NumberOfRecords>
  <PageNumber>2</PageNumber>
</RouteLeadPacket>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RouteLeadResponse

Name	Type	Additional information
Leads	Collection of RouteLead	None.
StatusCode	integer	None.
ErrorMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Leads": [
    {
      "LeadNumber": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Address": "sample string 4",
      "City": "sample string 5",
      "ZipCode": "sample string 6",
      "MobilePhone": "sample string 7",
      "State": "sample string 8",
      "Email": "sample string 9",
      "Language": 10,
      "CompanyID": 11,
      "DateTimeActivated": "sample string 12",
      "AgencyCode": "sample string 13",
      "AgentNumber": "sample string 14",
      "AdditionalData": "sample string 15",
      "AgentWithCustomer": true,
      "DateTimeModified": "2025-04-03T17:37:52.8995477-05:00",
      "DNCCheckRequired": true,
      "DNCFlag": true,
      "Sponsor": "sample string 17",
      "Relationship": "sample string 18",
      "Notes": "sample string 19"
    },
    {
      "LeadNumber": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Address": "sample string 4",
      "City": "sample string 5",
      "ZipCode": "sample string 6",
      "MobilePhone": "sample string 7",
      "State": "sample string 8",
      "Email": "sample string 9",
      "Language": 10,
      "CompanyID": 11,
      "DateTimeActivated": "sample string 12",
      "AgencyCode": "sample string 13",
      "AgentNumber": "sample string 14",
      "AdditionalData": "sample string 15",
      "AgentWithCustomer": true,
      "DateTimeModified": "2025-04-03T17:37:52.8995477-05:00",
      "DNCCheckRequired": true,
      "DNCFlag": true,
      "Sponsor": "sample string 17",
      "Relationship": "sample string 18",
      "Notes": "sample string 19"
    }
  ],
  "StatusCode": 1,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<RouteLeadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMK.CSK.API.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <StatusCode>1</StatusCode>
  <Leads>
    <RouteLead>
      <AdditionalData>sample string 15</AdditionalData>
      <Address>sample string 4</Address>
      <AgencyCode>sample string 13</AgencyCode>
      <AgentNumber>sample string 14</AgentNumber>
      <AgentWithCustomer>true</AgentWithCustomer>
      <City>sample string 5</City>
      <CompanyID>11</CompanyID>
      <DNCCheckRequired>true</DNCCheckRequired>
      <DNCFlag>true</DNCFlag>
      <DateTimeActivated>sample string 12</DateTimeActivated>
      <DateTimeModified>2025-04-03T17:37:52.8995477-05:00</DateTimeModified>
      <Email>sample string 9</Email>
      <FirstName>sample string 2</FirstName>
      <Language>10</Language>
      <LastName>sample string 3</LastName>
      <LeadNumber>1</LeadNumber>
      <MobilePhone>sample string 7</MobilePhone>
      <Notes>sample string 19</Notes>
      <Relationship>sample string 18</Relationship>
      <Sponsor>sample string 17</Sponsor>
      <State>sample string 8</State>
      <ZipCode>sample string 6</ZipCode>
    </RouteLead>
    <RouteLead>
      <AdditionalData>sample string 15</AdditionalData>
      <Address>sample string 4</Address>
      <AgencyCode>sample string 13</AgencyCode>
      <AgentNumber>sample string 14</AgentNumber>
      <AgentWithCustomer>true</AgentWithCustomer>
      <City>sample string 5</City>
      <CompanyID>11</CompanyID>
      <DNCCheckRequired>true</DNCCheckRequired>
      <DNCFlag>true</DNCFlag>
      <DateTimeActivated>sample string 12</DateTimeActivated>
      <DateTimeModified>2025-04-03T17:37:52.8995477-05:00</DateTimeModified>
      <Email>sample string 9</Email>
      <FirstName>sample string 2</FirstName>
      <Language>10</Language>
      <LastName>sample string 3</LastName>
      <LeadNumber>1</LeadNumber>
      <MobilePhone>sample string 7</MobilePhone>
      <Notes>sample string 19</Notes>
      <Relationship>sample string 18</Relationship>
      <Sponsor>sample string 17</Sponsor>
      <State>sample string 8</State>
      <ZipCode>sample string 6</ZipCode>
    </RouteLead>
  </Leads>
</RouteLeadResponse>