\services

Owned by Pete Richardson
Last updated: Jun 01, 2022 by Jonathan Draugelis
2 min read

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

Description

Example

Query multiple joined tables:
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 multiple joined tables:
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 services serving an area along with a joined table:
Query for all services that are served in the city with taxonomy details

{"$area": {"type":"city", "name":"detroit", "$table.field":[{"service_taxonomy.taxonomy_detail": "Tutoring Services"}]}}

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 services serving an area along with a joined table:
Query for all services that are served for a particular zipcode and are tagged with a subcategory.

{"$area": {"type":"zipcode", "name":"49534", "$table.field":[{"service_taxonomy.subcategory": "Medical Appointments Transportation"}]}}

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 services serving an area along with multiple joined tables:
Query for all services that are served within a county that are tagged with category and subcategory

{"$area": {"type":"county", "name":"monroe", "$table.field":[{"service_taxonomy.subcategory": "Medical Appointments Transportation"}, {"service_taxonomy.category": "transportation"}]}}

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 services serving an area along with root fields:
Query for all services that serve city of Detroit that are tagged with taxonomy_detail and have a specific alternate_name field.

{"$area": {"type":"county", "name":"Muskegon", "$in":{"alternate_name":["COMPLETE TUTORING CENTER (formerly)"]}}}

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 services serving an area along with ‘like’ root fields:
Query for all services that serve city of Detroit that are tagged with taxonomy_detail and have a specific alternate_name field containing given text.

{"$area": {"type":"county", "name":"Muskegon", "$in:like":{"alternate_name":["COMPLETE TUTORING CENTER (formerly)"]}}}

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