= Warning! Source =
N.B. This document API is under construction.a subst of the full bxp API [[Bxp_API]]
The bxp APP API is a subset of the bxp API designed specifically to work with APPs.
After login, all function calls must include the tokens in order for the API to respond correctly.
= Functions =
== Login Function ==
== Function List ==
Primary Function: Provide a login session token
The functions are laid out in terms of usual order of processing
You must post four key pair values. (not including the semi colons)Initial* login [[Bxp_API_APP_-_Function_-_Login]]* settings [[Bxp_API_APP_-_Function_-_Settings_and_Confg]]* config_primary [[Bxp_API_APP_-_Function_-_Settings_and_Confg#config_function]]* config_buttonX [[Bxp_API_APP_-_Function_-_Settings_and_Confg#config_function]]
* strFunction:login
* strSystem:client_demo
* strClient_Username:Demo Account
* strClient_Password:demoPassword
Lister
* list_listee [[Bxp_API_APP_-_Function_-_Lister]]
* insert_listee [[Bxp_API_APP_-_Function_-_Lister#Create_Listee]]
The system will respond with XML.
Diary
* diary [[Bxp_API_APP_-_Function_-_Diary]]
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<data>
<strFunction>login</function>
<intErrorId></intErrorId>
<strError></error>
<intClient_Id>123</userid>
<strClient_SessionField>asdfasdfasdf</strClient_SessionField>
</data>
</syntaxhighlight>
Forms
* formlookup [[Bxp_API_APP_-_Function_-_Diary]]
* insert_formrecord [[Bxp_API_APP_-_Function_-_Diary#Form_Insert_Function]]
== Settings recall Function ==System* list_hamsters [[Bxp_API_APP_-_Function_-_Hamster]]
Primary Function: Provide APP settings for the bxp app.Future build items* reminders (future build)* todo (future build)* list_reminders (future build)* list_appointment (future build)
You must post four key pair values. (not including the semi colons)
* strFunction:settings
* strSystem:client_demo
* intClient_Id:123
* strClient_SessionField:asdfasdfasdf
= Error Listing =
The Client Id and Client Session Field are retrieved from the login process.
For a full listing of all errors [[Bxp_API_APP_-_Error_Listing]]
The system will respond with XML.
<syntaxhighlight lang="xml"><?xml versionHistory ="1.0" encoding="UTF-8" ?><data> <strFunction>settings</function> <intErrorId></intErrorId> <strError></error>
Data to go here!
</data></syntaxhighlight>This API was developed to further the work of Calvin O'Brien and Adam McGivern who work as interns in All n One developing the bxp APP for iPhone, Android and Microsoft devices.
== Diary Function ==More details on the original project spec can be found here.
Primary Function[[Category: 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_today</strFunction> <intErrorId>0</intErrorId> <strError></strError> <dtePeriodStart>2015-01-01 00:00:00</dtePeriodStart> <dtePeriodEnd>2015-01-02 00:00:00</dtePeriodEnd> <item> <id>2490</id> <title>Demo Item 1</title> <start>2015-01-03T14:30:00</start> <end>2015-01-03T17:30:00</end> <url>../appointment/userTimeEvent_Edit-details.asp?intTime_Event_Id=2490</url> </item> <item> <id>2491</id> <title>Demo Item 2</title> <start>2015-01-06T14:00:00</start> <end>2015-01-06T15:30:00</end> <url>../appointment/userTimeEvent_Edit-details.asp?intTime_Event_Id=2491</url> </item> <item> <id>1171</id> <title>Demo Item 3</title> <start>2015-01-08T10Topic:00:00</start>bxp_APP_API]] <end>2015-01-08T14:00[[Category:00</end> <url>../appointment/userTimeEvent_Edit-details.asp?intTime_Event_Id=1171</url> </item></data> </syntaxhighlight> NotesTopic: * Each item represents a calendar entry. Id is unique for each entry.* All titles are HTML encoded.* Time is separated with a T.* The URL represents navigation within the bxp system to be able to edit that item. = History = This API was developed to further the work of Calvin O'Brien and Adam McGivern who work as interns in All n One developing the bxp APP for iPhone, Android and Microsoft devices. More details on the original project spec can be found here.bxp_API]]
