AJAX - API - Revision history

Thomas Glennon: /* Configuration */

2022-10-20T15:06:17Z

‎Configuration

Thomas Glennon: /* User Account Configuration */

2022-10-20T14:55:08Z

‎User Account Configuration

Thomas Glennon: /* Form Configuration */

2022-10-20T14:50:39Z

‎Form Configuration

Thomas Glennon: /* fn_bxp_API_FormDataInsertUpdate( ) */

2022-10-20T14:49:56Z

‎fn_bxp_API_FormDataInsertUpdate( )

Thomas Glennon at 12:31, 20 October 2022

2022-10-20T12:31:36Z

Thomas Glennon: /* Configuration */

2022-10-19T19:53:03Z

‎Configuration

Thomas Glennon: /* Form Configuration */

2022-10-19T19:52:03Z

‎Form Configuration

Thomas Glennon: /* Configuration */

2022-10-19T19:51:18Z

‎Configuration

Thomas Glennon: /* Configuration */

2022-10-19T19:48:19Z

‎Configuration

Thomas Glennon: /* Configuration */

2022-10-19T19:45:29Z

‎Configuration

← Older revision		Revision as of 15:06, 20 October 2022
Line 37:		Line 37:

	'''External System Key: '''Must be set. We strongly advise using a secure, generated key with both uppercase, lowercase and numerical characters.		'''External System Key: '''Must be set. We strongly advise using a secure, generated key with both uppercase, lowercase and numerical characters.
		+
		+
		+	====Form Access Permissions====
		+	Whether authenticating using the the current BXP user's session or by supplying a specific accounts security credentials, the API will reject any attempts to query or update a Form if the user account being used does not have access permissions to it.
		+
		+	See our article on [[Form - Security Access\|form access]] for more information on how to manage form access permissions for user accounts. As with form configuration, you will need both Form Edit permissions for the target BXP system as well as access to the specific form(s) you wish to use. Otherwise, request assistance from an administrator of the target BXP system.

	==Functions==		==Functions==

@@ Line 26: / Line 26: @@
 ====User Account Configuration====
-If you are attempting to use this library on a page built inside of BXP(such as keystat or form) you can simply use the DataX option when executing an API call to authenticate using the current users login credentials.
+If you are attempting to use this library on a page built inside of BXP(such as keystat or form) you can use the DataX option when executing an API call to authenticate using the current users login credentials.
-If however you are using the API from a page external to BXP, you must use the security credentials for a valid, active account in the target BXP system. By default BXP user accounts do not have external security credentials defined, so they may need to be set up for the account you wish to use. As with form configuration, you will need to either have User Account Edit permissions in BXP, or request that an admin for the target system assist you.
+If however you are using the API from a page external to BXP or if you want all of your interactions to be performed by a specific user account, you must supply the security credentials for a valid, active account in the target BXP system. By default BXP user accounts do not have external security credentials defined, so they may need to be set up for the account you wish to use. As with form configuration, you will need to either have User Account Edit permissions in BXP, or request that an admin for the target system assist you.
-To check the security credentials for a BXP account, open the account for editing and then open the Primary Security Details tab. Both the External System ID and External System Key fields must be set in order for the account to be able to authentic through the API.
+To check the security credentials for a BXP account, open the account for editing and then open the Primary Security Details tab. Both the External System ID and External System Key fields must be set in order for the account to be able to authenticate through the API.
 [[File:ExternalSettings2.jpg|800px]]

@@ Line 15: / Line 15: @@
 ==Configuration==
 ====Form Configuration====
-When attempting to utilize this library you will need to first configure the from or forms you intend to try and interact with to ensure they are publicly accessible. To do this you will either need to have Form Edit permissions for the target BXP system, as well as access to the specific form(s) you wish to use. If you do not have these permissions, ask a system administrator for assistance with this task.
+When attempting to utilize this library you will need to first configure the from or forms you intend to try and interact with to ensure they are publicly accessible. To do this you will need to have Form Edit permissions for the target BXP system, as well as access to the specific form(s) you wish to use. If you do not have these permissions, ask a system administrator for assistance with this task.
 Open the Advanced Settings for the form(s) you need to interact with through the API and select the External tab. Here you will find the settings for Externally Available and Public Outcome.

@@ Line 162: / Line 162: @@
   strFieldsToUpdate = <span style="color: #ff99cc;">'</span><span style="color: #99ccff;">&intCDA_161_Id=100</span><span style="color: #ff99cc;">&strCDA_161_Status="Application form completed"&strCDA_161_field_0_0="' + document.getElementById('FieldA').value + '"&strCDA_161_field_0_1="' + document.getElementById('FieldB').value + '"&strCDA_161_field_0_12="' + document.getElementById('FieldC').value + '"&strCDA_161_field_0_13="' + document.getElementById('FieldD').value + '"'
   <span style="color: #000000;">strFieldsToInsert =</span> <span style="color: #993366;">'</span><span style="color: #ff99cc;"><span style="color: #993366;">&strCDA_161_Status="Application form completed"&strCDA_161_field_0_0="' + document.getElementById('FieldA').value + '"&strCDA_161_field_0_1="' + document.getElementById('FieldB').value + '"&strCDA_161_field_0_12="' + document.getElementById('FieldC').value + '"&strCDA_161_field_0_13="' + document.getElementById('FieldD').value + '"'</span>
-  </span></span>fn_bxp_API_FormDataInsertUpdate(true, '<span style="color: #ffcc00;">client_example</span>', '<span style="color: #cc99ff;">API_Application_Form</span>', '<span style="color: #cc99ff;">__29dhtbfji__29dhtbfji__29dhtbfji</span>', <span style="color: #cc99ff;">false</span>, '<span style="color: #ff00ff;">161</span>', strFieldsToUpdate, '<span style="color: #ff0000;">strApiUpdateResult</span>', 'console.log(\'API Insert start\')', '<span style="color: #339966;">console.log(\'API Insert Success: \' + strApiInsertResult);fn_AfterSubmit();</span>', '<span style="color: #3366ff;">console.log(\'API Update Fail: \' + strApiInsertResult)</span>');
+  </span></span>fn_bxp_API_FormDataInsertUpdate(true, '<span style="color: #ffcc00;">client_example</span>', '<span style="color: #cc99ff;">API_Example</span>', '<span style="color: #cc99ff;"><span style="background-color: #ffddcc;">__123456789!!</span></span>', <span style="color: #cc99ff;">false</span>, '<span style="color: #ff00ff;">161</span>', strFieldsToUpdate, '<span style="color: #ff0000;">strApiUpdateResult</span>', 'console.log(\'API Insert start\')', '<span style="color: #339966;">console.log(\'API Insert Success: \' + strApiInsertResult);fn_AfterSubmit();</span>', '<span style="color: #3366ff;">console.log(\'API Update Fail: \' + strApiInsertResult)</span>');
-In this example the API will attempt to update <span style="color: #ff00ff;">Form 161</span> from the <span style="color: #ffcc00;">client_example</span> system. <span style="color: #cc99ff;">The function will attempt to use the the ID and Key for API_Application_Form to authenticate</span>.
+In this example the API will attempt to update <span style="color: #ff00ff;">Form 161</span> from the <span style="color: #ffcc00;">client_example</span> system. <span style="color: #cc99ff;">The function will attempt to use the the ID and Key for API_Example to authenticate</span>.
 <span style="color: #ff99cc;"><span style="color: #000000;">The update will</span> set the Status to "Application form completed" and the values of fields 0,1,12 and 13 to the values of page elements FieldA through FieldD respectively</span> <span style="color: #99ccff;">for record ID 100. <span style="color: #000000;">Alternatively, if the variable</span> <span style="color: #993366;">strFieldsToInsert</span> <span style="color: #000000;">were used instead of strFieldsToUpdate,</span> <span style="color: #993366;">a new record with the same values as above would be inserted into the form instead.</span></span>
 <span style="color: #ff99cc;"><span style="color: #000000;">The results of the update will be stored in the global variable</span><span style="color: #ff99cc;"> </span><span style="color: #ff6600;">strApiUpdateResult</span><span style="color: #ff6600;">, <span style="color: #339966;">"API Update Success will be printed to the console"</span><span style="color: #ff6600;"> </span><span style="color: #000000;">and the function <span style="color: #00ff00;"><span style="color: #339966;">fn_AfterSubmit()</span> </span>will run after a successful result is returned, <span style="color: #3366ff;">otherwise, "API Update Fail" will be printed to the console</span>.</span></span></span>
 ====fn_bxp_API_eCourseSearch( )====

@@ Line 173: / Line 173: @@
 ====fn_bxp_API_eCourseSearch( )====
-This function is used to query BXP eCourses and store them a specified global variable for further processing.
+This function is used to query BXP eCourse books for a list of their pages. URLs to each page are returned in the result as opposed to the actual page content itself.
@@ Line 193: / Line 193: @@
 '''blAPI_DataX:''' Can only be used on pages that are built in BXP, such as forms or custom reports. Can be set to true or false. If set to true, the API will attempt to authenticate with the server using the login credentials of whoever is currently logged into the system. strAPI_Account and strAPI_Key should be left blank if this is set to true.
-'''inteCourse_Ids''': ID of the ecourse you want to retrieve.
+'''inteCourse_Ids''': IDs of the eCourse books you want to retrieve pages from. Takes a string in the form of comma separated whole numbers. For example, "1,12,15" will return all pages from the eCourse Books with IDs 1, 12 and 15(provided the total number of pages does not exceed strCountLimit).
-'''strCountLimit: '''Limit to apply to the query, will cap the number of results brought back by the query to the number supplied. Takes an integer value.
+'''strCountLimit: '''Limit to apply to the query, will cap the number of pages retrieved. Takes an integer value. For example, if we are retrieving pages from books 1,12 and 15 as in the example above, but we have a cap of 10, only the first 10 pages will be returned. This is for the overall query and not per book, meaning that if book 1 has 9 pages, book 12 has 1 and book 15 has 3, we will receive all pages from books 1 and 12, but none from 15.
-'''strVariableToPopulate:''' Variable in which the results of the update will be stored, takes a variable name as a string. Variable must be global(defined outside of any functions in your script). If attempting to insert a new record, this will return the ID of the new record if the insert was successful, otherwise it will return 0 or a negative value.
+'''strVariableToPopulate:''' Variable in which the results of the query will be stored, takes a variable name as a string. Variable must be global(defined outside of any functions in your script).
 '''strFunctionOnStart:''' Code that will execute when the AJAX insert/update is launched, can be left blank.
@@ Line 204: / Line 204: @@
 '''strFunctionOnFail:''' Code that will execute when the AJAX insert/update fails, can be left blank.

@@ Line 32: / Line 32: @@
 To check the security credentials for a BXP account, open the account for editing and then open the Primary Security Details tab. Both the External System ID and External System Key fields must be set in order for the account to be able to authentic through the API.
-[[File:|https://www.bxpsoftware.com/wixi/index.phpFile:ExternalSettings2.jpg]]
+[[File:ExternalSettings2.jpg|800px]]
 '''External System ID: '''Must be set and must be unique to each user account.

@@ Line 19: / Line 19: @@
 Open the Advanced Settings for the form(s) you need to interact with through the API and select the External tab. Here you will find the settings for Externally Available and Public Outcome.
-[[File:https://www.bxpsoftware.com/wixi/index.phpFile:ExternalSettings1.jpg|800px]]
+[[File:ExternalSettings1.jpg|800px]]
 '''Externally Available''' controls whether a form/database is available for use through the API. By default all newly created forms have this set to Private and are not accessible outside of BXP, this value must be set to Public in order for any API calls against this form to be successful.
 '''Public Outcome''' sets the default outcome to be used when a record is submitted through the API. This can be overwritten by manually specifying an outcome in your insert/update function call.
 ====User Account Configuration====