The following are collection of API’s that will allow the retrieval for services information in the directory.
Common Queries
The services can be queried using a JSON object that defines the inputs to the query. The document that explains more about the query language can be found here Query Guide . The following are common used queries that can be used to query against the services endpoint.
Description | Example |
---|---|
Query for a taxonomy term with a physical address in a certain postal code | {"$table.field": [{"service_taxonomy.taxonomy_id": "BD-1800.2000"}, {"physical_address.postal_code": "49456"}]} Here is a link to a use case with more information Get a list of service locations filtered by AIRS service taxonomy term and location area (zip code, county). |
Query for a custom subcategory with a service that has a physical address with a postal code | {"$table.field": [{"service_taxonomy.subcategory": "Housing/Shelter"}, {"physical_address.postal_code": "49442"}]} Here is a link to a use case with more information Get a list of services based on custom categories |
Query for all services that are served in the city with taxonomy details |
Here is a link to a use case with more information Get a list of services filtered by location area (zip code, city, county) and taxonomy term |
Query for all services that are served for a particular zipcode and are tagged with a subcategory. |
Here is a link to a use case with more information Get a list of services filtered by location area (zip code, city, county) and taxonomy term |
Query for all services that are served within a county that are tagged with category and subcategory |
Here is a link to a use case with more information Get a list of services filtered by location area (zip code, city, county) and taxonomy term |
0 Comments