Formatting Scripts

Formatting Scripts are completely optional, and are used to inject code either before your API request is processed or after the results are returned based on the format of output requested by the user.

Pre-execution formatting scripts usually set up the request to include extra parameters that control the style of the output (for example, adding a 'format' parameter to the request).

Pre-execution scripts are installed into the function directory and named pre_format.php (for example, pre_xml.php would be the pre-execution script for XML output).

Post-execution formatting scripts usually take the native format of output (for example, JSON) and convert it into other formats, such as CSV or XML.

These scripts are installed into the function director and named format.php (for example, xml.php would be the post-execution script for XML output).