GRESB / api-docs

http://gresb.github.io/api-docs/
3 stars 0 forks source link

Add a section on the variable whitelist #144

Closed joeyhorst closed 1 year ago

joeyhorst commented 1 year ago

API users face the error "error": "Variable could not be found."

Which is caused by the whitelisted variables.

In the Excel where we share the variables (http://gresb.github.io/api-docs/#portfolio-data) we use base patterns for table answers. It is therefore a common misconception that those base patterns are editable. The same goes for the indicator scores such as SCORE_LE_4.

As such write a section to clarify the behavior of whitelisting - adding 20230330_portfolio-api-endpoint-variable-whitelist.xlsx to the docs.

Do consider that this has to be updated on a yearly base.