GRESB / api-docs

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

Move energy ratings to annual data in the data dictionary #67

Closed joeyhorst closed 4 years ago

joeyhorst commented 4 years ago

Currently we say that the energy_ratings are send in similar fashion as certifications. Unfortunately, we collect this is in annual_data. We should migrate this at some point to make the behaviour similar to certifications, but for now make sure the api-docs reflects the current state:

          :annual_data => [
            [0] {
                 :energy_rating_size => 5000,
                   :energy_rating_id => 1212
            }

image

joeyhorst commented 4 years ago

@emmastorm @gresbtim I'll reach out to Data Partners today to propose to move the energy ratings to the asset and take them out of the yearly data. We will have to see if such a change at this point is feasible. This will mean the following change, correct @gresbtim ?

As such the energy ratings will have the same behaviour as the certifications being:

        "energy_ratings": [
          {
            "energy_rating_id": 901,
            "size": "415.7"          
          }
        ]

Where the response will be:

        "energy_ratings": [
          {
            "id": 5913
            "energy_rating_id": 901,
            "size": "415.7"          
          }
        ]

This will mean that energy_rating_size will be size.

joeyhorst commented 4 years ago

Change is made and can be seen in https://gresb.github.io/api-docs/#data-dictionary