iFormBuilder Data

What's covered:

• What is the XML Data Feed?
• What is the JSON Data Feed?
• What are the different parameters?

What is the XML Data Feed?

XML Representation of your data that can be integrated with other backend Systems. XML stands for eXtensible Markup Language. It was designed to store and transport data and be both human-readable and machine-readable.

Click here for more information on the XML Data Feed.

What is the JSON Data Feed?

JavaScript Object Notation or JSON is an open-standard file format that uses human-readable text to transmit data objects consisting of attribute-value pairs and array data types. The JSON Data Feed is a representation of your data in this format.

Click here for more information on the JSON Data Feed.

What are the different parameters?

There are three different parameters that can be used together to generate different requests.

• TYPE
• SINCE_DATE
• SINCE_ID

Example: &TABLE_NAME=_data99999_data_feed_test&TYPE=TOP&SINCE_DATE=2011-01-10&SINCE_ID=221&USERNAME=XXXXXX&PASSWORD=XXXXXX

TYPE: The TYPE parameter controls what type of request you are sending to the server. 

DEEP: By default, your request is TYPE=DEEP which means that if you have a form that contains Subforms, the request is going to find all related Subform records and return them. To change the TYPE, you need to manually pass the parameter and the property into the URL.

TOP: When you pass the TOP property in the URL, the request will only return the data for the table you are running the request on. No Subform records will be returned.

ID: Passing the ID property will only return the record ID’s. This option is effective for complex data structures and identifies the records that need to be fetched. Knowing the records that are new, you can now grab each record one at a time. See notes below.

SINCE-DATE: This parameter accepts a value of “yyyy-mm-dd” and will return records that have a CREATED_DATE greater than the date you specify in the URL.

Example: SINCE_DATE=2011-01-01(Records that were created on or after 2011-01-02 will be returned.)

SINCE-ID: Similar to SINCE_DATE, this parameter accepts a numerical value and returns records that have an ID greater than the one specified.

Example: SINCE_ID=250 (Records starting from 251 and up will be returned.)

PLEASE NOTE: If you try to generate a request that takes longer than 3 minutes the request will be terminated. Please make good use of filters and leverage the different parameters for the XML and JSON feeds as described above.