verify if all request examples still work in the api-docs

[joeyhorst]

as the title mentioned, we should run though the examples and make sure they are all valid

[naincygoyal]

@joeyhorst I will test following request

1. ASSET:

• [ ] POST Request to create single asset - Need to update in API Docs.
  Sample Request Body

  { "country": "NL", "state_province": "North-Holland", "city": "Amsterdam", "address": "Barbara Strozzilaan", "construction_year": 2019, "asset_ownership": 100, "asset_size": 21, "certifications": [ { "certification_id": 585, "size": 11 }, { "certification_id": 895, "size":10 } ], "annual_data": [ { "year": 2021, "asset_gav":1, "asset_revenue":"abc", "asset_ownership":100, "property_type_code": "OTSS", "asset_name": "APITest", "owned_entire_period":true, "ncmr_status": "Standing Investment", "tenant_ctrl":true, "asset_vacancy": 10, "was_pcov": 0, "wat_tot_w": 21, "en_tot_wf": 21, "en_tot_wd": 2, "en_tot_we": 2, "ghg_tot_s3_w": 21, "was_pabs_lf":0, "was_pabs_in":0, "was_pabs_ru": 0, "was_pabs_wte": 0, "was_pabs_rec": 0, "was_pabs_oth": 0, "was_data_from": "2021-12-04", "was_data_to": "2021-12-24", "was_abs_haz": 0, "was_abs_nhaz": 0 }, { "year": 2020, "asset_gav":1, "asset_ownership":100, "asset_revenue":0, "property_type_code": "OTSS", "asset_name": "APITest", "owned_entire_period":true, "ncmr_status": "Standing Investment", "tenant_ctrl":true, "asset_vacancy": 10, "was_pcov": 0, "wat_tot_w": 21, "en_tot_wf": 21, "en_tot_wd": 2, "en_tot_we": 2, "ghg_tot_s3_w": 21, "was_pabs_lf":0, "was_pabs_in":0, "was_pabs_ru": 0, "was_pabs_wte": 0, "was_pabs_rec": 0, "was_pabs_oth": 0, "was_data_from": "2020-12-04", "was_data_to": "2020-12-24", "was_abs_haz": 0, "was_abs_nhaz": 0 } ] }

• [ ] GET Request to retrieve single asset. - Need to update Response in API Docs "asset_gav" and "owned_entire_period" are missing in Response Body besides getting "asset_size" in main data as well (before annual data)

  Sample Response Body

  { "gresb_asset_id": 357185, "country": "NL", "state_province": "North-Holland", "city": "Amsterdam", "address": "Barbara Strozzilaan", "lat": 52.3361502, "lng": 4.8852622, "partners_id": null, "construction_year": 2019, "asset_ownership": "100.0", "certifications": [ { "id": 10361, "certification_id": 585, "name": "ABINC Certification/Urban Development and Shopping Centre", "level": null, "size": 11, "_validations": { "errors": {} } }, { "id": 10362, "certification_id": 895, "name": "Austin Energy/Austin Energy Green Building", "level": null, "size": 10, "_validations": { "errors": {} } } ], "asset_size": "21.0", "annual_data": [ { "year": 2021, "asset_size": 21, "asset_gav": 1, "asset_name": "APITest", "asset_vacancy": 10, "en_tot_wd": 2, "en_tot_we": 2, "en_tot_wf": 21, "ghg_tot_s3_w": 21, "ncmr_status": "Standing Investment", "owned_entire_period": true, "property_type_code": "OTSS", "tenant_ctrl": true, "was_abs_haz": 0, "was_abs_nhaz": 0, "was_data_from": "2021-12-04", "was_data_to": "2021-12-24", "was_pabs_in": 0, "was_pabs_lf": 0, "was_pabs_oth": 0, "was_pabs_rec": 0, "was_pabs_ru": 0, "was_pabs_wte": 0, "was_pcov": 0, "wat_tot_w": 21, "whole_building": true }, { "year": 2020, "asset_size": 21, "asset_gav": 1, "asset_name": "APITest", "asset_vacancy": 10, "en_tot_wd": 2, "en_tot_we": 2, "en_tot_wf": 21, "ghg_tot_s3_w": 21, "ncmr_status": "Standing Investment", "owned_entire_period": true, "property_type_code": "OTSS", "tenant_ctrl": true, "was_abs_haz": 0, "was_abs_nhaz": 0, "was_data_from": "2020-12-04", "was_data_to": "2020-12-24", "was_pabs_in": 0, "was_pabs_lf": 0, "was_pabs_oth": 0, "was_pabs_rec": 0, "was_pabs_ru": 0, "was_pabs_wte": 0, "was_pcov": 0, "wat_tot_w": 21, "whole_building": true } ], "_outliers": [], "created_at": "2022-03-03T13:56:20.423Z", "updated_at": "2022-03-03T13:56:20.499Z" }

• [x] Patch request to update single asset - Need to update in API Docs

  Sample Response Body

  { "gresb_asset_id": 357185, "country": "NL", "state_province": "North-Holland", "city": "Amsterdam", "address": "Barbara Strozzilaan", "lat": 52.3361502, "lng": 4.8852622, "partners_id": null, "construction_year": 2019, "asset_ownership": "100.0", "certifications": [ { "id": 10361, "certification_id": 585, "name": "ABINC Certification/Urban Development and Shopping Centre", "level": null, "size": 11, "_validations": { "errors": {} } }, { "id": 10362, "certification_id": 895, "name": "Austin Energy/Austin Energy Green Building", "level": null, "size": 10, "_validations": { "errors": {} } } ], "asset_size": "21.0", "annual_data": [ { "year": 2021, "asset_size": 21, "asset_gav": 1, "asset_name": "APITest", "asset_vacancy": 10, "en_tot_wd": 2, "en_tot_we": 2, "en_tot_wf": 21, "ghg_tot_s3_w": 21, "ncmr_status": "Standing Investment", "owned_entire_period": true, "property_type_code": "OTSS", "tenant_ctrl": true, "was_abs_haz": 0, "was_abs_nhaz": 0, "was_data_from": "2021-12-04", "was_data_to": "2021-12-24", "was_pabs_in": 0, "was_pabs_lf": 0, "was_pabs_oth": 0, "was_pabs_rec": 0, "was_pabs_ru": 0, "was_pabs_wte": 0, "was_pcov": 0, "wat_tot_w": 21, "whole_building": true, "_validations": { "errors": {} } }, { "year": 2020, "asset_size": 21, "asset_gav": 1, "asset_name": "APITest", "asset_vacancy": 10, "en_tot_wd": 2, "en_tot_we": 2, "en_tot_wf": 21, "ghg_tot_s3_w": 21, "ncmr_status": "Standing Investment", "owned_entire_period": true, "property_type_code": "OTSS", "tenant_ctrl": true, "was_abs_haz": 0, "was_abs_nhaz": 0, "was_data_from": "2020-12-04", "was_data_to": "2020-12-24", "was_pabs_in": 0, "was_pabs_lf": 0, "was_pabs_oth": 0, "was_pabs_rec": 0, "was_pabs_ru": 0, "was_pabs_wte": 0, "was_pcov": 0, "wat_tot_w": 21, "whole_building": true, "_validations": { "errors": {} } } ], "_outliers": [], "created_at": "2022-03-03T13:56:20.423Z", "updated_at": "2022-03-03T13:56:20.499Z", "_validations": { "errors": {} } }

• [x] Delete request to delete an asset - Not getting matched with API Docs , currently not getting annual data in response

  Sample Response Body

  { "gresb_asset_id": 833335, "country": "CD", "state_province": "flevoland", "city": "franekeradeel", "address": "ABC", "lat": null, "lng": null, "partners_id": null, "construction_year": null, "asset_ownership": null, "certifications": [], "asset_size": "21.0", "annual_data": [], "_outliers": [], "created_at": "2022-02-24T12:30:56.650Z", "updated_at": "2022-02-24T14:00:36.124Z" }

• [x] Get Request to retrieve an asset in batch

• [ ] 🔴 Delete request to delete an asset in batch ("delete") - It seems this is not working fine with given example in api docs.

  Sample Request Body

  {

"delete": [ { "gresb_asset_id": 833336 }, { "gresb_asset_id": 833337 } ] }

**Response Screenshot**


• [ ] 🔴 PATCH Request to update an asset in batch ( "always_update") - Its not working with given example in API docs

Sample Request Body

{ "always_update": [ { "gresb_asset_id": 833337, "annual_data": [ { "year": 2021, "property_type_code": "OCHI" } ] },{ "gresb_asset_id": 833338, "annual_data": [ { "year": 2021, "property_type_code": "OCHI" } ] } ] }

Sample Response Body


However , these are the assets which I created new.

---

2. ENTITY

• [x] GET Request to retrieve all the entites - No modification require in API Docs.

• [x] GET Request to retrieve with specific entity id - No modification require in API Docs.

3. ENERGY RATINGS

• [x] GET Request to retrieve all the energy ratings - No Modification require in API Docs.

4. CERTIFICATION

• [x] GET Request to retrieve all the certification - No Modification require in API Docs.

5. USER
   • [x] GET Request to retrieve all the authenticated users - No Modification require in API Docs.

[joeyhorst]

@naincygoyal believe we need to cover all code blobs on the right hand side of the api-docs - such as http://gresb.github.io/api-docs/#users, etc. This also includes simple GET requests.

[naincygoyal]

Yes @joeyhorst even Certification and Energy need to add ...I will first finish asset then will pick user, energy , certification etc and will update in the same list.

[naincygoyal]

@joeyhorst https://github.com/GRESB/api-docs/issues/88#issuecomment-1049779332 in this comment I mentioned PATCH and DELETE in batch is not working , could you please once and confirm why its not working ?

[joeyhorst]

@naincygoyal The batch operation contains objects like "always_update" and "delete" to perform PATCH and DELETE methods.

As such you will need to do this within the batch operation and not as a method.

The HTTPS method to use is POST.

[joeyhorst]

closing this as it is already in master but still needs to be published