Anonymous, bureaucrat, administrator
7,528
edits
Changes
no edit summary
= Functions =
== Login Function == Primary Function: Provide a login session token
You must post four key pair values. (not including the semi colons)
* strClient_Username:Demo Account
* strClient_Password:demoPassword
The system will respond with XML.
<syntaxhighlight lang="xml">
<data>
<strFunction>login</function>
<intErrorId></intErrorId>
<strError></error>
<intClient_Id>123</userid>
</syntaxhighlight>
== Settings recall Function ==
Primary Function: Provide APP settings for the bxp app.
You must post four key pair values. (not including the semi colons)
* strFunction:settings
* strSystem:client_demo
* intClient_Id:123
* strClient_SessionField:asdfasdfasdf
The Client Id and Client Session Field are retrieved from the login process.
The system will respond with XML.
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<data>
<strFunction>settings</function>
<intErrorId></intErrorId>
<strError></error>
Data to go here!
</data>
</syntaxhighlight>
== Diary Function ==
Primary Function: Provide listing of diary events
You must post five key pair values. (not including the semi colons)
* strFunction:diary
* strSystem:client_demo
* intClient_Id:123
* strClient_SessionField:asdfasdfasdf
* intDiary:1
The strFunction setting can have a number of settings.
* diary - defaults for today
* diary_today - explicitly today listing
* diary_tomorrow - explicitly tomorrow listing
* diary_thisweek - explicitly this week listing
* diary_nextweek - explicitly next week listing
* diary_thismonth - explicitly this month listing
* diary_nextmonth - explicitly next month listing
The intDiary is the specific diary to be queried.
The system will respond with XML.
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<data>
<strFunction>diary</function>
<intErrorId></intErrorId>
<strError></error>
Data to go here!
</data>
</syntaxhighlight>