An Official Website of the United States Government
Friday, May 18th 2012

You are here

Home ยป Developers API

Developers API

The system uses the services module to provide a REST (Representational State Transfer) based API.

The API covers these data types:
Projects
Permits
Actions
Agencies
Bureaus
Sectors

The API has been configured to give response in JSON and XML. The user can obtain a XML or JSON just by changing the request in the URL. Following are examples on how to access and control permits, actions and projects data by using the API.

Projects

Description
Output a single Project record or all the Project records
API sample calls
  • Returns XML:    http://permits.performance.gov/api/projects/41
  • Returns JSON:  http://permits.performance.gov/api/projects/41.json
  • Returns XML:    http://permits.performance.gov/api/projects
  • Returns JSON:  http://permits.performance.gov/api/projects.json
Required Parameters
  • system_id
Return Values:
  • title
  • sector
  • description
  • owner
  • city
  • state
  • zip_code
  • latitude
  • longitude
  • map_type
  • map_zoom_level
  • estimated_cost
  • lead_agency
  • lead_bureau
  • lead_agency_POC_name
  • lead_agency_POC_title
  • lead_agency_POC_email
  • start_date
  • target_completion_date
  • expediating_process
  • learn_more
  • last_updated_on

Permits

Description
Output a single Permit record
Description
  • Returns XML:    http://permits.performance.gov/api/permits/489
  • Returns JSON:  http://permits.performance.gov/api/permits/489.json
Required Parameters
  • system_id
Return Values:
  • title
  • last_udpated_on
  • description
  • approval_agency
  • approval_agency_POC_name
  • approval_agency_POC_title
  • approval_agency_POC_email
  • contributing_agencies
  • target_start_date
  • target_completion_date
  • actual_start_date
  • actual_completion_date
  • expediting_actions
  • potential_obstacles_delays
  • best_practices
  • permit_status

Actions

Description
Output a single Action record
API sample calls
  • Returns XML:    http://permits.performance.gov/api/actions/510
  • Returns JSON:  http://permits.performance.gov/api/actions/510.json
Required Parameters
  • system_id
Return Values:
  • title
  • last_updated_on
  • description
  • approval_agency
  • approval_agency_POC_name
  • approval_agency_POC_title
  • approval_agency_POC_email
  • contributing_agencies
  • target_start_date
  • target_completion_date
  • actual_start_date
  • actual_completion_date
  • delay_explanation
  • action_status

Agencies

Description
Output a list of all Agencies


API sample calls
Returns XML:    http://permits.performance.gov/api/agencies
Returns JSON:  http://permits.performance.gov/api/agencies.json


Required Parameters

  • none

Return Values:

  • title
  • system_id
  • abbreviation
  • agency_a11_code
  • description

Bureaus

Description
Output a list of all Bureaus


API sample calls
Returns XML:    http://permits.performance.gov/api/bureaus
Returns JSON:  http://permits.performance.gov/api/bureaus.json


Required Parameters

  • none

Return Values:

  • title
  • system_id
  • bureau_a11_code

Sectors

Description
Output a list of all Sectors 


API sample calls
Returns XML:    http://permits.performance.gov/api/sectors
Returns JSON:  http://permits.performance.gov/api/sectors.json


Required Parameters

  • none

Return Values:

  • title
  • system_id