THURSDAY, AUGUST 07, 2008



	MY ACCOUNT LOGIN

PASSWORD:

FORGOT YOUR PASSWORD?

SOAP METHODS

	LOADMESSAGE
	LOADTOPIC
	PROCESSMESSAGE
	GETNEWMESSAGEID
	LOADTOPICS
	LOADTOPICSPAGED
	LOADMESSAGES
	LOADMESSAGESPAGED
	LOADMESSAGESBYSOURCE
	LOADMESSAGESBYSOURCE PAGED
	PERSONALIZE
	LOADPERSONALIZEDMESSAGES

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


HOME	WEB SERVICES	SOA SOLUTIONS	SOA SERVICES	ABOUT US

XWEBFORUM

		Documentation			FAQs
		Implementation Guides			Forum
		Pricing

HOME :: WEB SERVICES :: XWEBFORUM :: DOCUMENTATION

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

LoadMessagesBySourcePaged SOAP Method

DESCRIPTION:

Returns 'paginated' Message records by a specific Source Identifier, 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):

strSourceIdentifier - String. Indicates the Source Identifier for which the data is to be returned.
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 Forum Message records posted by a specific source (the record's <Source_Identifier> value matches the input parameter's value). 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:

<Forum Total_Record_Count="8">
 <Message Message_ID="10" Date_Created="2004-08-10T07:11:00">
  <Source_Identifier>suzan</Source_Identifier>
  <Author>Suzan Someone</Author>
  <Subject>Demo Forum Topic 10</Subject>
  <Body>Body would go here.</Body>
  <Replies_Count>8</Replies_Count>  
 </Message>
 ...
</Forum>

If the account does not contain any records for that specific source, the <Forum> 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:

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

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

LoadMessagesBySourcePaged SOAP Method

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