1. Documentation
2. Buildings
3. Commercial Building Resource Database
4. Commercial Building Resource Vocabularies

Commercial Building Resource Vocabularies (GET /api/commercial-building-resources/v1/vocabulary-name)

A list of terms for a given vocabulary in the Commercial Buildings Resource Database. Useful for advanced search integration.

Request URL

GET /api/v1/vocabulary-name.format?parameters

Request Parameters

Parameter	Required	Value	Description
vocabulary-name	Yes	Type: string Default: None Options: audience-types, building-types, collections, construction-types, institutions, keywords, portals, publication-types, resource-types, states, terms, tool-types, topics	The vocabulary to retrieve terms for. If "terms" is used, this will return terms from all vocabularies. Otherwise this will return only terms from the specified vocabulary.
format	Yes	Type: string Default: xml Options: json, xml	The output response format.
api_key	Yes	Type: string Default: None	Your developer API key. See API keys for more information.

Response Fields

Field	Value	Description
result	Type: Array	Array of terms from the requested vocabulary, listed in no specific order. See term fields for details.

Term Fields

Fields returned with each result.

Parameter	Value	Description
tid	Type: integer	The unique id of the term.
vid	Type: integer	Version id of the term.
name	Type: String	Display name of term.
description	Type: String	Display name of term.
format	Type: String	Format of term.
weight	Type: String	Display order for term.
vocabulary_machine_name	Type: String	Unique id for vocabulary. Unless input "vocabulary_name" = "terms" was used to select terms from all vocabularies, this field will be the same for all results.
rdf_mapping	Type: Object	Resource Description Framework (RDF) metadata.

Examples

JSON Output Format

GET /api/commercial-building-resources/building-types.json?api_key=DEMO_KEY

{
    "result": [
        {
            "tid": "51",
            "vid": "9",
            "name": "Datacenter",
            "description": null,
            "format": null,
            "weight": "0",
            "vocabulary_machine_name": "building_types",
            "rdf_mapping": {
                "rdftype": [
                    "skos:Concept"
                ],
                "name": {
                    "predicates": [
                        "rdfs:label",
                        "skos:prefLabel"
                    ]
                },
                "description": {
                    "predicates": [
                        "skos:definition"
                    ]
                },
                "vid": {
                    "predicates": [
                        "skos:inScheme"
                    ],
                    "type": "rel"
                },
                "parent": {
                    "predicates": [
                        "skos:broader"
                    ],
                    "type": "rel"
                }
            }
        },
...
    ]
}

XML Output Format

GET /api/commercial-building-resources/v1/service.xml?api_key=DEMO_KEY

<?xml version="1.0" encoding="UTF-8"?>
<result is_array="true">
  <item>
    <tid>51</tid>
    <vid>9</vid>
    <name>Datacenter</name>
    <description/>
    <format/>
    <weight>0</weight>
    <vocabulary_machine_name>building_types</vocabulary_machine_name>
    <rdf_mapping>
      <rdftype is_array="true">
        <item>skos:Concept</item>
      </rdftype>
      <name>
        <predicates is_array="true">
          <item>rdfs:label</item>
          <item>skos:prefLabel</item>
        </predicates></name>
      <description>
        <predicates is_array="true">
          <item>skos:definition</item>
        </predicates>
      </description>
      <vid>
        <predicates is_array="true">
          <item>skos:inScheme</item>
        </predicates>
        <type>rel</type>
      </vid>
      <parent>
        <predicates is_array="true">
          <item>skos:broader</item>
        </predicates>
        <type>rel</type>
      </parent>
    </rdf_mapping>
  </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.