Commercial Building Resource Events (GET /api/commercial-building-resources/v1/events)
Upcoming and/or past events added to the Commercial Building Resource Database.
Request URL
GET /api/commercial-building-resources/events.format?parameters
Request Parameters
| Parameter | Required | Value | Description |
|---|---|---|---|
| format | Yes |
Type: string
Default: None
Options: json, jsonp, xml
|
The output response format. Jsonp format is identical to json format, with the addition that it supports the callback parameter for jsonp requests. |
| api_key | Yes |
Type: string
Default: None
|
Your developer API key. See API keys for more information. |
| portal | No |
Type: integer
Default: None
|
Unique integer representing the term from the Portal vocabulary to filter results on. |
| scope | No |
Type: string
Default: None
Options: upcoming, past
|
List events relative to current Date and Time. |
| callback | No |
Type: string
Default: None
|
For jsonp format, the callback parameter is used to support jsonp requests. |
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). |
| 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_collections |
Type: object
|
Array of terms in the Vocabulary. See Term Response Fields. |
| 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_event_date |
Type: object
|
The start and end time of Event. See DateTime Response Fields. |
| field_location |
Type: object
|
See Location Response fields. |
| field_location_alternative |
Type: string
|
Simple string description of location, provided when full Location cannot be. |
| field_sponsor_name |
Type: string
|
Name of Event sponsor (if available). |
| field_website_url |
Type: string
|
Url of event website, if available. |
| field_logo |
Type: string
|
Url of logo for Event sponsor, if available. |
| field_registration_url |
Type: string
|
Url to register for Event, if available. |
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. |
DateTime Response Fields
| Field | Value | Description |
|---|---|---|
| value |
Type: DateTime
|
The start date and time of Event, in timezone. |
| value2 |
Type: DateTime
|
The end date and time of Event, in timezone. |
| timezone |
Type: String
|
The timezone of the event. |
Location Response Fields
| Field | Value | Description |
|---|---|---|
| Country |
Type: string
|
|
| Locality |
Type: string
|
|
| Postal Code |
Type: integer
|
|
| Premise |
Type: string
|
Examples
JSON Output Format
GET /api/commercial-building-resources/v1/events.json?portal=6&api_key=DEMO_KEY
{
"18":{
"vid":"51",
"title":"Wireless Metering Challenge Webinar",
"nid":"18",
"created":"1366404303",
"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"
}
},
"body":{
"und":[
{
"value":"<strong>Time:</strong> Tuesday, April 30, 2013, 2:00-4:00 p.m. ET/11:00 a.m.-1:00 p.m. PT\r\n\r\n<strong>Presenter: </strong>The Department of Energy\u2019s Building Technologies Office\r\n\r\n<strong>Overview: </strong>The U.S. Department of Energy\u2019s Building Technologies Office announced plans to issue a new <A HREF=\"http://www1.eere.energy.gov/buildings/commercial/bba_wireless_metering.html\">Wireless Metering Challenge</A> to spur the development of low cost electric metering devices that can serve growing interest in panel level sub metering being seen throughout the commercial sector. \r\n\r\nKey features of the challenge specification include a low cost target, essential requirements for electrical energy measurement, and wireless data transmission to an onsite collection point. Draft specifications for the wireless metering device are now <A HREF=\"http://apps1.eere.energy.gov/buildings/publications/pdfs/alliances/wireless_energy_meter_specification_draft.pdf\">available for review</A>. \r\n\r\nBuilding owners, managers, manufacturers and other interested parties are invited to <A HREF=\"http://apps1.eere.energy.gov/buildings/publications/pdfs/alliances/wireless_energy_meter_specification_draft.pdf\">review and comment</A> on the draft specification by April 23, 2013. All comments and feedback should be submitted to wireless.meter@ee.doe.gov. The specification will be revised based on stakeholder feedback. \r\n\r\nThis webinar will present the revised specification and address any further questions.\r\n\r\n<strong>Target Audience:</strong> The primary audience for this webinar is the commercial sector, manufacturers and federal agencies. \r\n\r\n",
"summary":"",
"format":"filtered_html",
"safe_value":"<p><strong>Time:</strong> Tuesday, April 30, 2013, 2:00-4:00 p.m. ET/11:00 a.m.-1:00 p.m. PT</p>\n<p><strong>Presenter: </strong>The Department of Energy\u2019s Building Technologies Office</p>\n<p><strong>Overview: </strong>The U.S. Department of Energy\u2019s Building Technologies Office announced plans to issue a new <a href=\"http://www1.eere.energy.gov/buildings/commercial/bba_wireless_metering.html\">Wireless Metering Challenge</a> to spur the development of low cost electric metering devices that can serve growing interest in panel level sub metering being seen throughout the commercial sector. </p>\n<p>Key features of the challenge specification include a low cost target, essential requirements for electrical energy measurement, and wireless data transmission to an onsite collection point. Draft specifications for the wireless metering device are now <a href=\"http://apps1.eere.energy.gov/buildings/publications/pdfs/alliances/wireless_energy_meter_specification_draft.pdf\">available for review</a>. </p>\n<p>Building owners, managers, manufacturers and other interested parties are invited to <a href=\"http://apps1.eere.energy.gov/buildings/publications/pdfs/alliances/wireless_energy_meter_specification_draft.pdf\">review and comment</a> on the draft specification by April 23, 2013. All comments and feedback should be submitted to <a href=\"mailto:wireless.meter@ee.doe.gov\">wireless.meter@ee.doe.gov</a>. The specification will be revised based on stakeholder feedback. </p>\n<p>This webinar will present the revised specification and address any further questions.</p>\n<p><strong>Target Audience:</strong> The primary audience for this webinar is the commercial sector, manufacturers and federal agencies.</p>\n",
"safe_summary":""
}
]
},
"field_event_type":{
"und":[
{
"tid":"1"
}
]
},
"field_collections":[
],
"field_portal_tags":{
"und":[
{
"tid":"6"
}
]
},
"field_topics":{
"und":[
{
"tid":"29"
},
{
"tid":"32"
},
{
"tid":"33"
},
{
"tid":"48"
},
{
"tid":"45"
}
]
},
"field_keywords":{
"und":[
{
"tid":"205"
},
{
"tid":"206"
},
{
"tid":"207"
},
{
"tid":"208"
},
{
"tid":"209"
}
]
},
"field_event_date":{
"und":[
{
"value":"2013-04-30 18:00:00",
"value2":"2013-04-30 20:00:00",
"timezone":"America/New_York",
"offset":"-14400",
"offset2":"-14400",
"rrule":null,
"timezone_db":"UTC",
"date_type":"datetime"
}
]
},
"field_location":{
"und":[
{
"country":"US",
"administrative_area":"",
"sub_administrative_area":null,
"locality":"",
"dependent_locality":null,
"postal_code":"",
"thoroughfare":"",
"premise":"",
"sub_premise":null,
"organisation_name":null,
"name_line":null,
"first_name":null,
"last_name":null,
"data":null
}
]
},
"field_location_alternative":[
],
"field_sponsor_name":{
"und":[
{
"value":"FEMP",
"format":null,
"safe_value":"FEMP"
}
]
},
"field_website_url":[
],
"field_logo":[
],
"field_registration_url":{
"und":[
{
"url":"http://apps1.eere.energy.gov/femp/training/course_detail_live.cfm/CourseDateId=537",
"title":null,
"attributes":[
]
}
]
},
"field_audience_types":{
"und":[
{
"tid":"86"
},
{
"tid":"87"
},
{
"tid":"89"
},
{
"tid":"90"
},
{
"tid":"95"
}
]
},
"field_building_types":[
],
"field_radioactivity":[
]
},
...
}
XML Output Format
GET /api/commercial-building-resources/v1/events.xml?portal=6&api_key=DEMO_KEY
Rate Limits
Standard rate limits apply. No more than 1,000 requests may be made in any hour
Errors
Standard errors may be returned.