Getting Started

There are six separate microservices contained as part of this Human Services Data API (HSDA) work. HSDA is the core service, focusing on the management of organizations, locations, services, contacts, and their sub-resources (ie. addresses, phones, etc.). The other seven microservices are meant to be standalone services that augment the core HSDA service.

Here is a quick list of the eight services, which there are separate documentation available below:

  • HSDA Full - The core service for managing organizations, locations, services, contacts, and other sub-resouces in single API calls.
  • HSDA Detailed - The core service for managing organizations, locations, services, contacts, and other sub-resouces.
  • HSDA Search - A spin-off search service from the core service, focusing exclusively on searching across HSDA resources.
  • HSDA Taxonomy - An independent service for managng taxonomy used by the core set of services. It uses Open Elgibility currently.
  • HSDA Meta - An independent service for recording all transactions executed via any HSDA implementation, providing comprehensive logging.
  • HSDA Management - The simple API management layer for HSDA, leveraging Github authentication to be able to make calls to HSDA APIs.

To get started I recommend beginning with authentication which will get you an API key allowing you to make calls across all services, not just the public GET resources. Then spend time with the interactive documentation for each service to better understand how they work independently, but also in concert with each other. It is meant to provide a buffet of HSDA services that work together, operate independently, and can be moved forward as separate projects.

Human Services Data API (HSDA) Full (v1.2)

This is the interactive documentation for the core set of Human Services Data API (HSDA) resources. If you are looking to get a full responses for all core resources, as well as their sub-resources in a single API call, these are the paths for you. These four endpoints will return full responses for each resource in a single response.

This set of paths are intended to be about working with core resouces (ie. organizations, locations, contacts and services), there are other spearate HSDA services that give you access to a variety of systems that support, augment, and work with the core set of Human Services Data API (HSDA) services.