SEED-platform / seed

Standard Energy Efficiency Data (SEED) Platform™ is a web-based application that helps organizations easily manage data on the energy performance of large groups of buildings.
Other
106 stars 55 forks source link

Create public feed endpoints #4685

Closed perryr16 closed 2 days ago

perryr16 commented 1 month ago

Any background context you want to provide?

Chula Vista has requested a public feed endpoint

What's this PR do?

Exposes a new public feed endpoint for JSON and HTML.

    Returns all property and taxlot state data for a given organization as a json object. The results are ordered by "state.update".

    Optional and configurable url query_params:
    :query_param labels: comma separated list of case sensitive label names. Results will include inventory that has any of the listed labels. Default is all inventory
    :query_param cycles: comma separated list of cycle ids. Results include inventory from the listed cycles. Default is all cycles
    :query_param properties: boolean to return properties. Default is True
    :query_param taxlots: boolan to return taxlots. Default is True
    :query_param page: integer page number
    :query_param per_page: integer results per page

    Example requests:
    {seed_url}/api/v3/public/organizations/feed.json?{query_param1}={value1}&{query_param2}={value2}
    dev1.seed-platform.org/api/v3/public/organizations/1/feed.json
    dev1.seed-platform.org/api/v3/public/organizations/1/feed.json?page=2&labels=Compliant&cycles=1,2,3&taxlots=False 

How should this be manually tested?

Go to {seed_url}/api/v3/public/organizations/{org_id}/feed.json?{query_param1}={value1}&{query_param2}={value2}. Go to {seed_url}/api/v3/public/organizations/{org_id}/feed.html?{query_param1}={value1}&{query_param2}={value2}. The page will be populated depending on the value of the organization setting public_feed_enabled

What are the relevant tickets?

4513

Screenshots (if appropriate)

Screenshot 2024-04-26 at 3 04 20 PM

Screenshot 2024-04-26 at 3 05 26 PM

Screenshot 2024-04-26 at 3 03 44 PM