LOGIN NAME:

PASSWORD:

:: Web Services :: XWebLead ::
:: Documentation (Version 1) ::

LoadLeadsPaged SOAP Method

DESCRIPTION:

Returns 'paginated' Lead records, in the reverse chronological order the records were entered into the system. Paginated is the ability to return a specific number of records at a time, similar to how search engines display results (i.e. Google's 10 search results on a page).

PARAMETER(S):

intPageNumber - Positive Integer. Indicates the page number for which the data is to be returned.
intPageSize - Positive Integer. The number of records you want displayed on a page.

SOAP HEADERS:

LoginName - String. The "Login Name" you chose during the registration process.
Password - String. Your account's "Password".

NOTE***: SOAP Headers are required for authentication

RETURNS:

XML String, representing the Lead records requested. To view the validating XSD Schema, please click here (opens in a new window). An example is provided here (opens in a new window) or below:

<Leads Total_Record_Count="25">
 <Lead Lead_ID="9f9035cbf75c402cae78a29d081e19b1" 
  Date_Created="2005-06-17T09:13:00">
  <Source_Identifier>jack</Source_Identifier>
  <Description>Our demo lead's Description would go here.</Description>
 </Lead>
 <Lead Lead_ID="25466e9908e248b3b1164f9e9ee66744" 
  Date_Created="2005-06-02T19:12:00">
  <Source_Identifier>sam</Source_Identifier>
  <Description>Description would go here.</Description>
 </Lead>
...
</Leads>

If the account does not contain any records, the <Leads> root node will not contain any child elements and the Total_Record_Count attribute will have a value of 0 (zero). An example is provided below:

<Leads Total_Record_Count="0" />

All non-XML strings returned by this method should be considered errors.

ERROR(S):

If the system encounters an error, the method will return one the following messages instead of the expected XML string:

Error: Unable to authenticate. Your username and/or password are invalid. - authentication errors.
Error: You have not yet registered for this service. - authorization errors.
Error: A database error has occurred. Please try again later. - catastrophic database errors.
Error: System error. Unable to process the request. - catastrophic system errors.

ADDITIONAL SUPPORT RESOURCES:

• Frequently Asked Questions specific to this web service
• Developer community supported Online Forum
• "How-to" Implementation Guides