Bxp API APP - Function - Settings and Confg

From All n One's bxp software Wixi

Jump to: navigation, search

1 Overview

This function is part of the bxp API App suite of functions. Bxp_API_-_APP_API


2 settings 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. The comments were added for highlighting purposes only and will not be in the exported xml


Layout types possible

  • Splash
  • SplashArticle
  • Login
  • MainMenu
  • 1LargeDisplay
  • 1SmallText1LargeText1Button
  • 1Text1Button1LargeDisplay
  • 2LargeDisplay1LinkButton
  • Redirect
  • Settings


<?xml version="1.0" encoding="UTF-8" ?>
<data>
	<strFunction>settings</function>
	<intErrorId></intErrorId>
	<strError></error>
	<!-- Primary Settings  -->
	<intInterface_SystemId>2</intInterface_SystemId>
	<intInterface_UserId>0</intInterface_UserId>
	<intInterface_Columns>2</intInterface_Columns>
	<strInterface_RSSTitle>Latest News</strInterface_RSSTitle>
	<strInterface_RSSFeed>http://ww3.allnone.ie/client/client_allnone/message/rssfeed.asp</strInterface_RSSFeed>
	<strInterface_StoreSystemAndUsername>true</strInterface_StoreSystemAndUsername>
	<strInterface_Image_LogoURL>http://ww3.allnone.ie/client/client_allnone/images/Banner.jpg</strInterface_Image_LogoURL>
	<strInterface_Image_Background>http://ww3.allnone.ie/images/backgrounds/textureBackground002.jpg</strInterface_Image_Background>
	<strInterface_FontColours>#000000,#000000,#000000</strInterface_FontColours>
	<strInterface_FontFaces>Calibri,Calibri,Calibri</strInterface_FontFaces>
	<strInterface_FontSizes>18,12,10</strInterface_FontSizes>
	<strInterface_SystemKeywords>Login,Back,Get config file,Reset all settings</strInterface_SystemKeywords>
	<!-- Button 0 Settings  -->
	<strInterface_Button0_Title>To Do!</strInterface_Button0_Title>
	<strInterface_Button0_Styling>#ff0000,#000000,Calibri,12,URL</strInterface_Button0_Styling>
	<strInterface_Button0_Layout>1Text1Button1LargeDisplay</strInterface_Button0_Layout>
	<strInterface_Button0_FunctionType>App</strInterface_Button0_FunctionType>
	<strInterface_Button0_APICall>https://ww3.allnone.ie/client/client_allnone/cti/userApp.asp</strInterface_Button0_APICall>
	<strInterface_Button0_Config>[[--SEP--]]Insert,Listee[[--SEP--]]List,Listee,All</strInterface_Button0_Config>
	<strInterface_Button0_URL></strInterface_Button0_URL>
	<strInterface_Button0_Parameters></strInterface_Button0_Parameters>
	<!-- Button 1 Settings  -->
	<strInterface_Button1_Title>Ticket</strInterface_Button1_Title>
	<strInterface_Button1_Styling>#ff0000,#000000,Calibri,12,URL</strInterface_Button1_Styling>
	<strInterface_Button1_Layout>1SmallText1LargeText1Button</strInterface_Button1_Layout>
	<strInterface_Button1_FunctionType>App</strInterface_Button1_FunctionType>
	<strInterface_Button1_APICall>https://ww3.allnone.ie/client/client_allnone/cti/userAPP_Main.asp</strInterface_Button1_APICall>
	<strInterface_Button1_Config>[[--SEP--]][[--SEP--]]Insert,Record,intCampaignId,strFields,strValues</strInterface_Button1_Config>
	<strInterface_Button1_URL></strInterface_Button1_URL>
	<strInterface_Button1_Parameters></strInterface_Button1_Parameters>
	<strInterface_Button2_Title>Today</strInterface_Button2_Title>
	<strInterface_Button2_Styling>#ff0000,#000000,Calibri,12,URL</strInterface_Button2_Styling>
	<strInterface_Button2_Layout>2LargeDisplay1LinkButton</strInterface_Button2_Layout>
	<strInterface_Button2_FunctionType>App</strInterface_Button2_FunctionType>
	<strInterface_Button2_APICall>https://ww3.allnone.ie/client/client_allnone/cti/userAPP_Main.asp</strInterface_Button2_APICall>
	<strInterface_Button2_Config>List,Listee,Today[[--SEP--]]List,Appointment,Today[[--SEP--]]Redir,Button0</strInterface_Button2_Config>
	<strInterface_Button2_URL></strInterface_Button2_URL>
	<strInterface_Button2_Parameters></strInterface_Button2_Parameters>
	<strInterface_Button3_Title>Tomorrow</strInterface_Button3_Title>
	<strInterface_Button3_Styling>#ff0000,#000000,Calibri,12,URL</strInterface_Button3_Styling>
	<strInterface_Button3_Layout>2LargeDisplay1LinkButton</strInterface_Button3_Layout>
	<strInterface_Button3_FunctionType>App</strInterface_Button3_FunctionType>
	<strInterface_Button3_APICall>https://ww3.allnone.ie/client/client_allnone/cti/userAPP_Main.asp</strInterface_Button3_APICall>
	<strInterface_Button3_Config>List,Listee,Tomorrow[[--SEP--]]List,Appointment,Tomorrow[[--SEP--]]Redir,Button0</strInterface_Button3_Config>
	<strInterface_Button3_URL></strInterface_Button3_URL>
	<strInterface_Button3_Parameters></strInterface_Button3_Parameters>
	<strInterface_Button4_Title>Contacts</strInterface_Button4_Title>
	<strInterface_Button4_Styling>#ff0000,#000000,Calibri,12,URL</strInterface_Button4_Styling>
	<strInterface_Button4_Layout>1Text1Button1LargeDisplay</strInterface_Button4_Layout>
	<strInterface_Button4_FunctionType>App</strInterface_Button4_FunctionType>
	<strInterface_Button4_APICall>https://ww3.allnone.ie/client/client_allnone/cti/userAPP_Main.asp</strInterface_Button4_APICall>
	<strInterface_Button4_Config>[[--SEP--]]Lookup,intCampaign_Id,strCDA_X_field_Y_Z-strCDA_X_field_Y_Z[[--SEP--]]</strInterface_Button4_Config>
	<strInterface_Button4_URL></strInterface_Button4_URL>
	<strInterface_Button4_Parameters></strInterface_Button4_Parameters>
	<strInterface_Button5_Title>Critical</strInterface_Button5_Title>
	<strInterface_Button5_Styling>#ff0000,#000000,Calibri,12,URL</strInterface_Button5_Styling>
	<strInterface_Button5_Layout>1LargeDisplay</strInterface_Button5_Layout>
	<strInterface_Button5_FunctionType>App</strInterface_Button5_FunctionType>
	<strInterface_Button5_APICall>https://ww3.allnone.ie/client/client_allnone/cti/userAPP_Main.asp</strInterface_Button5_APICall>
	<strInterface_Button5_Config>List-Hamsters</strInterface_Button5_Config>
	<strInterface_Button5_URL></strInterface_Button5_URL>
	<strInterface_Button5_Parameters></strInterface_Button5_Parameters>
	<strInterface_Button6_Title>Website</strInterface_Button6_Title>
	<strInterface_Button6_Styling>#ff0000,#000000,Calibri,12,URL</strInterface_Button6_Styling>
	<strInterface_Button6_Layout>Redirect</strInterface_Button6_Layout>
	<strInterface_Button6_FunctionType>Redirect</strInterface_Button6_FunctionType>
	<strInterface_Button6_APICall></strInterface_Button6_APICall>
	<strInterface_Button6_Config></strInterface_Button6_Config>
	<strInterface_Button6_URL>http://www.bxpsoftware.com</strInterface_Button6_URL>
	<strInterface_Button6_Parameters></strInterface_Button6_Parameters>
	<strInterface_Button7_Title>Wixi</strInterface_Button7_Title>
	<strInterface_Button7_Styling>#ff0000,#000000,Calibri,12,URL</strInterface_Button7_Styling>
	<strInterface_Button7_Layout>Redirect</strInterface_Button7_Layout>
	<strInterface_Button7_FunctionType>Redirect</strInterface_Button7_FunctionType>
	<strInterface_Button7_APICall></strInterface_Button7_APICall>
	<strInterface_Button7_Config></strInterface_Button7_Config>
	<strInterface_Button7_URL>http://www.bxpsoftware.com/wixi</strInterface_Button7_URL>
	<strInterface_Button7_Parameters></strInterface_Button7_Parameters>
	<strInterface_Button8_Title>System</strInterface_Button8_Title>
	<strInterface_Button8_Styling>#ff0000,#000000,Calibri,12,URL</strInterface_Button8_Styling>
	<strInterface_Button8_Layout>Redirect</strInterface_Button8_Layout>
	<strInterface_Button8_FunctionType>Redirect</strInterface_Button8_FunctionType>
	<strInterface_Button8_APICall></strInterface_Button8_APICall>
	<strInterface_Button8_Config></strInterface_Button8_Config>
	<strInterface_Button8_URL>https://ww3.allnone.ie/client/client_allnone/main/main.asp</strInterface_Button8_URL>
	<strInterface_Button8_Parameters>strInterface_LoginId,strInterface_LoginKey</strInterface_Button8_Parameters>
	<strInterface_Button9_Title>Settings</strInterface_Button9_Title>
	<strInterface_Button9_Styling>#ff0000,#000000,Calibri,12,URL</strInterface_Button9_Styling>
	<strInterface_Button9_Layout>Settings</strInterface_Button9_Layout>
	<strInterface_Button9_FunctionType>App</strInterface_Button9_FunctionType>
	<strInterface_Button9_APICall>https://ww3.allnone.ie/client/client_allnone/cti/userAPP_Main.asp</strInterface_Button9_APICall>
	<strInterface_Button9_Config>strInterface_LoginId,strInterface_LoginKey</strInterface_Button9_Config>
	<strInterface_Button9_URL></strInterface_Button9_URL>
	<strInterface_Button9_Parameters></strInterface_Button9_Parameters>
</data>


3 config function

Primary Function: Provide subsets of the APP settings for the bxp app.


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

  • strFunction:config_primary
  • strSystem:client_demo
  • intClient_Id:123
  • strClient_SessionField:asdfasdfasdf


It is possible to also limit the data returned to a specific button or just the primary settings.

Use

  • config_primary or
  • config_buttonX (replacing X with the button number) instead of settings.


e.g.

  • strFunction:config_button4
  • strSystem:client_demo
  • intClient_Id:123
  • strClient_SessionField:asdfasdfasdf