Icon API Reference

Elevate Web Builder uses a defined server request API for handling database operations between an application and the web server. Both the internal web server in the IDE and the included external Elevate Web Builder Web Server include support for this API. However, for other web servers the API support must be coded via a layer in the web server application, whether it is coded using PHP, Ruby, ASP.NET, or any other type of web server language or scripting environment. This reference will assist you in building such a layer in your web server application.

Elevate Web Builder uses three types of API calls for the database functionality:
  • DataSet columns

  • DataSet rows

  • Transactions
DataSet Columns
Dataset columns are requested from the web server using an HTTP GET request when the TDataSet LoadColumns method is called from the application. The GET request URL will have the following format:

<Database Resource Name>?method=columns&database=<Database Name>&dataset=<DataSet Name>[<Custom Parameters>]

where <Database Resource Name> is the base resource name for the database API (the default is 'databases'), <Database Name> is the name of the database, <DataSet Name> is the name of the dataset, and <Custom Parameters> are any additional custom parameters sent along with the base parameters. If the client application is using URL authentication parameters (the default is to use HTTP headers), then there may be additional user and password parameters/values included in the complete URL. Please see the Creating and Using Databases topic for more information on specifying the authentication method for database requests.

The response from a dataset columns request will indicate an HTTP status code of 200 (OK) along with the JSON column data as the included response content, or a non-200 error status code.

Please see the JSON Reference topic for more information on the structure of the JSON column data returned.

DataSet Rows
Dataset rows are requested from the web server using an HTTP GET request when the TDataSet LoadRows or the TDatabase LoadRows method is called from the application. The GET request URL will have the following format:

<Database Resource Name>?method=rows&database=<Database Name>&dataset=<DataSet Name>[<Custom Parameters>]

where <Database Resource Name> is the base resource name for the database API (the default is 'databases'), <Database Name> is the name of the database, <DataSet Name> is the name of the dataset, and <Custom Parameters> are any additional custom parameters sent along with the base parameters. If the client application is using URL authentication parameters (the default is to use HTTP headers), then there may be additional user and password parameters/values included in the complete URL. Please see the Creating and Using Databases topic for more information on specifying the authentication method for database requests.

The response from a dataset rows request will indicate an HTTP status code of 200 (OK) along with the JSON row data as the included response content, or a non-200 error status code.

Please see the JSON Reference topic for more information on the structure of the JSON row data returned.

Transactions
Transaction operations are sent to the web server using an HTTP POST request when the TDatabase Commit method is called from the application, and the current TransactionLevel is 0. The POST request URL will have the following format:

<Database Resource Name>?method=commit&database=<Database Name>[<Custom Parameters>]

where <Database Resource Name> is the base resource name for the database API (the default is 'databases'), <Database Name> is the name of the database, and <Custom Parameters> are any additional custom parameters sent along with the base parameters. If the client application is using URL authentication parameters (the default is to use HTTP headers), then there may be additional user and password parameters/values included in the complete URL. Please see the Creating and Using Databases topic for more information on specifying the authentication method for database requests.

The response from a database commit request will indicate an HTTP status code of 200 (OK) or a non-200 error status code.

Please see the JSON Reference topic for more information on the structure of the JSON transaction data that should be included in the request content.
Image