Developer Network NREL NREL Developer Network

Commercial Building Resources (GET /api/commercial-building-resources/v1/resources)

A searchable and filterable list of resources.

Request URL

GET /api/commercial-building-resources/resources.format?parameters

Request Parameters

Parameter Required Value Description
format Yes
Type: string
Default: None
Options: json, xml

The output response format.

api_key Yes
Type: string
Default: None

Your developer API key. See API keys for more information.

s No
Type: string
Default: None

A string to search resources on.

audience-type No
Type: string
Default: None

A term from the Audience Type vocabulary to filter results on.

building-type No
Type: string
Default: None

A term from the Building Type vocabulary to filter results on.

collection No
Type: string
Default: None

A term from the Collection vocabulary to filter results on.

construction-type No
Type: string
Default: None

A term from the Contruction Type vocabulary to filter results on.

institution No
Type: string
Default: None

A term from the Institution vocabulary to filter results on.

keyword No
Type: string
Default: None

A term from the Keyword vocabulary to filter results on.

portal No
Type: string
Default: None

A term from the Portal vocabulary to filter results on.

publication-type No
Type: string
Default: None

A term from Publication Type vocabulary to filter results on.

resource-type No
Type: string
Default: None

A term from the Resouce Type vocabulary to filter results on.

state No
Type: string
Default: None

A term from the States vocabulary to filter results on.

tool-type No
Type: string
Default: None

A term from the Tool Types vocabulary to filter results on.

topic No
Type: string
Default: None

A term from Topic vocabulary to filter results on.

Response Fields

The top-level structure of response is different for JSON vs XML format requests. The XML format responds with a single array result of resource items. The JSON format responds with a hash. Each key in the JSON response hash is a nid value, and each value is a resource item. The fields for individual resource items are consistent for JSON and XML format, and described below. For more specfics, see Examples below.

Resource Response Fields

Field Value Description
vid
Type: integer

Version ID of resource. If a new version of the resouce is published, the vid will change while the nid is constant.

title
Type: string

Title text.

nid
Type: integer

Unique integer identifier for resource. This does not change when new versions are published (see vid).

type
Type: string

Content type of resource. Options: publication, tool, event, other-resource.

created
Type: integer

Timestamp when resource was created in Unix epoch time.

changed
Type: integer

Timestamp when resource was last updated in Unix epoch time.

rdf_mapping
Type: object

Resource Description Framework (RDF) metadata.

body
Type: array

Array of objects containing copy for resource. See Body Response Fields.

field_event_type
Type: object

Applicable only for Event content (see type). Array containing exactly one term. See Term Response Fields.

field_publication_type
Type: object

Applicable only for Publication content (see type). Array containing exactly one term. See Term Response Fields.

field_resource_type
Type: object

Applicable only for Other Resource content (see type). Array containing exactly one term. See Term Response Fields.

field_tool_type
Type: object

Applicable only for Tool content (see type). Array containing exactly one term. See Term Response Fields.

field_resource_type_superset
Type: object

Array containing exactly one term. This field is available for all content types (see type above) and will match the content in whichever of field_event_type, field_publication_type, field_resource_type, field_tool_type is applicable for the resouces. Also see Term Response Fields.

field_collections
Type: object

Array of terms in the Vocabulary. See Term Response Fields.

field_require_user_information
Type: Array

Whether user should be required to enter contact information before downloading resource.

field_publication_date
Type: Array

Date of publication with timezone. Only present on Publication resources (see type).

field_primary_institution
Type: object

Array of terms in the Vocabulary. See Term Response Fields.

field_secondary_institution
Type: object

Array of terms in the Vocabulary. See Term Response Fields.

field_display_author
Type: Array

Whether author name is intended for display. Only present on Publication resources (see type).

field_author
Type: Text

Name of author. Only present for Publication resources (see type).

field_topics
Type: object

Array of terms in the Vocabulary. See Term Response Fields.

field_construction_types
Type: object

Array of terms in the Vocabulary. See Term Response Fields.

field_building_types
Type: object

Array of terms in the Vocabulary. See Term Response Fields.

field_phases_of_delivery
Type: object

Array of terms in the Vocabulary. See Term Response Fields.

field_audience_types
Type: object

Array of terms in the Vocabulary. See Term Response Fields.

field_keywords
Type: object

Array of terms in the Vocabulary. See Term Response Fields.

field_resource_link
Type: string

Unique url for resource.

field_states
Type: Array

Array of terms in the Vocabulary. See Term Response Fields.

Body Response Fields

Field Value Description
value
Type: string

Text for resource body without html tags.

summary
Type: string

Text for resource summary without html tags.

safe_value
Type: string

Text for Resource body with escaped html tags.

safe_summary
Type: string

Text for Resource summary with escaped html tags.

Term Response Fields

Field Value Description
tid
Type: integer

Unique id of the vocabulary term.

Examples

JSON Output Format

GET /api/commercial-building-resources/v1/resources.json?portal=Energy%20Performance-Based%20Acquisition&api_key=DEMO_KEY
{
"718":{
  "vid":"782",
  "title":"BESTEST",
  "nid":"718",
  "type":"tool",
  "created":"1366984456",
  "changed":"1371062531",
  "rdf_mapping":{
    "rdftype":["sioc:Item","foaf:Document"],
    "title":{"predicates":["dc:title"]},
    "created":{"predicates":["dc:date","dc:created"],"datatype":"xsd:dateTime","callback":"date_iso8601"},
    "changed":{"predicates":["dc:modified"],"datatype":"xsd:dateTime","callback":"date_iso8601"},
    "body":{"predicates":["content:encoded"]},
    "uid":{"predicates":["sioc:has_creator"],"type":"rel"},
    "name":{"predicates":["foaf:name"]},
    "comment_count":{"predicates":["sioc:num_replies"],
    "datatype":"xsd:integer"},
    "last_activity":{"predicates":["sioc:last_activity_date"],
    "datatype":"xsd:dateTime",
    "callback":"date_iso8601"}},
  "current_revision_id":"782",
  "is_current":true,
  "is_pending":false,
  "body":{
    "und":[{
      "value":"Method for testing and diagnosing the simulation capabilities of the exterior envelope portions of building energy simulation programs. BESTEST (Building Energy Simulation TEST) evaluates design and analysis tools relative to their ability to adequately model the envelope dynamics of buildings. It has been adapted for certifying tools for Home Energy Rating Systems and by other organizations.",
    "summary":null,
    "format":null}]},
  "field_tool_type":{"und":[{"tid":"157"}]},
  "field_collections":[],
  "field_resource_link":{
    "und":[{
      "url":"http://apps1.eere.energy.gov/buildings/tools_directory/software.cfm/ID=85/",
      "title":null,"attributes":[]}]},
  "field_topics":{"und":[{"tid":"35"},{"tid":"29"}]},
  "field_states":[],
  "field_audience_types":[],
  "field_keywords":[],
  "field_building_types":{"und":[{"tid":"52"},{"tid":"53"},{"tid":"54"},{"tid":"55"},{"tid":"56"},{"tid":"59"},{"tid":"62"},{"tid":"61"},{"tid":"64"},{"tid":"66"},{"tid":"67"},{"tid":"68"},{"tid":"69"},{"tid":"73"},{"tid":"75"},{"tid":"72"},{"tid":"51"},{"tid":"57"},{"tid":"58"},{"tid":"74"},{"tid":"63"},{"tid":"70"},{"tid":"71"},{"tid":"60"},{"tid":"65"}]},
  "field_resource_type_superset":[]},
"1083":{...
}

XML Output Format

GET /api/commercial-building-resources/v1/resources.xml?portal=Energy%20Performance-Based%20Acquisition&api_key=DEMO_KEY
<?xml version="1.0" encoding="utf-8"?>
<result is_array="true">
  <item>
    <vid>782</vid>
    <title>BESTEST</title>
    <nid>718</nid>
    <type>tool</type>
    <created>1366984456</created>
    <changed>1371062531</changed>
    <rdf_mapping>
      <rdftype is_array="true">
        <item>sioc:Item</item>
        <item>foaf:Document</item>
      </rdftype>
      <title><predicates is_array="true"><item>dc:title</item></predicates></title>
      <created><predicates is_array="true"><item>dc:date</item><item>dc:created</item></predicates><datatype>xsd:dateTime</datatype><callback>date_iso8601</callback></created>
      <changed><predicates is_array="true"><item>dc:modified</item></predicates><datatype>xsd:dateTime</datatype><callback>date_iso8601</callback></changed>
      <body><predicates is_array="true"><item>content:encoded</item></predicates></body>
      <uid><predicates is_array="true"><item>sioc:has_creator</item></predicates><type>rel</type></uid>
      <name><predicates is_array="true"><item>foaf:name</item></predicates></name>
      <comment_count><predicates is_array="true"><item>sioc:num_replies</item></predicates><datatype>xsd:integer</datatype></comment_count>
      <last_activity><predicates is_array="true"><item>sioc:last_activity_date</item></predicates><datatype>xsd:dateTime</datatype><callback>date_iso8601</callback></last_activity>
    </rdf_mapping>
    <current_revision_id>782</current_revision_id>
    <is_current>1</is_current>
    <is_pending></is_pending>
    <body><und is_array="true"><item>
      <value>Method for testing and diagnosing the simulation capabilities of the exterior envelope portions of building energy simulation programs. BESTEST (Building Energy Simulation TEST) evaluates design and analysis tools relative to their ability to adequately model the envelope dynamics of buildings. It has been adapted for certifying tools for Home Energy Rating Systems and by other organizations.</value>
      <summary/>
      <format/>
    </item></und></body>
    <field_tool_type><und is_array="true"><item><tid>157</tid></item></und></field_tool_type>
    <field_collections/>
    <field_resource_link><und is_array="true"><item>
      <url>http://apps1.eere.energy.gov/buildings/tools_directory/software.cfm/ID=85/</url>
      <title/><attributes/></item></und></field_resource_link>
    <field_topics><und is_array="true"><item><tid>35</tid></item><item><tid>29</tid></item></und></field_topics>
    <field_states/>
    <field_audience_types/>
    <field_keywords/>
    <field_building_types><und is_array="true"><item><tid>52</tid></item><item><tid>53</tid></item><item><tid>54</tid></item><item><tid>55</tid></item><item><tid>56</tid></item><item><tid>59</tid></item><item><tid>62</tid></item><item><tid>61</tid></item><item><tid>64</tid></item><item><tid>66</tid></item><item><tid>67</tid></item><item><tid>68</tid></item><item><tid>69</tid></item><item><tid>73</tid></item><item><tid>75</tid></item><item><tid>72</tid></item><item><tid>51</tid></item><item><tid>57</tid></item><item><tid>58</tid></item><item><tid>74</tid></item><item><tid>63</tid></item><item><tid>70</tid></item><item><tid>71</tid></item><item><tid>60</tid></item><item><tid>65</tid></item></und></field_building_types>
    <field_resource_type_superset/></item>
  <item>
  ...
</result>

Rate Limits

Standard rate limits apply. No more than 1,000 requests may be made in any hour

Errors

Standard errors may be returned.

Help Improve this Content