Difference between revisions of "Bxp API - APP API"

From All n One's bxp software Wixi

Jump to: navigation, search
(Created page with "= Warning! = This document is under construction. = Introduction = The bxp API (Application Programming Interface) allows digital interaction with bxp without the need...")
 
Line 32: Line 32:
 
= Functions =
 
= Functions =
  
−
= Login Function =
+
== Login Function ==
 +
 
 +
 
 +
Primary Function: Provide a login session token
 +
 
  
 
You must post four key pair values. (not including the semi colons)
 
You must post four key pair values. (not including the semi colons)
Line 40: Line 44:
 
* strClient_Username:Demo Account
 
* strClient_Username:Demo Account
 
* strClient_Password:demoPassword
 
* strClient_Password:demoPassword
 +
  
 
The system will respond with XML.
 
The system will respond with XML.
 +
  
 
<syntaxhighlight lang="xml">
 
<syntaxhighlight lang="xml">
Line 47: Line 53:
 
<data>
 
<data>
 
<strFunction>login</function>
 
<strFunction>login</function>
 +
<intErrorId></intErrorId>
 
<strError></error>
 
<strError></error>
 
<intClient_Id>123</userid>
 
<intClient_Id>123</userid>
Line 53: Line 60:
 
</syntaxhighlight>
 
</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>
  
  

Revision as of 20:20, 26 July 2015

1 Warning!

This document is under construction.


2 Introduction

The bxp API (Application Programming Interface) allows digital interaction with bxp without the need for a human to interact with bxp.


The bxp APP API is a subset of the bxp API designed specifically to work with APPs.


3 How it works

The APP API requires secure posts to be sent to the relevant system. This can be done using a number of DOM (Document Object Technologies)


The primary post is sent to https://ww3.allnone.ie/client/client_demo/cti/userAPP_Main.asp You must replace client_demo with the system you are communicating with.


A number of criteria must be passed for the process to work. The first process is a login process which will provide tokenisation for your app.


After login, all function calls must include the tokens in order for the API to respond correctly.


4 Functions

4.1 Login Function

Primary Function: Provide a login session token


You must post four key pair values. (not including the semi colons)

  • strFunction:login
  • strSystem:client_demo
  • strClient_Username:Demo Account
  • strClient_Password:demoPassword


The system will respond with 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>


4.2 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. 


<?xml version="1.0" encoding="UTF-8" ?>
<data>
	<strFunction>settings</function>
	<intErrorId></intErrorId>
	<strError></error>

Data to go here!
	

</data>


4.3 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. 


<?xml version="1.0" encoding="UTF-8" ?>
<data>
	<strFunction>diary</function>
	<intErrorId></intErrorId>
	<strError></error>

Data to go here!
	

</data>


5 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.

Retrieved from ‘https://www.bxpsoftware.com/wixi/index.php?title=Bxp_API_-_APP_API&oldid=4750’