Difference between revisions of "Bxp API - APP API"

From All n One's bxp software Wixi

Jump to: navigation, search
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
= Warning! =
+
= Source =
  
  
−
This document is under construction.
+
N.B.  This API is a subst of the full bxp API [[Bxp_API]]
  
  
Line 13: Line 13:
  
 
The bxp APP API is a subset of the bxp API designed specifically to work with APPs.
 
The bxp APP API is a subset of the bxp API designed specifically to work with APPs.
 +
  
  
Line 28: Line 29:
  
 
After login, all function calls must include the tokens in order for the API to respond correctly.
 
After login, all function calls must include the tokens in order for the API to respond correctly.
 +
  
  
 
= Functions =
 
= Functions =
−
 
−
== 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.
 
−
 
−
 
−
<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>
 
−
 
−
 
−
 
−
== 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>
 
  
  
 +
== Function List ==
  
−
== Diary Function ==
 
  
 +
The functions are laid out in terms of usual order of processing
  
 +
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]]
  
−
Primary Function: Provide listing of diary events
 
  
 +
Lister
 +
* list_listee [[Bxp_API_APP_-_Function_-_Lister]]
 +
* insert_listee [[Bxp_API_APP_-_Function_-_Lister#Create_Listee]]
  
−
You must post five key pair values. (not including the semi colons)
 
  
−
* strFunction:diary
+
Diary
−
* strSystem:client_demo
+
* diary [[Bxp_API_APP_-_Function_-_Diary]]
−
* intClient_Id:123
 
−
* strClient_SessionField:asdfasdfasdf
 
−
* intDiary:1
 
  
−
The strFunction setting can have a number of settings.
 
  
−
* diary - defaults for today
+
Forms
−
* diary_today - explicitly today listing
+
* formlookup  [[Bxp_API_APP_-_Function_-_Diary]]
−
* diary_tomorrow - explicitly tomorrow listing
+
* insert_formrecord [[Bxp_API_APP_-_Function_-_Diary#Form_Insert_Function]]
−
* 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.
+
System
 +
* list_hamsters  [[Bxp_API_APP_-_Function_-_Hamster]]
  
  
−
The system will respond with XML.
+
Future build items
 +
* reminders (future build)
 +
* todo (future build)
 +
* list_reminders  (future build)
 +
* list_appointment  (future build)
  
−
 
−
<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-08T10:00:00</start>
 
−
<end>2015-01-08T14:00:00</end>
 
−
<url>../appointment/userTimeEvent_Edit-details.asp?intTime_Event_Id=1171</url>
 
−
</item>
 
−
</data>
 
−
 
−
</syntaxhighlight>
 
−
 
−
 
−
Notes:
 
−
 
−
* 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.
 
  
  
Line 175: Line 77:
  
  
−
# "A function must be provided"
+
For a full listing of all errors [[Bxp_API_APP_-_Error_Listing]]
−
# "A system must be provided"
 
−
# "Cross System Calls Not Possible [your call] [system location] "
 
−
# "Invalid Account Details"
 
−
# "Login - No Username"
 
−
# "Login - No Password"
 
−
# "Login - System Not Active"
 
−
# "Login - System Expired"
 
−
# "Login - Unrecognised username [username]"
 
−
# "Login - Unrecognised username and or password"
 
−
# "Login - IP Restriction Failure"
 
−
# "Unrecognised Function [function]"
 
−
# "Account Check - No client id"
 
−
# "Account Check - No session field"
 
−
# "Account Check - Account not found"
 
−
# "Diary - No Diary Id passed"
 
−
# "Diary - No permissions to access this diary [intDiary]"
 
−
# "Diary - Incorrect parameters"
 
  
  
Line 202: Line 87:
  
 
More details on the original project spec can be found here.
 
More details on the original project spec can be found here.
 +
 +
 +
 +
[[Category:Topic:bxp_APP_API]]
 +
[[Category:Topic:bxp_API]]

Latest revision as of 12:50, 5 September 2015

1 Source

N.B.  This API is a subst of the full bxp API Bxp_API


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 Function List

The functions are laid out in terms of usual order of processing

Initial


Lister


Diary


Forms


System


Future build items

  • reminders (future build)
  • todo (future build)
  • list_reminders (future build)
  • list_appointment (future build)



5 Error Listing

For a full listing of all errors Bxp_API_APP_-_Error_Listing


6 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=5140’