v2 API docs (WIP)

We are working on data-sources-app-v2 and will use this page to build documentation for the new version. The v2 API is not yet ready for the public.

Base URL

https://data-sources.pdap.io/api

Endpoints

Homepage Search Cache

GET [base-url]/homepage-search-cache

Headers

NameTypeDescription

Authorization

String

Value formatted as "Bearer [access token/api key]”

Responses

[
    {
        "SUBMITTED_NAME": "string",
        "JURISDICTION_TYPE": "string",
        "STATE_ISO": "string",
        "MUNICIPALITY": "string",
        "COUNTY_NAME": "string",
        "AIRTABLE_UID": "string",
        "COUNT_DATA_SOURCES": "integer",
        "ZIP_CODE": "string",
        "NO_WEB_PRESENCE": "Boolean"
    }
]

POST [base-url]/homepage-search-cache

Headers

NameTypeDescription

Authorization

String

Value formatted as "Bearer [access token/api key]”

Request Body

NameTypeDescription

agency_uid

String

The UID of the agency

search_results

[String]

List of search results to be cached

Example Request Body

{
    "agency_uid": "uid123",
    "search_results": ["result1", "result2"]
}

Responses

{
    "message": "Search Cache Updated"
}

Last updated