Bxp API - APP API

Contents

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

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

Lister

• list_listee Bxp_API_APP_-_Function_-_Lister
• insert_listee Bxp_API_APP_-_Function_-_Lister#Create_Listee

Diary

• diary Bxp_API_APP_-_Function_-_Diary

Forms

• campaignlookup
• insert_record

System

• list_hamsters

Future build items

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

5 Error Listing

1. "A function must be provided"
2. "A system must be provided"
3. "Cross System Calls Not Possible [your call] [system location] "
4. "Invalid Account Details"
5. "Login - No Username"
6. "Login - No Password"
7. "Login - System Not Active"
8. "Login - System Expired"
9. "Login - Unrecognised username [username]"
10. "Login - Unrecognised username and or password"
11. "Login - IP Restriction Failure"
12. "Unrecognised Function [function]"
13. "Account Check - No client id"
14. "Account Check - No session field"
15. "Account Check - Account not found"
16. "Diary - No Diary Id passed"
17. "Diary - No permissions to access this diary [intDiary]"
18. "Diary - Incorrect parameters"

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.