SCC Web Services

The SCC Web Services provides an interface to the terms and descriptions that are related to Source Classification Codes (SCC) found in the Terminology Services (TS) registry.

The web services provided allow searching for SCCs by name or facet, as well as querying an SCC by its code. JSON, XML, or CSV output is returned.

Query Services

Search SCCs by Facet

GET /SCC

Summary

This service queries SCCs by one or more facet. When searching a facet, all four facet parameters (facetName[], facetValue[], facetQualifier[], facetMatchType[]) must be supplied.

Parameters

Name Description
facetName[]The name of the facet to search. Multiple facet names may be passed, separated by the pipe (|) character. Possible facet names include: Activity Value Required?, Code, Data Category, ERT Valid, History, Last Updated Date, SCC Level Four, SCC Level One, SCC Level Three, SCC Level Two, Sector, Status, Tier 1 Code, Tier 1 Description, Tier 2 Code, Tier 2 Description, Tier 3 Code, Tier 3 Description
facetValue[]The value to search for the specified facetName. Multiple values may be passed, separated by the pipe (|) character.
facetQualifier[]The qualifier to use when searching the specified facetName. Possible values: contains, begins, exact. If omitted, contains is used by default.
facetMatchType[]The type of match to perform when searching. Possible values: all_words, any_word, whole_phrase. If omitted, all_words is used by default.
sortFacetThe facet to sort results by. If omitted, the results are sorted by code.
pageNumThe page number of results to show. pageSize must also be specified; otherwise both parameters are ignored. If omitted, the full result set is returned.
pageSizeThe number of results to show per page. pageNum must also be specified; otherwise both parameters are ignored. If omitted, the full result set is returned.
formatThe output format. Possible values: JSON, XML, CSV. If omitted, JSON format is used by default.
filenameThe filename used. Only used when CSV format is requested.

Results Sample

[
   {
      "code":"2102012000",
      "attributes":{
         "Tier 3 Description":"Liquid Waste",
         "Activity Value Required?":"No",
         "Tier 3 Code":"02",
         "Sector":"Fuel Comb - Industrial Boilers, ICEs - Other",
         "Tier 2 Code":"04",
         "SCC Level Four":"Total",
         "Tier 1 Description":"Fuel Comb. Industrial",
         "SCC Level One":"Stationary Source Fuel Combustion",
         "Status":"Active",
         "Tier 2 Description":"Other",
         "Data Category":"Nonpoint",
         "Last Updated Date":"3/14/2012",
         "SCC Level Two":"Industrial",
         "Tier 1 Code":"02",
         "SCC Level Three":"Waste oil"
      }
   },
   {
      "code":"2260001000",
      "attributes":{
         "Tier 3 Description":"Recreational",
         "Activity Value Required?":"No",
         "Sector":"Mobile - Non-Road Equipment - Gasoline",
         "SCC Level Four":"Total",
         "Tier 1 Description":"Off-Highway",
         "SCC Level One":"Mobile Sources",
         "Status":"Retired",
         "Tier 2 Description":"Non-Road Gasoline",
         "Data Category":"Nonroad",
         "Last Updated Date":"3/14/2012",
         "SCC Level Two":"Off-highway Vehicle Gasoline, 2-Stroke",
         "SCC Level Three":"Recreational Equipment",
         "Last Inventory Year":"2005"
      }
   },
   {
      "code":"2260002000",
      "attributes":{
         "Tier 3 Description":"Construction",
         "Status":"Active",
         "Activity Value Required?":"No",
         "Tier 2 Description":"Non-Road Gasoline",
         "Sector":"Mobile - Non-Road Equipment - Gasoline",
         "Data Category":"Nonroad",
         "Last Updated Date":"3/14/2012",
         "SCC Level Two":"Off-highway Vehicle Gasoline, 2-Stroke",
         "SCC Level Four":"Total",
         "Tier 1 Description":"Off-Highway",
         "SCC Level Three":"Construction and Mining Equipment",
         "SCC Level One":"Mobile Sources"
      }
   }
]

SCC detail by code

GET /SCC/{code}

Summary

This service queries SCCs by code.

Parameters

Name Description
formatThe output format. Possible values: JSON, XML, CSV. If omitted, JSON format is used by default.

Results Sample

{
   "code":"2303020000",
   "attributes":{
      "Tier 3 Description":"Primary",
      "Activity Value Required?":"No",
      "Tier 3 Code":"01",
      "Sector":"Industrial Processes - Ferrous Metals",
      "Tier 2 Code":"02",
      "SCC Level Four":"Total",
      "Tier 1 Description":"Metals Processing",
      "SCC Level One":"Industrial Processes",
      "Status":"Active",
      "Tier 2 Description":"Ferrous Metals Processing",
      "Data Category":"Nonpoint",
      "Last Updated Date":"3/14/2012",
      "SCC Level Two":"Primary Metal Production: SIC 33",
      "Tier 1 Code":"05",
      "SCC Level Three":"Iron and Steel Foundries"
   }
}

Search SCC Hierarchy Item by Facet or Level

GET /SCCHierarchyItem

Summary

This service queries SCC hierarchy items by facet or level.

Parameters

Name Description
level[]Level of the SCC hierarchy item. Possible values: 1, 2, 3, 4. Multiple values are allowed.
facetName[]The name of the facet to search. Multiple facet names may be passed, separated by the pipe (|) character. Possible facet names include: Activity Value Required?, Code, Data Category, ERT Valid, History, Last Updated Date, SCC Level Four, SCC Level One, SCC Level Three, SCC Level Two, Sector, Status, Tier 1 Code, Tier 1 Description, Tier 2 Code, Tier 2 Description, Tier 3 Code, Tier 3 Description
facetValue[]The value to search for the specified facetName. Multiple values may be passed, separated by the pipe (|) character.
facetQualifier[]The qualifier to use when searching the specified facetName. Possible values: contains, begins, exact. If omitted, contains is used by default.
facetMatchType[]The type of match to perform when searching. Possible values: all_words, any_word, whole_phrase. If omitted, all_words is used by default.
pageNumThe page number of results to show. pageSize must also be specified; otherwise both parameters are ignored. If omitted, the full result set is returned.
pageSizeThe number of results to show per page. pageNum must also be specified; otherwise both parameters are ignored. If omitted, the full result set is returned.
formatThe output format. Possible values: JSON, XML, CSV. If omitted, JSON format is used by default.
filenameThe filename used. Only used when CSV format is requested.

Results Sample

[
	{
		"name": "Brick Kilns",
		"level": 1
	},
	{
		"name": "Domestic Ammonia",
		"level": 1
	},
	{
		"name": "External Combustion",
		"level": 1
	},
	{
		"name": "External Combustion Boilers",
		"level": 1
	}
]

List All SCC Facet Names

GET /SCCFacetName

Summary

This service queries all available SCC facet names. This can be used to determine exactly which facets are searchable.

Parameters

Name Description
formatThe output format. Possible values: JSON, XML, CSV. If omitted, JSON format is used by default.
filenameThe filename used. Only used when CSV format is requested.

Results Sample

[
	"activity value required?",
	"data category",
	"ert valid",
	"history",
	"last inventory year",
	"last updated date",
	"map to",
	"option group",
	"option set",
	"scc level four",
	"scc level one",
	"scc level three",
	"scc level two",
	"sector",
	"short name",
	"status",
	"tier 1 code",
	"tier 1 description",
	"tier 2 code",
	"tier 2 description",
	"tier 3 code",
	"tier 3 description",
	"usage notes"
]

Get All SCC Facet Values by SCC Facet Name

GET /SCCFacetValue

Summary

This service queries all SCC facet values, given one or more facet name. This can be used to populate a list of options for a filtering on one or more facets; for example, a filter on data category.

Parameters

Name Description
facetNameThe facet name(s) to search. Multiple values may be passed, separated by the pipe (|) character.
formatThe output format. Possible values: JSON, XML, CSV. If omitted, JSON format is used by default.
filenameThe filename used. Only used when CSV format is requested.

Results Sample

{
	data category: [
		"Biogenic",
		"Event",
		"Nonpoint",
		"Nonroad",
		"Onroad",
		"Point"
	]
}

Get Timestamp of SCC Data Last Updated

GET /LastUpdate

Summary

This service returns the UNIX timestamp of when the SCC data was last updated.

Parameters

Name Description
formatThe output format. Possible values: JSON, XML, CSV. If omitted, JSON format is used by default.
filenameThe filename used. Only used when CSV format is requested.

Results Sample

{
  "lastUpdated": 1465580415000
}

Sample URLs

Description URL
Search for SSCs with Data Category matching "onroad" exactly, SCC Level Four matching "Total Spillage and Displacement" exactly, Tier 1 Description containing "highway", and Sector beginning with "gas" in XML format https://ofmpub.epa.gov:443/sccwebservices/v1/SCC?facetName[]=data+category&facetValue[]=onroad&facetQualifier[]=exact&facetName[]=scc+level+four&facetValue[]=total+spillage+and+displacement&facetQualifier[]=exact&facetName[]=tier+1+description&facetValue[]=highway&facetQualifier=contains&facetName[]=sector&facetValue[]=gas&facetQualifier[]=begins&format=XML
Query the SCC with code 2303020000 https://ofmpub.epa.gov:443/sccwebservices/v1/SCC/2303020000
Query SCC hierarchy items with names containing "combustion" with SCC levels 1 or 2 https://ofmpub.epa.gov:443/sccwebservices/v1/SCCHierarchyItem?level[]=1&level[]=2&facetName[]=scc level one|scc level two|scc level three|scc level four&facetValue[]=combustion&facetQualifier[]=contains&facetMatchType[]=whole_phrase
Search all SCCs with ERT Valid of "Yes", and show the first 50 results. https://ofmpub.epa.gov:443/sccwebservices/v1/SCC?facetName[]=ert+valid&facetValue[]=yes&facetQualifier[]=exact&pageNum=1&pageSize=50
Searches all SCCs with Short Name containing the phrase "sheep and lamb" https://ofmpub.epa.gov:443/sccwebservices/v1/SCC?facetName[]=Short Name&facetValue[]=sheep and lamb&facetQualifier[]=contains&facetMatchType[]=whole_phrase
Searches all SCCs with any one of SCC Level One, SCC Level Two, SCC Level Three, SCC Level Four, Short Name, or Sector containing the words external and combustion https://ofmpub.epa.gov:443/sccwebservices/v1/SCC?facetName[]=SCC Level One|SCC Level Two|SCC Level Three|SCC Level Four|Short Name|Sector&facetValue[]=external combustion&facetQualifier[]=contains&facetMatchType[]=all_words
Searches all SCCs with Short Name containing the phrase "sheep and lamb" and with any of SCC Level One, SCC Level Two, SCC Level Three, SCC Level Four containing the word agriculture https://ofmpub.epa.gov:443/sccwebservices/v1/SCC?facetName[]=Short Name&facetValue[]=sheep and lamb&facetQualifier[]=contains&facetMatchType[]=whole_phrase&facetName[]=SCC Level One|SCC Level Two|SCC Level Three|SCC Level Four&facetValue[]=agriculture&facetQualifier[]=contains&facetMatchType[]=all_words
Searches all SCCs with any one of SCC Level One, SCC Level Two, SCC Level Three, SCC Level Four, Short Name, or Sector containing the words external and combustion and with any of SCC Level One, SCC Level Two, SCC Level Three, SCC Level Four containing the word boilers https://ofmpub.epa.gov:443/sccwebservices/v1/SCC?facetName[]=SCC Level One|SCC Level Two|SCC Level Three|SCC Level Four|Short Name|Sector&facetValue[]=external combustion&facetQualifier[]=contains&facetMatchType[]=all_words&facetName[]=SCC Level One|SCC Level Two|SCC Level Three|SCC Level Four&facetValue[]=boilers&facetQualifier[]=contains&facetMatchType[]=all_words
Searches all SCCs with Short Name containing the phrase "sheep and lamb" and with any of SCC Level One, SCC Level Two, SCC Level Three, SCC Level Four containing the word agriculture and with Data Category exactly matching "Nonpoint" or "Nonroad" https://ofmpub.epa.gov:443/sccwebservices/v1/SCC?facetName[]=Short Name&facetValue[]=sheep and lamb&facetQualifier[]=contains&facetMatchType[]=whole_phrase&facetName[]=SCC Level One|SCC Level Two|SCC Level Three|SCC Level Four&facetValue[]=boilers&facetQualifier[]=contains&facetMatchType[]=all_words&facetName[]=Data Category&facetValue[]=Nonpoint|Nonroad&facetQualifier[]=exact&facetMatchType[]=whole_phrase
Get all searchable facets https://ofmpub.epa.gov:443/sccwebservices/v1/SCCFacetName
Get all possible data categories and sectors. https://ofmpub.epa.gov:443/sccwebservices/v1/SCCFacetValue?facetName=data%20category|sector
Get the UNIX timestamp of when the SCC data was last updated. https://ofmpub.epa.gov:443/sccwebservices/v1/LastUpdated

Demo

Try it out for yourself. Enter text into the search field below and then click Search. A call will be made to the service and the results will be displayed below.

Also, feel free to view the source of the page or check it out in your browser's developer tools to see exactly how this works.