Description
This API has 2 method calls: getList and getInfo. GetList call takes the parameters of a state's abbreviation or state FIPS code, and a yes-or-no for multiple-state indicator, and returns all the broadband providers in that state. GetInfo call takes FRN number of a broadband provider, and return information about the provider.
Why We Provide It
We are providing this API to increase the value of the transparency of broadband providers providing service in each state. Filers with the FCC must get a registration number whose company names, parent names and subsidiary names often change from state to state and region to region. Providing a single place for understanding the complex naming of these providers will benefit consumers.
Web Application Description Language (WADL)
Endpoint - http://data.fcc.gov/api/frn/application.wadl
WADL Content
<doc jersey:generatedBy="Jersey: 1.3 06/17/2010 04:53 PM"/>
<resources base="http://data.fcc.gov:80/api/frn/">
<resource path="">
<resource path="getInfo">
<method name="GET" id="getInfo">
<request>
<param type="xs:string" style="query" name="frn"/>
<param type="xs:string" style="query" name="jsoncallback"/>
</request>
<response>
<representation mediaType="application/x-javascript"/>
<representation mediaType="application/json"/>
<representation mediaType="application/xml"/>
</response>
</method>
</resource>
<resource path="getList">
<method name="GET" id="getList">
<request>
<param type="xs:string" style="query" name="stateCode"/>
<param type="xs:string" style="query" name="multiStates"/>
<param type="xs:string" style="query" name="jsoncallback"/>
</request>
<response>
<representation mediaType="application/x-javascript"/>
<representation mediaType="application/json"/>
<representation mediaType="application/xml"/>
</response>
</method>
</resource>
</resource>
</resources>
</application>
FRN Method Calls
-
getList
Search for FRNs in a state
- api call
- http://data.fcc.gov/api/frn/getList?stateCode=<parameter1>&multi=<parameter2>
- example call
- http://data.fcc.gov/api/frn/getList?stateCode=IL&multi=Yes
- parameters
-
- stateCode – State Abbreviation (e.g. "IL") or State FIPS Code (e.g. 17)
- multiStates (optional) – "Yes" if operating in other states or "No" if not operating in other states
- response
-
- JSONP
-
callback({"@executionTime":"4.31","@status":"OK","Frns":{"Frn":[{"frn":"0017855545","companyName":"Cygnus Telecommunications Corporation","holdingCompanyName":"Cygnus Telecommunications Corporation","regulationStatus":"N","modifyDate":"2010.07.30 15:23:02"}]}})
- JSON
-
{
"@executionTime": "4.31",
"@status": "OK",
"Frns": {"Frn": [
{
"frn": "0017855545",
"companyName": "Cygnus Telecommunications Corporation",
"holdingCompanyName": "Cygnus Telecommunications Corporation",
"regulationStatus": "N",
"modifyDate": "2010.07.30 15:23:02"
}
]}
} - XML
-
<Response executionTime="4.4" status="OK" xmlns="http://data.fcc.gov/api">
<Frns>
<Frn>
<frn>0017855545</frn>
<companyName>Cygnus Telecommunications Corporation</companyName>
<holdingCompanyName>Cygnus Telecommunications Corporation</holdingCompanyName>
<regulationStatus>N</regulationStatus>
<modifyDate>2010.07.30 15:23:02</modifyDate>
</Frn>
</Frns>
</Response> - Error Response
-
In case there is any exception on the server side it is caught and the http status code 500 is returned. (INTERNAL SERVER ERROR). The status description contains the detailed reason for the failure.
-
getInfo
Get detailed information on a FRN
- api call
- http://data.fcc.gov/api/frn/getInfo?frn= <parameter1>
- example call
- http://data.fcc.gov/api/frn/getInfo?frn=0017855545
- parameters
-
- frn – 10-digit provider FRN
- response
-
- JSONP
-
callback({"@executionTime":"4.31","@status":"OK","Frns":{"Frn":[{"frn":"0017855545","companyName":"Cygnus Telecommunications Corporation","holdingCompanyName":"Cygnus Telecommunications Corporation","regulationStatus":"N","modifyDate":"2010.07.30 15:23:02"}]}})
- JSON
-
{
"@executionTime": "0.014",
"@status": "OK",
"Info": {
"frn": "0017855545",
"companyName": "Cygnus Telecommunications Corporation",
"holdingCompanyName": "Cygnus Telecommunications Corporation",
"regulationStatus": "N",
"States": {"state": "IL"},
"TechnologyDescs": null,
"modifyDate": "2010.07.30 15:23:02"
}
} - XML
-
<Response executionTime="0.016" status="OK" xmlns="http://data.fcc.gov/api">
<Info>
<frn>0017855545</frn>
<companyName>Cygnus Telecommunications Corporation</companyName>
<holdingCompanyName>Cygnus Telecommunications Corporation</holdingCompanyName>
<regulationStatus>N</regulationStatus>
<States>
<state>IL</state>
</States>
<TechnologyDescs/>
<modifyDate>2010.07.30 15:23:02</modifyDate>
</Info>
</Response> - Error Response
-
In case there is any exception on the server side it is caught and the http status code 500 is returned. (INTERNAL SERVER ERROR). The status description contains the detailed reason for the failure.