• OVERVIEW:
• ·Method·
• ·Format·
• ·CORS·
• ·Listing·
• ·Searching·
• ·Viewing·
• ·Auto-Complete·

Method

All interaction with this API should be performed using the GET HTTP method.

All users are considered anonymous and so are not authenticated.

Format

The response format for each subroutine can be specified using the form GET parameter.

JSON (Default)

Each listing, searching, viewing and auto-complete subroutine responds in JSON format, unless another supported format is explicitly specified.

JSON responses for listing and searching subroutines are paginated. Pages can be specified using the page GET parameter.

An example is to append ?...page=4... to the query string for any of the listing links, to load the fourth page of listings for that link.

For any paginated subroutine:

• If the page parameter is missing, not a number or less than zero, then the first page is automatically loaded
• If the page parameter exceeds the number of pages, then the last page is automatically loaded

CSV

Select subroutines optionally offer responses in CSV format.

A response in CSV format can be specified with ?...form=csv...

CSV responses are never paginated, and return a maximum of 10000 rows, excluding the column headings. If any error is encountered, responses will always be in JSON format.

Cross-Origin Resource Sharing

Cross-origin resource sharing (CORS) is accomplished via a whitelist of allowed hostnames.

If you wish your domain to be included in the whitelist, please contact AERC.

Listing

Paginated listings can be retrieved for the following:

• Manufacturers https://www.aerccpd.org/public/api/list/manufacturers
• Product Lines https://www.aerccpd.org/public/api/list/product-lines
• AERC Product Categories https://www.aerccpd.org/public/api/list/aerc-product-categories
• Product Types https://www.aerccpd.org/public/api/list/product-types
• Product Positions https://www.aerccpd.org/public/api/list/product-positions
• Baseline Windows https://www.aerccpd.org/public/api/list/windows

When requested with the help GET parameter, each of the above links provides a helpful overview of the filter criteria that can be specified, along with its corresponding GET parameter.

Searching

Searches returning paginated results can be performed for the following:

• Manufacturers https://www.aerccpd.org/public/api/search/manufacturers
• Product Lines https://www.aerccpd.org/public/api/search/product-lines
• Products https://www.aerccpd.org/public/api/search/products

When requested without parameters, each of the above links provides a helpful overview of the search criteria that can be specified, along with its corresponding GET parameter.

Viewing

Individual pieces of data can be requested for viewing with one of two detail levels using the data GET parameter:

1. Simple is the default if this parameter is omitted, and provides all essential information. It can be specified with ?...data=s...
2. Verbose provides everything in simple, as well as additional details. It can be specified with ?...data=v...

Individual pieces of data can be viewed for the following:

• Manufacturers https://www.aerccpd.org/public/api/view/manufacturer
• Product Lines https://www.aerccpd.org/public/api/view/product-line
• Products https://www.aerccpd.org/public/api/view/product

When requested without parameters, each of the above links provides a helpful overview of the identifier that can be specified, along with its corresponding GET parameter.

Auto-Complete

Auto-complete can be performed for the following, returning at most 5 results:

• Product free-text https://www.aerccpd.org/public/api/auto-complete/products

When requested without parameters, each of the above links provides a helpful overview of the auto-complete criteria that can be specified, along with its corresponding GET parameter.