Veetro Web Service Methods


Click here for a complete list of operations.

GetLeadsPaged

Returns a paged resultset of Leads

Test

The test form is only available for requests from the local machine.

SOAP 1.1

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

POST /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schema.veetro.com/GetLeadsPaged"

<?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>
    <GetLeadsPaged xmlns="http://schema.veetro.com">
      <e>
        <FetchSize>int</FetchSize>
        <StartIndex>int</StartIndex>
        <Keywords>string</Keywords>
        <Status>int</Status>
        <IncludeUnassigned>boolean</IncludeUnassigned>
      </e>
    </GetLeadsPaged>
  </soap:Body>
</soap:Envelope>
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>
    <GetLeadsPagedResponse xmlns="http://schema.veetro.com">
      <GetLeadsPagedResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <FetchSize>int</FetchSize>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <Lead>
            <LeadID>int</LeadID>
            <Relation xsi:nil="true" />
            <Owner xsi:nil="true" />
            <Name>string</Name>
            <Flags>None or Inactive</Flags>
            <Referrer xsi:nil="true" />
            <Contacts xsi:nil="true" />
            <Source>string</Source>
            <OriginalProposalID>int</OriginalProposalID>
            <DateCreated>dateTime</DateCreated>
            <DateCreatedUtcString>string</DateCreatedUtcString>
            <DateLastModified>dateTime</DateLastModified>
            <DateLastModifiedUtcString>string</DateLastModifiedUtcString>
            <Value>double</Value>
            <Types>None or Service or Product</Types>
            <ProductRevenue>double</ProductRevenue>
            <ProductMarginPercent>double</ProductMarginPercent>
            <ServiceRevenue>double</ServiceRevenue>
            <ServiceMarginPercent>double</ServiceMarginPercent>
            <ProbabilityPercent>int</ProbabilityPercent>
            <SalesProcess>int</SalesProcess>
            <EstimatedMaturityDate>dateTime</EstimatedMaturityDate>
            <EstimatedDeliveryDate>dateTime</EstimatedDeliveryDate>
            <Status>Active or Win or Lose</Status>
            <Priority>int</Priority>
            <DecisionDate>dateTime</DecisionDate>
            <DescriptionHtml>string</DescriptionHtml>
            <ParsedDesHtml>string</ParsedDesHtml>
            <ParsedDesPlain>string</ParsedDesPlain>
            <DateParseDesHtml>dateTime</DateParseDesHtml>
            <DateAssigned>dateTime</DateAssigned>
            <CustomFields xsi:nil="true" />
            <Delete>boolean</Delete>
            <RemoveParentLinks>boolean</RemoveParentLinks>
            <Tags xsi:nil="true" />
          </Lead>
          <Lead>
            <LeadID>int</LeadID>
            <Relation xsi:nil="true" />
            <Owner xsi:nil="true" />
            <Name>string</Name>
            <Flags>None or Inactive</Flags>
            <Referrer xsi:nil="true" />
            <Contacts xsi:nil="true" />
            <Source>string</Source>
            <OriginalProposalID>int</OriginalProposalID>
            <DateCreated>dateTime</DateCreated>
            <DateCreatedUtcString>string</DateCreatedUtcString>
            <DateLastModified>dateTime</DateLastModified>
            <DateLastModifiedUtcString>string</DateLastModifiedUtcString>
            <Value>double</Value>
            <Types>None or Service or Product</Types>
            <ProductRevenue>double</ProductRevenue>
            <ProductMarginPercent>double</ProductMarginPercent>
            <ServiceRevenue>double</ServiceRevenue>
            <ServiceMarginPercent>double</ServiceMarginPercent>
            <ProbabilityPercent>int</ProbabilityPercent>
            <SalesProcess>int</SalesProcess>
            <EstimatedMaturityDate>dateTime</EstimatedMaturityDate>
            <EstimatedDeliveryDate>dateTime</EstimatedDeliveryDate>
            <Status>Active or Win or Lose</Status>
            <Priority>int</Priority>
            <DecisionDate>dateTime</DecisionDate>
            <DescriptionHtml>string</DescriptionHtml>
            <ParsedDesHtml>string</ParsedDesHtml>
            <ParsedDesPlain>string</ParsedDesPlain>
            <DateParseDesHtml>dateTime</DateParseDesHtml>
            <DateAssigned>dateTime</DateAssigned>
            <CustomFields xsi:nil="true" />
            <Delete>boolean</Delete>
            <RemoveParentLinks>boolean</RemoveParentLinks>
            <Tags xsi:nil="true" />
          </Lead>
        </Results>
      </GetLeadsPagedResult>
    </GetLeadsPagedResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

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

POST /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetLeadsPaged xmlns="http://schema.veetro.com">
      <e>
        <FetchSize>int</FetchSize>
        <StartIndex>int</StartIndex>
        <Keywords>string</Keywords>
        <Status>int</Status>
        <IncludeUnassigned>boolean</IncludeUnassigned>
      </e>
    </GetLeadsPaged>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetLeadsPagedResponse xmlns="http://schema.veetro.com">
      <GetLeadsPagedResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <FetchSize>int</FetchSize>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <Lead>
            <LeadID>int</LeadID>
            <Relation xsi:nil="true" />
            <Owner xsi:nil="true" />
            <Name>string</Name>
            <Flags>None or Inactive</Flags>
            <Referrer xsi:nil="true" />
            <Contacts xsi:nil="true" />
            <Source>string</Source>
            <OriginalProposalID>int</OriginalProposalID>
            <DateCreated>dateTime</DateCreated>
            <DateCreatedUtcString>string</DateCreatedUtcString>
            <DateLastModified>dateTime</DateLastModified>
            <DateLastModifiedUtcString>string</DateLastModifiedUtcString>
            <Value>double</Value>
            <Types>None or Service or Product</Types>
            <ProductRevenue>double</ProductRevenue>
            <ProductMarginPercent>double</ProductMarginPercent>
            <ServiceRevenue>double</ServiceRevenue>
            <ServiceMarginPercent>double</ServiceMarginPercent>
            <ProbabilityPercent>int</ProbabilityPercent>
            <SalesProcess>int</SalesProcess>
            <EstimatedMaturityDate>dateTime</EstimatedMaturityDate>
            <EstimatedDeliveryDate>dateTime</EstimatedDeliveryDate>
            <Status>Active or Win or Lose</Status>
            <Priority>int</Priority>
            <DecisionDate>dateTime</DecisionDate>
            <DescriptionHtml>string</DescriptionHtml>
            <ParsedDesHtml>string</ParsedDesHtml>
            <ParsedDesPlain>string</ParsedDesPlain>
            <DateParseDesHtml>dateTime</DateParseDesHtml>
            <DateAssigned>dateTime</DateAssigned>
            <CustomFields xsi:nil="true" />
            <Delete>boolean</Delete>
            <RemoveParentLinks>boolean</RemoveParentLinks>
            <Tags xsi:nil="true" />
          </Lead>
          <Lead>
            <LeadID>int</LeadID>
            <Relation xsi:nil="true" />
            <Owner xsi:nil="true" />
            <Name>string</Name>
            <Flags>None or Inactive</Flags>
            <Referrer xsi:nil="true" />
            <Contacts xsi:nil="true" />
            <Source>string</Source>
            <OriginalProposalID>int</OriginalProposalID>
            <DateCreated>dateTime</DateCreated>
            <DateCreatedUtcString>string</DateCreatedUtcString>
            <DateLastModified>dateTime</DateLastModified>
            <DateLastModifiedUtcString>string</DateLastModifiedUtcString>
            <Value>double</Value>
            <Types>None or Service or Product</Types>
            <ProductRevenue>double</ProductRevenue>
            <ProductMarginPercent>double</ProductMarginPercent>
            <ServiceRevenue>double</ServiceRevenue>
            <ServiceMarginPercent>double</ServiceMarginPercent>
            <ProbabilityPercent>int</ProbabilityPercent>
            <SalesProcess>int</SalesProcess>
            <EstimatedMaturityDate>dateTime</EstimatedMaturityDate>
            <EstimatedDeliveryDate>dateTime</EstimatedDeliveryDate>
            <Status>Active or Win or Lose</Status>
            <Priority>int</Priority>
            <DecisionDate>dateTime</DecisionDate>
            <DescriptionHtml>string</DescriptionHtml>
            <ParsedDesHtml>string</ParsedDesHtml>
            <ParsedDesPlain>string</ParsedDesPlain>
            <DateParseDesHtml>dateTime</DateParseDesHtml>
            <DateAssigned>dateTime</DateAssigned>
            <CustomFields xsi:nil="true" />
            <Delete>boolean</Delete>
            <RemoveParentLinks>boolean</RemoveParentLinks>
            <Tags xsi:nil="true" />
          </Lead>
        </Results>
      </GetLeadsPagedResult>
    </GetLeadsPagedResponse>
  </soap12:Body>
</soap12:Envelope>