Skip to content

Instantly share code, notes, and snippets.

@nmonga91
nmonga91 / spending_by_award.md
Last active October 18, 2017 18:59
Spending By Award

Route: /api/v2/search/spending_by_award/

Method: POST

This route takes award filters and fields, and returns the fields of the filtered awards.

Request

field: Defines what award variables are returned.

@nmonga91
nmonga91 / spending_explorer_endpoint.md
Created September 18, 2017 19:33
Spending Explorer Endpoint

Retrieve Spending Explorer Data

Route: /api/v2/spending/

Method: POST

This route sends a request to the backend to retrieve spending data information through various types and filters.

POST Example

@nmonga91
nmonga91 / search_filters_v2_docs.md
Last active October 30, 2017 14:35
Search Filters v2 Documentation

Search Filters v2 Documentation

NOTE: Filter examples can be combined into a single object in order to AND their results. Some search filters can be OR'd internally and will be specified as such. For example:

{
	"keyword": "example search text",
	"time_period": [
		{
 "start_date": "2001-01-01",
@nmonga91
nmonga91 / award_last_updated.md
Last active August 7, 2017 19:47
Award Last Updated Endpoint

Retrieve last updated date for Award data

Route: /api/v2/awards/last_updated/

Method: GET

This route sends a request to the backend to retrieve the last updated date for the Award data.

Response (JSON)

@nmonga91
nmonga91 / toptier_agency_v2_update.md
Last active July 24, 2017 20:39
Toptier Agency V2 Update

Retrieve all Toptier Agency data

Route: /api/v2/references/toptier_agencies/

Method: GET

This route sends a request to the backend to retrieve all toptier agencies and related, relevant data.

Request example

@nmonga91
nmonga91 / toptier_agency_autocomplete.md
Last active July 24, 2017 14:10
Toptier Agency Autocomplete

Retrieve Toptier Agency names for the autocomplete text box

Route: /api/v2/autocomplete/toptier_agency/

Method: POST

This route sends a request to the backend to retrieve toptier agency names matching the specified search text.

Request example

@nmonga91
nmonga91 / budget_function_autocomplete.md
Last active July 17, 2017 15:49
Budget Function Autocomplete Updated

Retrieve budget functions for the autocomplete text box

Route: /api/v2/autocomplete/budget_function/

Method: POST

This route sends a request to the backend to retrieve budget functions matching the specified search text.

Request example

@nmonga91
nmonga91 / funding_agency_autocomplete.md
Last active July 13, 2017 19:21
Funding Agency Autocomplete

Retrieve Funding Agencies for the autocomplete text box

Route: /api/v2/autocomplete/funding_agency/

Method: POST

This route sends a request to the backend to retrieve funding agencies matching the specified search text.

Request example

@nmonga91
nmonga91 / agency_metadata.md
Last active July 12, 2017 19:05
Agency Metadata

Retrieve agency information

Route: /api/v2/references/agency/:id

Method: GET

This route sends a request to the backend to retrieve an agency's metadata

Request example

@nmonga91
nmonga91 / awarding_agency_autocomplete.md
Last active July 13, 2017 19:21
Awarding Agency Autocomplete

Retrieve Awarding Agencies for the autocomplete text box

Route: /api/v2/autocomplete/awarding_agency/

Method: POST

This route sends a request to the backend to retrieve awarding agencies matching the specified search text.

Request example