THURSDAY, AUGUST 07, 2008




MY ACCOUNT LOGIN

LOGIN NAME:

PASSWORD:

REGISTER TODAY!
FORGOT YOUR PASSWORD?

SOAP METHODS



LOADFAQ

PROCESSFAQ

GETNEWFAQID

LOADFAQs

LOADFAQsPAGED



Web Services, SOA Solutions, SOA Services - XWebServices.com


HOME

WEB SERVICES

SOA SOLUTIONS

SOA SERVICES

ABOUT US





XWEBFAQs


Documentation


FAQs


Implementation Guides


Forum


Pricing






SEARCH









HOME  ::  WEB SERVICES  ::  XWEBFAQs  ::  DOCUMENTATION

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

LoadFAQsPaged SOAP Method

DESCRIPTION:

Returns "paginated" Frequently Asked Question records (FAQs), 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 FAQ 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:

<FAQs Total_Record_Count="25">
 <FAQ FAQ_ID="20" Date_Created="2004-02-29T07:50:00">
  <Question>Who wrote "Moby Dick"?</Question>
  <Answer>Herman Melville.</Answer>
 </FAQ>
 <FAQ FAQ_ID="19" Date_Created="2004-01-17T17:29:00">
  <Question>Who wrote "To Kill A Mockingbird"?</Question>
  <Answer>Harper Lee.</Answer>
 </FAQ>
 ...
</FAQs>

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

<FAQs Total_Record_Count="0" />

All non-XML strings returned by this SOAP 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:



HOME
WEB SERVICES
SOA SOLUTIONS
SOA SERVICES
MY ACCOUNT
ABOUT US