LOGIN NAME:

PASSWORD:

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

LoadSurveysPaged SOAP Method

DESCRIPTION:

Returns 'paginated' Survey (Poll) 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 Survey 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:

<Surveys Total_Record_Count="15">
 <Survey Survey_ID="7" Date_Created="2005-09-12T15:29:00">
  <Name>Demo Survey</Name>
  <Description>Our demo survey's Description
      would go here.</Description>
  <Total_Votes>10</Total_Votes>
  <Options>
   <Option Option_Sequence="1">
    <Name>First Option</Name>
    <Votes>6</Votes>
    <Percentage>60</Percentage>
   </Option>
   <Option Option_Sequence="2">
    <Name>Second Option</Name>
    <Votes>4</Votes>
    <Percentage>40</Percentage>
   </Option>
  </Options>
 </Survey>
 <Survey Survey_ID="4" Date_Created="2005-09-12T15:29:00">
  <Name>Name of Survey</Name>
  <Description>Description of Survey</Description>
  <Total_Votes>0</Total_Votes>
  <Options />
 </Survey>
 ...
<Surveys>

If the account does not contain any records, the <Surveys> 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:

<Surveys 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