GRESB / api-docs

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

Add a section on location validation #159

Open joeyhorst opened 7 months ago

joeyhorst commented 7 months ago

Geolocation validation on [country, state_province, city]. Given the CRREM decarbonization pathways will be more granular in 2024 - a valid city allocation is required. As such, an invalid combination of these fields will return a validation error till the combination returns a valid (city) location.

We don't have a section yet to address multi-field validation. We should however inform the user that a validation error can be returned for these fields. Given how we return errors per field, the error will be returned on all 3 fields. This has to be shown in an example.

The best place to do so is probably https://github.com/GRESB/api-docs/blob/master/source/includes/_assets.md#post-entitiesentity_idassets.