Veetro Web Service Methods
Click here for a complete list of operations.
GetLeadSearchResults2
[Permission: Employee, Credentials: Sales.Leads.ViewFull/Limited]
Returns paginated 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/GetLeadSearchResults2" <?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> <GetLeadSearchResults2 xmlns="http://schema.veetro.com"> <e> <StartIndex>int</StartIndex> <FetchSize>int</FetchSize> <SortColumn>LeadID or Name or Value or DateCreated or Source or Status or Priority or Owner or TotalRevenue or SalesProcess or ProbabilityPercent or EstimatedMaturityDate or EstimatedDeliveryDate or Relation or TotalMarkup or CustomField or Assignto or DecisionDate or Contacts</SortColumn> <Ascending>boolean</Ascending> <Keywords>string</Keywords> <Status> <LeadStatus>Active or Win or Lose</LeadStatus> <LeadStatus>Active or Win or Lose</LeadStatus> </Status> <GetAllStatus>boolean</GetAllStatus> <Stages> <SalesProcessFilter> <ID>int</ID> <Stage>int</Stage> </SalesProcessFilter> <SalesProcessFilter> <ID>int</ID> <Stage>int</Stage> </SalesProcessFilter> </Stages> <GetAllStages>boolean</GetAllStages> <Priorities> <int>int</int> <int>int</int> </Priorities> <GetAllPriorities>boolean</GetAllPriorities> <GetUnassignedStage>boolean</GetUnassignedStage> <ActiveOnly>boolean</ActiveOnly> <Relations> <int>int</int> <int>int</int> </Relations> <ActiveRelations>boolean</ActiveRelations> <InactiveRelations>boolean</InactiveRelations> <GetUnassigned>boolean</GetUnassigned> <Owner> <int>int</int> <int>int</int> </Owner> <UtcDateFrom>dateTime</UtcDateFrom> <UtcDateTo>dateTime</UtcDateTo> <NameOnly>boolean</NameOnly> <RelationEntityID>int</RelationEntityID> <IncludeCompanyLeads>boolean</IncludeCompanyLeads> <SalesProcess>int</SalesProcess> <PopulateCustomFields>boolean</PopulateCustomFields> </e> </GetLeadSearchResults2> </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> <GetLeadSearchResults2Response xmlns="http://schema.veetro.com"> <GetLeadSearchResults2Result> <RecordCount>int</RecordCount> <Description>string</Description> <SQL>string</SQL> <FetchSize>int</FetchSize> <Page>int</Page> <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> </GetLeadSearchResults2Result> </GetLeadSearchResults2Response> </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> <GetLeadSearchResults2 xmlns="http://schema.veetro.com"> <e> <StartIndex>int</StartIndex> <FetchSize>int</FetchSize> <SortColumn>LeadID or Name or Value or DateCreated or Source or Status or Priority or Owner or TotalRevenue or SalesProcess or ProbabilityPercent or EstimatedMaturityDate or EstimatedDeliveryDate or Relation or TotalMarkup or CustomField or Assignto or DecisionDate or Contacts</SortColumn> <Ascending>boolean</Ascending> <Keywords>string</Keywords> <Status> <LeadStatus>Active or Win or Lose</LeadStatus> <LeadStatus>Active or Win or Lose</LeadStatus> </Status> <GetAllStatus>boolean</GetAllStatus> <Stages> <SalesProcessFilter> <ID>int</ID> <Stage>int</Stage> </SalesProcessFilter> <SalesProcessFilter> <ID>int</ID> <Stage>int</Stage> </SalesProcessFilter> </Stages> <GetAllStages>boolean</GetAllStages> <Priorities> <int>int</int> <int>int</int> </Priorities> <GetAllPriorities>boolean</GetAllPriorities> <GetUnassignedStage>boolean</GetUnassignedStage> <ActiveOnly>boolean</ActiveOnly> <Relations> <int>int</int> <int>int</int> </Relations> <ActiveRelations>boolean</ActiveRelations> <InactiveRelations>boolean</InactiveRelations> <GetUnassigned>boolean</GetUnassigned> <Owner> <int>int</int> <int>int</int> </Owner> <UtcDateFrom>dateTime</UtcDateFrom> <UtcDateTo>dateTime</UtcDateTo> <NameOnly>boolean</NameOnly> <RelationEntityID>int</RelationEntityID> <IncludeCompanyLeads>boolean</IncludeCompanyLeads> <SalesProcess>int</SalesProcess> <PopulateCustomFields>boolean</PopulateCustomFields> </e> </GetLeadSearchResults2> </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> <GetLeadSearchResults2Response xmlns="http://schema.veetro.com"> <GetLeadSearchResults2Result> <RecordCount>int</RecordCount> <Description>string</Description> <SQL>string</SQL> <FetchSize>int</FetchSize> <Page>int</Page> <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> </GetLeadSearchResults2Result> </GetLeadSearchResults2Response> </soap12:Body> </soap12:Envelope>