Web Wiz Forums Logo

  Web Wiz Forums HTTP XML API Documentation


Version: 1.03
Description This API has been designed to be used by external systems. The documentation below illustrates the methods that are available in this API. You can click on the method name in the list of Available Methods below to get more details about the parameters that it needs and also a test form to try out the method against your own control panel.

Usage
Use "HttpAPI.asp?action=[MethodName]&Username=[MasterAdminLoginName]&Password=[MasterAdminPassword]&{AdditionalData}"

e.g."HttpAPI.asp?action=GetUsers&Username=Adminsitrator&Password=letmein"

Both GET and POST methods are supported and results are returned in XML format.

You can use the Microsoft HTTPXML object in your own ASP or ASP.NET applications to call methods using this HTTP API, the result will be returned in XML format.


Available Methods

General
Name Description
APIVersion Returns the current version of this API
WebWizForumsVersion Returns the current version of Web Wiz Forums

Member Management
Name Description
CreateNewMember Creates a new Web Wiz Forums Member
GetMemberByName Returns details on the member by Member Name
GetMemberByID Returns details on the member by Member ID (Author_ID in database)
ActivateMember Sets members account status to active
SuspendMember Sets members account status to suspended
UnsubspendMember Remove suspended status from members account
LoginMemberCookie Returns members login cookie data, to create your own login cookie to the forum
LogoutMember Forces logout of member
ChangeMemberPassword Changes the password for a members account

Forum Management
Name Description
GetForums Returns list of forums
LockForumByID Locks a Forum by Forum ID (Forum_ID in database) to prevent new posts being made
UnLockForumByID UnLocks a Forum by Forum ID (Forum_ID in database)

Topic Management
Name Description
GetTopicNameByID Returns details on the topic by Topic ID (Topic_ID in database)
GetLastTopics Gets the Last Topics (Unlike RSS Feeds this also returns results for non-public forums)
GetLastTopicsByForumID Gets the Last Topics by Forum ID (Forum_ID in database)
CloseTopicByID Closes Topic by ID
OpenTopicByID Opens Locked Topic By ID

Post Management
Name Description
GetLastPosts Gets the Last Posts across all forums (Unlike RSS Feeds this also returns results for non-public forums)
GetLastPostsByForumID Gets the Last Topics from a particular forum by Forum ID (Forum_ID in database)


Returned Results

Returned Results
Successful Result in XML
The following is an example of data being returned if the method is successful. The ErrorCode will be 0 with a blank ErrorDescription. Depending on the method will determine how many records are returned in the ResultData.

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<ApiResponse>
 <ErrorCode>0</ErrorCode>
 <ErrorDescription/>
 <ResultData recordcount="2">
  <Record>
    <FirstField>first Field value</FirstField>
    <SecondField>second Field value</SecondField>
  </Record>
  <Record>
    <FirstField>more data</FirstField>
    <SecondField>more data again</SecondField>
  </Record>
 </ResultData>
</ApiResponse>

Unsuccessful Result in XML
The following is an example of data being returned if the method is unsuccessful. The ErrorCode will be a negative number (eg. -150), and the ErrorDescription will contain a description of the error. The ResultData will be blank.

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<ApiResponse>
 <ErrorCode>-150</ErrorCode>
 <ErrorDescription>Admin Login Fail</ErrorDescription>
 <ResultData/>
</ApiResponse>


General Method Details

APIVersion Returns the current version of this API


Test Form

Parameter Value
Username* (required)
Password* (required)

Back to Top or Available Methods

WebWizForumsVersion

Returns the current version of Web Wiz Forums

Test Form

Parameter Value
Username* (required)
Password* (required)

Back to Top or Available Methods


Member Management Method Details

CreateNewMember

Creates a new Web Wiz Forums Member

Test Form

Parameter Value
Username* (required)
Password* (required)
MemberName* (required) min length 3, max length 20
MemberPassword* (required) min length 4, max length 15
Active True/False, defaults to True if left blank
Suspended True/False, defaults to False if left blank
GroupID Group_ID Number, defaults to Starting Group ID if left blank
Email max length 50
RealName max length 25
Gender max length 10
Homepage max length 48
Avatar max length 95, URL to avatar
Signature max length 200, BBcode enabled
SignatureAttach True/False, defaults to True if left blank
ICQ Number, max length 15
DateFormat Accepted values; dd/mm/yy, mm/dd/yy, yy/dd/mm, yy/mm/dd, defualts to dd/mm/yy
WYSIWYGeditor True/False, defaults to True if left blank
NoOfPosts Number, defualts to 0 if left blank
MemberTitle max length 40
AdminNotes max length 250
Newsletter True/False, defaults to False if left blank

Back to Top or Available Methods

GetMemberByName

Returns details on the member

Test Form

Parameter Value
Username* (required)
Password* (required)
MemberName* (required)

Back to Top or Available Methods

GetMemberByID

Returns details on the membefrom their member ID (Author_ID)

Test Form

Parameter Value
Username* (required)
Password* (required)
MemberID* (required)

Back to Top or Available Methods

ActivateMember

Sets members account status to active

Test Form

Parameter Value
Username* (required)
Password* (required)
MemberName* (required)

Back to Top or Available Methods

SuspendMember

Sets members account status to suspended

Test Form

Parameter Value
Username* (required)
Password* (required)
MemberName* (required)

Back to Top or Available Methods

UnsubspendMember

Remove suspended status from members account

Test Form

Parameter Value
Username* (required)
Password* (required)
MemberName* (required)

Back to Top or Available Methods

LoginMemberCookie

Returns members login cookie data, to create your own login cookie to the forum

Test Form

Parameter Value
Username* (required)
Password* (required)
MemberName* (required)
MemberPassword Not required. Use if you want to create a Username and Password login system

Back to Top or Available Methods

LogoutMember

Forces logout of member

Test Form

Parameter Value
Username* (required)
Password* (required)
MemberName* (required)

Back to Top or Available Methods

ChangeMemberPassword

Changes the password for a members account

Test Form

Parameter Value
Username* (required)
Password* (required)
MemberName* (required)
NewPassword* (required) max length 15

Back to Top or Available Methods


Forum Management Method Details

GetForums

Returns list of forums

Test Form

Parameter Value
Username* (required)
Password* (required)

Back to Top or Available Methods

LockForumByID

Locks a Forum by Forum ID (Forum_ID in database) to prevent new posts being made

Test Form

Parameter Value
Username* (required)
Password* (required)
ForumID* (required)

Back to Top or Available Methods

UnLockForumByID

UnLocks a Forum by Forum ID (Forum_ID in database)

Test Form

Parameter Value
Username* (required)
Password* (required)
ForumID* (required)

Back to Top or Available Methods


Topic Management Method Details

GetTopicNameByID

Returns details on the topic by Topic ID (Topic_ID in database)

Test Form

Parameter Value
Username* (required)
Password* (required)
TopicID* (required)

Back to Top or Available Methods

GetLastTopics

Gets the Last Topics across all forums (Unlike RSS Feeds this also returns results for non-public forums)

Test Form

Parameter Value
Username* (required)
Password* (required)
MaxResults Maximum Number of Results to return (max.50)

Back to Top or Available Methods

GetLastTopicsByForumID

Gets the Last Topics from a particular forum by Forum ID (Forum_ID in database)

Test Form

Parameter Value
Username* (required)
Password* (required)
ForumID* (required)
MaxResults Maximum Number of Results to return (max.50)

Back to Top or Available Methods

CloseTopicByID

Closes Topic by Topic ID

Test Form

Parameter Value
Username* (required)
Password* (required)
TopicID* (required)

Back to Top or Available Methods

OpenTopicByID

Opens Locked Topic By ID

Test Form

Parameter Value
Username* (required)
Password* (required)
TopicID* (required)

Back to Top or Available Methods

Post Management Method Details

GetLastPosts

Gets the Last Posts across all forums (Unlike RSS Feeds this also returns results for non-public forums)

Test Form

Parameter Value
Username* (required)
Password* (required)
MaxResults Maximum Number of Results to return (max.50)

Back to Top or Available Methods

GetLastPostsByForumID

Gets the Lasts Posts from a particular forum by Forum ID (Forum_ID in database)

Test Form

Parameter Value
Username* (required)
Password* (required)
ForumID* (required)
MaxResults Maximum Number of Results to return (max.50)

Back to Top or Available Methods


* Field is required when executing the method