Posted on 11-06-2013
|Photo Credit: Runscope|
I've been working on open data and APIs pretty heavily since Barack Obama directed all federal agencies to go machine readable by default, back in May of 2012. The White House directive told agencies to publish a copy their digital strategy at their website in the following location: [agency].gov/digitalstrategy. There was also supposed to be an HTML, XML and JSON representation of their digital strategy.
Pretty cool request. I immediately got busy writing a script that I could run each night and let me know which federal agency had published their digital strategy. To be fair, the White House mandate was for top level agencies, not really all 246 as I showcase. However, I think it is a process that all agencies can learn from, so I leave it up.
Back to pulling the digital strategy for each agency. First I needed all the agencies website addresses, which I pulled from the federal agency directory API. I then appended /digitalstrategy.html, and /digitalstrategy.xml, and /digitalstrategy.json to each agency URL. Now remember, I am a script or piece of code trying to determine if one of 246 x 3 pages exist. I'm not a human looking at each page load with my eyeballs. The only think I have to tell me what is happening is the HTTP status code(s):
- 200 - Ok, The request has succeeded.
- 301 - Moved Permanently
- 404 - Not Found
What the government agency sends to me as a status code triggers one of three responses in my code:
- 200 - They have published their digital strategy
- 301 - They have published their strategy but it is located somewhere else
- 404 - They have NOT published their digital strategy
After you run the script you see most of the agencies return a 404--not published. Ok, but then I started seeing 301 without an actual URL that redirected me to existing location. I saw published digital strategies return 404 and unpublished strategies return 200. While most agencies adhered to basic HTTP principles, some I just had to hard code. I had to manually code a section saying IF agency = XX then assume this response code. This is a pretty basic problem, something you won't see unless you actually write some code against the situation (which I assume agencies aren't doing).
Fast-forward two years you have the Office of Management and Budget (OMB) directing that government agencies post .data.json files in a similiar way to the earlier digital strategy. I hope someday they will also require /api.son files, /roadmap.json and other machine readable goodies, but that is another story. This story is about proper HTTP status codes.
Each government agencies should be publishing their /digitalstrategy and /data.json files at their website, and they should be properly returning 200 OK or a 301 with proper URI of where you put your digitalstrategy.json or data.json (or other resource). It is acceptable to have these files in an alternate location, but you must provide a complete 301 status code so that my code or script can properly make a decision and properly locate your digitalstrategy.json or data.json files.
I thought I wrote this story last year, but apparently the story in my head didn't match what I actually published to my blog. So I wanted to make sure there was a fresh copy to help government agencies understand this simple, but very important aspect of their digital strategy.
comments powered by Disqus
Winning in the API Economy
|Download as PDF|
Latest Blog Posts
- Forget Being Neutral And Objective Anymore With APIs
- Building The Type Of Audience I Really Want
- Moving Beyond Server Side Code And Hosting
- Checkout This Lineup Of Speakers At Defrag, Including Myself
- 6,482 Datasets Available Across 22 Federal Agencies In Data.json Files
- Sorry Google, Your Programming Test Is Not A Valid Measurement Of My Skills
- My Information Consumption Now Driven By Companies And People, Not Just Feeds
- All Government Should Have A Social Media Directory API
- The Color Of Money When Deploying APIs At The Department Of Veterans Affairs
- Taking Web Service Inventory At The Department of Veteran Affairs