# Quote Requests API Documentation This is documentation for how to retrieve form data submissions from the application storage service. ## Authentication All requests to the api service requre HTTP Basic authentication in the headers. ## Permissions All requests need to be sent from an authenticated user that is in the permissions group **`API-Access`**. This permission group can be granted to a user in the [dashboard](/secure/permissions/group). ## Formats The stored requests are available in the following file extensions. ### Available formats: - html - csv - xml - json ### Available form types: - request-a-quote - service-request ## Features You can switch the following features on and off by modifying the **`GET`** query parameters | Parameter | Example | Action | |-----------|---------|--------| |download| &download=true | The download switch is available for csv and xml outputs. This will generate headers requesting that the browser download the results as saved file instead of display in the browser window. The defaults are download = true for csv and download = false for xml.| | mark | &mark=true | If set, this will mark all returned results as read. The default is mark = false for all requests. | | all | &all=true | If set, this will return all available data, both read and unread. The default is all = false for all requests. | | start | &start=01-01-2018T00:00:00 | If set, this will return all results after the requested start date. **Dates must be ISO8601 compliant**| | end | &end=01-01-2018T00:00:00 | If set, this will return all results before the requested end date. **Dates must be ISO8601 compliant** | | headers | &headers=true | If set, this will show/hide the header rows on CSV files. Default is headers = true for all csv requests. | ## Example Usage Below are some example usages of the API. Examples will open in a new tab for you to inspect the URL path. | URL | Description | |-----|-------------| | [https://www.dorma-hueppe.com/api/forms/request-a-quote.html?all=true](https://www.dorma-hueppe.com/api/forms/request-a-quote.html?all=true) | View all results in an HTML table format in the browser. | | [https://www.dorma-hueppe.com/api/forms/request-a-quote.csv?all=true](https://www.dorma-hueppe.com/api/forms/request-a-quote.csv?all=true) | Download all results as a CSV file for opening in Excel or processing. | | [https://www.dorma-hueppe.com/api/forms/request-a-quote.xml?all=true](https://www.dorma-hueppe.com/api/forms/request-a-quote.xml?all=true) | View all results as an XML document in the browser. | | [https://www.dorma-hueppe.com/api/forms/request-a-quote.json?all=true](https://www.dorma-hueppe.com/api/forms/request-a-quote.json?all=true) | View all results as a json document in the browser. |