About¶

Open Referral

The Open Referral Initiative develops data standards and open platforms that make it easy to share and find information about community resources. Learn more about the initiative at OpenReferral.org.

Data Specifications¶

This site contains documentation for the Human Services Data Specification (HSDS) and the associated Human Services Data API Suite (HSDA).

These can be used to structure and exchange information about the accessibility of health, human, and social services. Specifically, the HSDS describes data about organizations, the services they provide, the locations at which these services can be accessed, and associated details. The HSDA describes protocols for accessing and managing this data.

Our ecosystem¶

Open Referral’s ecosystem includes a range of working open source software applications that can be freely redeployed to work with HSDS-compatible data and/or HSDA-compatible APIs. Many of these tools can be found in our Github organization.

Learn more about the why’s, how’s, and who’s of the Open Referral Initiative in our Public Documentation, and browse all of our Project Documents on Google Drive

Join Open Referral’s Community of Practice

We are formally convened in this Google Group.
You can also join our Slack team.
Sign up for our email newsletter on our homepage.

Get in touch¶

Questions not answered here? Suggestions for us?

Email us! We can discuss directly, and/or invite you to join us in Slack, where we conduct weekly office hours on Fridays at 12p EST.

Site contents¶

Contents:

Human Services Data Specification (HSDS)¶

The Human Services Data Specification (HSDS) is Open Referral’s core data exchange format. HSDS is designed to support the publication of open, interoperable community resource directory data.

The reference documentation describes the structure of HSDS data, and provides the authoritative definition of the fields using in HSDS and HSDA.

When to use HSDS?

HSDS is designed to support bulk exchange of data between different information and referral systems. It is appropriate to use when you want to export a collection of information about services, the locations where they can be accessed, and the organizations that deliver them.

HSDS data can then be imported into other systems that support the Open Referral specifications.

You can also use HSDS as a reference model when designing a data system to store or exchange human service information.

HSDS has been designed around the core required fields to support search and discovery of services, and the recommend fields that are useful to a wide range of users. Individual implementations may extend HSDS with their own properties.

For interactive exchange of data between systems (e.g. fetching individual services, or synchronising data) the Human Services Data API Suite (HSDA) is available.

HSDS pages

About HSDS¶

The Human Services Data Specification (HSDS; sometimes referred to as “The Open Referral format”) is an exchange format for publishing machine-readable data about health, human, and social services: their locations, and the organizations that provide them. We define “human services” broadly, to include any organizational resource that is made available for a person in need – such as food assistance, job training, child care, etc.

The primary use case served by HSDS is the provision of human service directory information as “open data,” to be consumed by any third-party information system.

HSDS is designed to provide a medium for bulk interchange of data about human services; it is designed to help systems that answer the question of “where should I look for help?” or “which services are normally available around my schedule?”.

It has features that can be used as the basis of a real-time system. Developers of such systems should ensure that the data that they’re using contains enough detail and is updated regularly enough to support that use, particularly around times that there may be variations (such as holidays).

Government entities, community organizations, and people often face difficulty obtaining timely and correct data about human services. The Human Services Data Specification facilitates the open exchange and use of human service data (often known as “community resource data”) among these stakeholders. To that end, this is an interchange format designed to complement – not replace – existing storage formats currently in use.

All organizations that provide services or referrals to services, as well as entities that distribute digital human service directory information, are invited to publish their data in this format, whether they be governments at the local, regional, or national level; civic organizations; software developers; etc.

See Reference Documentation for HSDS here. Find HSDS on Github here.

Learn more about Open Referral at openreferral.org.

HSDS Reference¶

The Human Services Data Specification defines a set of objects and the relationships between them.

This page provides the canonical definition of each object and its required or optional fields.

A collection of HSDS data can be serialized as a Tabular Data Package consisting of CSV files for each of the objects required, and a package descriptor (datapackage.json) file adapted from the current HSDS specification to include any additional fields and metadata from the data publisher.

Names and descriptions¶

Locations, Services and Organizations all have name and description field that can contain free text.

A name and alternate_name field should only ever include plain text, without formatting.

A description field may include HTML elements or Markdown, with special characters escaped or encoded.

Consuming applications that expect plain-text only should strip HTML tags from these fields.

Publishers should also be aware that some applications may wish to extract a ‘short description’ from the description field, and may do so by looking for the first full sentence, or first line-break.

Objects and fields¶

organization¶

The organization record is used to provide basic description and details about each organization delivering services. Each service should be linked to the organization responsible for its delivery. One organization may deliver many services.

name	organization
path	organizations.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string (uuid)	Each organization must have a unique identifier.	True	True
name	string	The official or public name of the organization.	True	False
alternate_name	string	Alternative or commonly used name for the organization.	False	False
description	string	A brief summary about the organization. It can contain markup such as HTML or Markdown.	True	False
email	string (email)	The contact e-mail address for the organization.	False	False
url	string (uri)	The URL (website address) of the organization.	False	False
tax_status	string	Government assigned tax designation for tax-exempt organizations.	False	False
tax_id	string	A government issued identifier used for the purpose of tax administration.	False	False
year_incorporated	date (%Y)	The year in which the organization was legally formed.	False	False
legal_status	string	The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.	False	False

program¶

Some organizations organise their services into programs. A program brings together a number of related services.

name	program
path	programs.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each program must have a unique identifier.	True	True
organization_id	string (uuid)	Each program must belong to a single organization. The identifier of the organization should be given here.	True	True
name	string	The name of the program	True	False
alternate_name	string	An alternative name for the program	False	False

service¶

Services are provided by organizations to a range of different groups. Details on where each service is delivered are contained in the services_at_location table.

name	service
path	services.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each service must have a unique identifier.	True	True
organization_id	string	The identifier of the organization that provides this service.	True	False
program_id	string	The identifier of the program this service is delivered under.	False	False
name	string	The official or public name of the service.	True	False
alternate_name	string	Alternative or commonly used name for a service.	False	False
description	string	A description of the service.	False	False
url	string (uri)	URL of the service	False	False
email	string (email)	Email address for the service	False	False
status	string	The current status of the service.	True	False
interpretation_services	string	A description of any interpretation services available for accessing this service.	False	False
application_process	string	The steps needed to access the service.	False	False
wait_time	string	Time a client may expect to wait before receiving a service.	False	False
fees	string	Details of any charges for service users to access this service.	False	False
accreditations	string	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	False	False
licenses	string	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	False	False

service_attribute¶

The services attributes table creates a link between a service and one or more classifications that describe the nature of the service provided.

name	service_attribute
path	service_attributes.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each service_attribute entry should have a unique identifier.	True	True
service_id	string	The identifier of the service to which this taxonomy term applies.	True	False
taxonomy_term_id	string	The identifier of this taxonomy term from the taxonomy table.	False	False

other_attribute¶

The other_attributes table creates a link between entities other than service and one or more classifications that describe the entity.

name	other_attribute
path	other_attributes.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each other_attribute entry should have a unique identifier.	True	True
link_id	string	The identifier of the entity to which this taxonomy term applies.	True	False
link_type	string	The identifier of the entity to which this taxonomy term applies.	True	False
taxonomy_term_id	string	The identifier of this taxonomy term from the taxonomy table.	False	False

service_at_location¶

The services at location table creates a link between a service and a specific location.

name	service_at_location
path	services_at_location.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each entry must have a unique identifier.	True	True
service_id	string	The identifier of the service at a given location.	True	False
location_id	string	The identifier of the location where this service operates.	True	False
description	string	Any additional information that should be displayed to users about the service at this specific location.	False	False

location¶

The location tables provides details of the locations where organizations operate. Locations may be virtual, and one organization may have many locations.

name	location
path	locations.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each location must have a unique identifier	True	True
organization_id	string	Each location entry should be linked to a single organization. This is the organization that is responsible for maintaining information about this location. The identifier of the organization should be given here. Details of the services the organisation delivers at this location should be provided in the services_at_location table.	False	False
name	string	The name of the location	False	False
alternate_name	string	An alternative name for the location	False	False
description	string	A description of this location.	False	False
transportation	string	A description of the access to public or private transportation to and from the location.	False	False
latitude	number	Y coordinate of location expressed in decimal degrees in WGS84 datum.	False	False
longitude	number	X coordinate of location expressed in decimal degrees in WGS84 datum.	False	False

phone¶

The phone table contains details of the telephone numbers are used to contact organizations, services, and locations.

name	phone
path	phones.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each entry must have a unique identifier	True	True
location_id	string	The identifier of the location where this phone number is located	False	False
service_id	string	The identifier of the service for which this is the phone number	False	False
organization_id	string	The identifier of the organisation for which this is the phone number	False	False
contact_id	string	The identifier of the contact for which this is the phone number	False	False
service_at_location_id	string	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	False	False
number	string	The phone number	True	False
extension	number	The extension of the phone number	False	False
type	string	Indicates the type of phone service, drawing from the RFC6350 list of types (text (for SMS), voice, fax, cell, video, pager, textphone).	False	False
language	string	A comma separated list of ISO 639-1, or ISO 639-2 [language codes](available at http://www.loc.gov/standards/iso639-2/php/code_list.php) to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	False	False
description	string	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	False	False
department	string	(Deprecated) The department for which this is the phone number. This field is deprecated and will be removed in a future version of HSDS.	False	False

contact¶

The contact table contains details of the named contacts for services and organizations. Note that in the HSDS data package format, if an individual is the contact for multiple services, their details may be duplicated multiple times in this table, each time with a new identifier, and with the rows containing different service ids.

name	contact
path	contacts.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each contact must have a unique identifier	True	True
organization_id	string	The identifier of the organization for which this is a contact	False	False
service_id	string	The identifier of the service for which this is a contact	False	False
service_at_location_id	string	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	False	False
name	string	The name of the person	False	False
title	string	The job title of the person	False	False
department	string	The department that the person is part of	False	False
email	string (email)	The email address of the person	False	False

physical_address¶

The addresses table contains the physical addresses for locations

name	physical_address
path	physical_addresses.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each physical address must have a unique identifier.	True	True
location_id	string	The identifier of the location for which this is the address.	False	False
attention	string	The person or entity whose attention should be sought at the location (Often included as ‘care of’ component of an address.)	False	False
address_1	string	The first line(s) of the address, including office, building number and street.	True	False
address_2	string	(Deprecated) A second (additional) line of address information. (This field is deprecated: we recommend including all address information before ‘city’ as a comma or newline separated list in address_1. There is no guarantee that systems will read this line of address information.)	False	False
address_3	string	(Deprecated) A third (additional) line of address information. (This field is deprecated: we recommend including all address information before ‘city’ as a comma or newline separated list in address_1. There is no guarantee that systems will read this line of address information.)	False	False
address_4	string	(Deprecated) The fourth (additional) line of address information. (This field is deprecated: we recommend including all address information before ‘city’ as a comma or newline separated list in address_1. There is no guarantee that systems will read this line of address information.)	False	False
city	string	The city in which the address is located.	True	False
region	string	The region in which the address is located (optional).	False	False
state_province	string	The state or province in which the address is located.	True	False
postal_code	string	The postal code for the address.	True	False
country	string	The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation).	True	False

postal_address¶

The postal_address table contains the postal addresses for mail to a certain location. This may differ from the physical location.

name	postal_address
path	postal_addresses.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each postal address must have a unique identifier	True	True
location_id	string	The identifier of the location for which this is the postal address.	False	False
attention	string	The person or entity whose attention should be sought at the location (Often included as ‘care of’ component of an address.)	False	False
address_1	string	The first line(s) of the address, including office, building number and street.	True	False
address_2	string	(Deprecated) A second (additional) line of address information. (This field is deprecated: we recommend including all address information before ‘city’ as a comma or newline separated list in address_1. There is no guarantee that systems will read this line of address information.)	False	False
address_3	string	(Deprecated) A third (additional) line of address information. (This field is deprecated: we recommend including all address information before ‘city’ as a comma or newline separated list in address_1. There is no guarantee that systems will read this line of address information.)	False	False
address_4	string	(Deprecated) The fourth (additional) line of address information. (This field is deprecated: we recommend including all address information before ‘city’ as a comma or newline separated list in address_1. There is no guarantee that systems will read this line of address information.)	False	False
city	string	The city in which the address is located.	True	False
region	string	The region in which the address is located (optional).	False	False
state_province	string	The state or province in which the address is located.	True	False
postal_code	string	The postal code for the address.	True	False
country	string	The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation)	True	False

schedule¶

The schedule table contains details of when a service or location is open. Entries are RFC 5545 RRULES.

name	schedule
path	schedules.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each entry must have a unique identifier	True	True
service_id	string	The identifier of the service for which this is the regular schedule	False	False
location_id	string	The identifier of the location for which this is the regular schedule	False	False
service_at_location_id	string	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	False	False
valid_from	date	The date from which the schedule information is valid.	False	False
valid_to	date	The last date on which the schedule information is valid.	False	False
dtstart	date	iCal - The date of the first event is the schedule. Necessary when using the ‘interval’ feature, optional otherwise.	False	False
timezone	number	The timezone that all dates are expressed as, expressed as a UTC offset. Dates are assumed to be UTC otherwise.	False	False
until	date	iCal - The date of the last occurence of the recurring event.	False	False
count	date	iCal - The number of times that the event occurs. Use this instead of ‘until’, if appropriate.	False	False
wkst	date	iCal - The day on which the week starts, eg MO.	False	False
freq	string	iCal - How often the frequency repeats. E.g. Frequency use one of WEEKLY or MONTHLY.	False	False
interval	number	iCal - How often the frequency repeats. E.g. Interval 2 for Frequency WEEKLY gives Fortnightly	False	False
byday	string	iCal - Comma seperated days of the week. E.g. SU,MO,TU,WE,TH,FR,SA. Where freq is MONTHLY each part can be preceded by a positive or negative integer to represent which occurrence in a month; e.g. 2MO is the second Monday in a month. -1FR is the last Friday	False	False
byweekno	string	iCal - Comma seperated numeric weeks of the year if freq is WEEKLY. Can be negative to represent weeks before the end of the year; e.g. -5 is the 5th to last week in a year.	False	False
bymonthday	number	iCal - Comma separated numeric days of the month if frequency is MONTHLY. Can be negative to represent days before the end of the month; e.g. -5 is the 5th to last day in a month.	False	False
byyearday	number	iCal - Comma separated numeric days of the month if frequency is YEARLY. Can be negative to represent days before the end of the year; e.g. -1 is the last day in a year.	False	False
description	string	Human readable description of the availability of the service.	False	False
opens_at	time	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am EST.)	False	False
closes_at	time	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am EST.)	False	False

funding¶

The funding table describes the sources of funding for a service or organisation

name	funding
path	funding.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each entry must have a unique identifier	True	True
organization_id	string	The identifier of the organization in receipt of this funding.	False	False
service_id	string	The identifier of the service in receipt of this funding	False	False
source	string	A free text description of the source of funds for this organization or service.	False	False

eligibility¶

The eligibility tables contains details of the eligibility criteria for particular services

name	eligibility
path	eligibility.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each entry must have a unique identifier	True	True
service_id	string	The identifier of the service for which this entry describes the eligibility criteria	False	False

service_area¶

The service_area table contains details of the geographic area for which a service is available.

name	service_area
path	service_areas.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each service area must have a unique identifier	True	True
service_id	string	The identifier of the service for which this entry describes the service area	False	False
service_area	string	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	False	False
description	string	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	False	False

required_document¶

The required_document table contains details of any documents that are required in order to access or use services.

name	required_document
path	required_documents.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each document must have a unique identifier	True	True
service_id	string	The identifier of the service for which this entry describes the required document	False	False
document	string	The document required to apply for or receive the service. e.g. ‘Government-issued ID’, ‘EU Passport’	False	False

payment_accepted¶

The payment_accepted table contains details of the methods of payment that can be used in order to pay for services

name	payment_accepted
path	payments_accepted.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each entry must have a unique identifier	True	True
service_id	string	The identifier of the services for which the entry describes the accepted payment methods	False	False
payment	string	The methods of payment accepted for the service	False	False

language¶

The language table contains details of the languages that are spoken at locations or services. This does not include languages which can only be used with interpretation.

name	language
path	languages.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each language must have a unique identifier	True	True
service_id	string	The identifier of the service for which the entry describes the languages in which services are delivered	False	False
location_id	string	The identifier of the location for which the entry describes the languages in which services are delivered	False	False
language	string	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.	False	False

accessibility_for_disabilities¶

The accessibility_for_disabilities table contains details of the arrangements for access to locations for people who have disabilities

name	accessibility_for_disabilities
path	accessibility_for_disabilities.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each entry must have a unique identifier	True	True
location_id	string	The identifier of the location for which the entry describes the accessibility provision	False	False
accessibility	string	Description of assistance or infrastructure that facilitate access to clients with disabilities.	False	False
details	string	Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.	False	False

taxonomy_term¶

Each service can be categorized according to one or more taxonomy terms. The taxonomy_term table contains a list of taxonomy terms, their names, and, for hierarchical taxonomies, their structure.

name	taxonomy_term
path	taxonomy_terms.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each taxonomy term must have a unique identifier, within the scope of the dataset	True	True
term	string	The taxonomy term itself.	True	False
description	string	What the term means	True	False
parent_id	string	If this is a child term in a hierarchical taxonomy, give the identifier of the parent category. For top-level categories, this should be left blank.	False	False
taxonomy	string	If this is an established taxonomy, detail which taxonomy is in use. For example, AIRS or Open Eligibility. If possible, provide a URI.	False	False
language	string	An ISO 639-1, or ISO 639-2 [language code](available at http://www.loc.gov/standards/iso639-2/php/code_list.php) to represent the language of the term. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	False	False

metadata¶

The metadata table contains a record of the changes that have been made to the data in order to maintain provenance information.

name	metadata
path	metadata.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each entry must have a unique identifier	True	True
resource_id	string	Each service, program. location, address, or contact will have a unique identifier.	True	True
resource_type	string	The type of entity being referenced	True	True
last_action_date	datetime	The date when data was changed.	True	False
last_action_type	string	The kind of change made to the data; eg create, update, delete	True	False
field_name	string	The name of field that has been modified	True	False
previous_value	string	The previous value of a field that has been updated	True	False
replacement_value	string	The new value of a field that has been updated	True	False
updated_by	string	The name of the person who updated a value	True	False

meta_table_description¶

The meta_table_description table contains metadata about individual tables.

name	meta_table_description
path	meta_table_descriptions.csv
format	csv
mediatype	text/csv

Field Name	Type (Format)	Description	Required?	Unique?
id	string	Each entry must have a unique identifier	True	True
name	string		False	False
language	string		False	False
character_set	string		False	False

Logical Model¶

There are four core tables in HSDS:

organization - that provide services;
service - that have descriptions, classifications and other information to allow potential service users to identify those services that can meet their needs;
location - where services are delivered - either physically, or virtually (over the phone or Internet);
service_at_location - a link table used to record where particular services are available, and to over-ride any default service or location information, with information specific to the service at a specific location.

Additional information about organizations, locations and services is held in separate tables and linked by a foreign key. Some tables only have a single foreign key for a single core table. Others can be linked to different core tables.

The table below indicates the foreign keys that exist.

Table	organization	service	location	service_at_location
program	X
service	X
service_attribute		X
service_at_location		X	X
location	X
phone*	X	X	X	X
contact	X	X		X
physical_address			X
postal_address			X
schedule		X	X	X
funding	X	X
service_taxonomy		X
eligibility		X
service_area		X
required_document		X
payment_accepted		X
language		X	X
accessibility_for_disabilities			X

*Phone can also be linked to contact.

When a single row contains multiple foreign keys, these must be interpreted as ‘OR’ relationships.

E.g. a phone number applies to the service OR the organisation OR the service_at_location.

ER Diagram¶

Click to enlarge

Variations & Interoperability¶

Like any standard, HSDS attempts to accomodation a wide range of applications, providing value to each application.

To this end, certain adaptations of the schema are permitted within the standard, and this results in interoperability considerations that must be considered when making design decisions for a particular system.

Tables-to-fields Transformation¶

If there is a situation where there is at most a 1:1 relationship in a particular system between items in two tables, where those items would be linked by IDs, then it is permitted within the standard for those tables to be merged. Column names should be retained.

If the system in question is part of a wider ecosystem, then the community around that ecosystem should agree on a common approach to interoperability around HSDS. For example - agreeing on a common set of tables, or agreeing that standard HSDS should be available for interchange purposes.

For example, if all ‘service’ entries have at most one fee entry, then you can just add a ‘fee’ column to the ‘service’ table.

Changelog¶

v0.0

No changes.

v0.1

Changes from comment period, workshop comments, and a running summary of comments
Directly references RFC4180 for CSV formatting

v0.2

Added related standards
Added use cases based on persona
Reformatted the controlled vocabulary.
Added a logical model
Made changes from comments collected during the second RFC period
Added Appendix C: Tabular Data Package description

v0.3

Refined logical model to conform to Boyce-Codd third normal form
Updated datapackage.json to match logical model
Included enumerations for entities in datapackage.json
Added section on NIEM and relation to specification
Made changes based on reviewer comments

v0.4 - v0.7

Updated data model based on reviewer comments
Tested logical model by importing data from iCarol database
Exported data in HSDS format from previous tes
Added Open Eligibility taxonomic overlay to logical model using Postgres ltree
Tested OE taxonomy by querying the service_taxonomy to return the related service
Provided test scripts and example data

v0.8

Added formatting specification for address, phone, description

v0.9

Changes based on public comments in v0.8 include:
- revising revising schedule entities and attributes as recommended,
- grammatical and punctuation edits,
- changing SMS attribute to a phone type
- changed language_line to interpretation_services
Released on github as a markdown document
Added a datapackage.json example on github

v1.0

Final version
Changed relationship between location and service from 1:n to n:m

v1.0.1

Bug fixes to schema and documentation
Removed redundant documentation pages

v1.1.0

Updated logical model: providing guidance on handling multiple foreign keys, and clarifying use of service_at_location;
Removing direct location_id from service so that services should always be connected to locations via the service_at_location table;
Adding the service_taxonomy table (missing from earlier releases);
Adding description to service_area;
Updates to the description of the funding table;
Updates to the address block to include region, and deprecate additional address fields;
Moving fees and interpretations into the service table;
Adding missing accreditations and licenses fields;
Adding a language field to phone;
Adding a missing primary key to the taxonomy table;
Fixing the foreign key on accessibility_for_disabilities;
Adding format validation for URIs and e-mail addresses to the schema;

v2.0

Renamed service_taxonomy table to service_attribute to apply terms to services;
Renamed taxonomy table to taxonomy_term;
Added taxonomy table to describe taxonomies;
Added other_attribute table to apply terms to non-service objects;
Renamed regular_schedule table to schedule;
Changed fields in schedule table to support RRULE-based entries;
Added non-normative guidance to documentation;
Clarified normative pages;
Added ways for standard to be adapted to particular use-cases;
Added guidance for extending the standard;
Improved consistency of constraints in schema;
Fixed various bugs relating to inconsistencies;
Added documentation to illustrate classifications and scheduling;
Added auto-building ERD

[v2.0.1]

Re-added erroneously removed opens_at and closes_at fields to schedule table;
Added further guidance on schedules in response to community feedback;
Added timezone and count RRULE fields to schedule table

Use Cases¶

Open Referral’s agenda is set by the prerogatives of a set of four types of users:

help seekers;
service providers;
researchers/analysts;
database administrators.

Read more about each of these personas in our User Personas documentation.

Current Human Services Data Specification Capabilities

The specification supports:

Provisioning the minimum amount of data needed to implement some method of search and discovery of services provided by organizations.
Provisioning ‘recommended’ fields to describe additional elements of data that may be relevant for various purposes related to service delivery and/or analysis.
Importing machine-readable data into a relational database
Exchanging resource data between different information-and-referral systems.
Viewing and editing data using commonly available software such as a spreadsheet or a text editor.

This page is non-normative, which means that it doesn’t form part of the standard; if there is any ambiguity, the standard takes precedence. This page may be updated at any time in response to community demand.¶

Schedules¶

The schedules table contains information about when a service is available.

Each schedule entry comprises three pieces of information:

An ID for the row
The opening times that are referred to
iCal RRULE-style fields that describe how often the opening times repeat.

Exceptional schedules¶

It’s common for a service to operate different hours over a certain period - such as a holiday.

If the service is offering additional opening hours to their regular hours, then a second entry can be added, with valid_from and valid_to set to indicate the limited range of dates that the additional hours apply for.

If the service is changing its hours, then set the valid_to value to the last day that the regular schedule is in operation, and add new entries for the service’s exceptional opening hours.

24h opening¶

HSDS doesn’t have a way to model this explicitly. If a service operates 24 hours a day, setting the opens_at and closes_at to 00:00 and 23:59 is a strong signal to any data users that the opening hours are known and 24h.

Worked Example¶

In this example, we’ll describe a service with ID 35 that’s available from 9-12 and 3-5, Monday to Thursday, every week. They know that they’ll change to a Christmas schedule in mid-December, so the schedule will be valid until then.

Note: Only relevant fields are shown, for clarity.

id	service_id	valid_from	valid_to	freq	byday		description	opens_at	closes_at
1098	35	2020-04-01	2020-12-20	“WEEKLY”	“MO,TU,WE,TH”		“Monday to Thursday, 9-12 am”	“09:00”	“12:00”
1099	35	2020-04-01	2020-12-20	“WEEKLY”	“MO,TU,WE,TH”		“Monday to Thursday, 3-5 pm”	“15:00”	“17:00”

Note that in this case, the non-iCal fields valid_from and valid_to have been provided to signify that this is the period that these opening hours are valid for. Consuming systems may infer from this that as the valid_to date approaches, they should seek to find out what future opening hours are for the service; they shouldn’t necessarily infer that a service has ended - just that they don’t have any more opening time information. This is in contrast to defining the service’s opening hours by use of the until iCal field, which explicitly defines the end of a recurring event, and therefore a consuming system may infer that the service is no longer available after that time.

During the year, they decide to open on the first Saturday of each month from July until November. So, they add another row:

id	service_id	valid_from	valid_to	dtstart	until	freq	byday	description	opens_at	closes_at
5435	35	null	null	2020-07-04	2020-11-07	“MONTHLY”	“1SA”	“First Saturday of the month from July-Nov, 9am-5pm”	“09:00”	“17:00”

Note that in this case the valid_from and valid_to dates aren’t supplied, because the RRULE is limited by its nature; it specifies when the series of events starts and ends.

This page is non-normative, which means that it doesn’t form part of the standard; if there is any ambiguity, the standard takes precedence. This page may be updated at any time in response to community demand.¶

Classifications, Attributes & Taxonomies¶

HSDS allows any major entity to have attributes attached. These attributes can be either properties of the entity, or classifications of the entity.

For services, the service_taxonomy table is used for this.

For all other entities, the link_taxonomy table is used.

Scope of HSDS¶

HSDS is focused on providing information about services; it is not designed to be a taxonomy interchange format. Therefore, the features provided by HSDS are intended to be sufficient for users to transfer enough information about a taxonomy to make the data about services be useful, but no more.

If, in a particular context, it’s helpful to transfer more information than HSDS has in scope, then HSDS is extensible, and you’re welcome to add additional information beyond the schema.

Terminology¶

Classification and description is an area in which terms are used inconsistently across domains and applications. Therefore, we define here certain terms which are used in the standard.

These definitions may be different from those that you’d use in your context, in which case we’d suggest prepending the term “OpenReferral” or “HSDS” to disambiguate. For example, if you’d call an “attribute” a “property”, then you might refer to an “HSDS Attribute”.

Vocabulary¶

A vocabulary is the set of words that are used in a language, which may have multiple meanings.

For example, the English language has around 170,000 terms in its vocabulary. The word “crane” can refer to a piece of machinery, a type of bird, or the action of overextending one’s neck in an attempt to see something that is otherwise obscured.

Alternatively a vocabulary of codes might be created for a particular purpose - such as “ES1098” and “87HG42”

Taxonomy¶

A taxonomy is a structure of terms drawn from a vocabulary which can be used to describe attributes of something.

For example, a taxonomy designed for use in the construction industry, called “construction machinery” might say that a particular piece of machinery is a “crane”, or an “86HG4”

In such a case, to say that a particular machine is a “construction machinery”->”crane” is meaningful.

Embedded Taxonomy¶

An embedded taxonomy is a taxonomy where the dataset contains the definition of the taxonomy terms used in the data; ie, to find out what a term means, you look within the dataset. It can be a clone of an external taxonomy, if licensing allows.

Data packages using HSDS shouldn’t contain any unused taxonomy terms, in particular if providing those terms would result in a package that comprises more taxonomy data than service data.

External Taxonomy¶

An external taxonomy is where the taxonomy is held outside of the data and the dataset ships with just references to the taxonomy; ie, to find out authoritatively what a term means, you look elsewhere.

Taxonomy Term¶

A taxonomy term is a particular instance of a term from a vocabulary which is given a particular meaning by a taxonomy.

For example, a taxonomy term might be “86HG4”, which the taxonomy describes as lifting equipment. It might be a child of “ES1098”, which is heavy machinery.

Attribute¶

An attribute is some property, fact, or assertion that is made of a thing.

For example, a particular piece of machinery might have some attributes:

Painted yellow
Has a government-issued plate declaring it to be ID “JG36QAK” and allowed to be driven on public roads
Is of type “crane”, from the taxonomy “construction machinery”

Attributes in HSDS are asserted by applying a taxonomy term to an object.

Applying a taxonomy term to an object¶

To apply a taxonomy term to an object, three things are required:

An entry in the taxonomy term table, containing the term
An entry in the relevant table, containing the entity
An entry in the relevant link table, linking the two

Example¶

(Note: only fields required for the example are shown)

services¶

First of all, some services.

id	name	description
89652	Kitten Time	Time with kittens
89654	Puppy Time	Time with puppies

taxonomy_terms¶

Then, some taxonomy terms.

id	term	description	taxonomy
918	stress	A service that helps with stress	http://taxonomy.example/
1045	WORKPLACE	Services that help in the workplace	My Local Taxonomy

programs¶

And finally, a program.

id	name
2767-ANIMAL-THERAPY	Animal Therapy Programme

service_attributes¶

We then use the service_attributes table to link the services with the appropriate taxonomy terms.

id	service_id	taxonomy_term_id
1	89652	918
2	89652	1045
3	89654	918
4	89654	1045

other_attributes¶

And finally, we use the other_attributes table to link the program with the appropriate taxonomy term.

id	link_id	link_type	taxonomy_term_id
1	89652	program	918
2	89654	program	918

This page is non-normative, which means that it doesn’t form part of the standard; if there is any ambiguity, the standard takes precedence. This page may be updated at any time in response to community demand.¶

Identifiers¶

The HSDS specification contains a lot of identifiers; this guide explains what they’re for and what good practice looks like around using them.

id fields¶

Each table in HSDS has an id field; as HSDS is designed to map onto a relational database, it’s a way of uniquely identifying every row in a table. For example, a service has an id, which service_at_location refers to as service_id. These IDs generally don’t have an external meaning, but are used within the data for tables to reference each other via foreign keys.

The organization table is a special case; because identifying organizations is a complex area, the standard stipulates that UUIDs must be used so as to prevent the use of external identifiers. This avoids, for example, issues such as companies changing their legal status and causing data quality issues as a result.

This page is non-normative, which means that it doesn’t form part of the standard; if there is any ambiguity, the standard takes precedence. This page may be updated at any time in response to community demand.¶

Extending HSDS¶

HSDS provides a common core for describing services, and includes a range of common fields, many of which are optional.

However, service provision is usually local, and so in a particular context there’s likely to be fields that aren’t relevant, and information that’s important but isn’t included in HSDS.

HSDS doesn’t have a formal extension mechanism, but does suggest several patterns in which communities wanting to share information among themselves can use HSDS as a starting point

Patterns¶

Constrain¶

Using the “constrain” pattern, a community can decide on certain fields or tables to not use at all.

Extend¶

Using the “extend” pattern, a community can decide on a common approach to including information that the schema doesn’t accomodate.

If a community chooses to extend the standard, then we encourage them to share their work with the wider OpenReferral community so that others facing similar issues can learn from them and provide feedback.

Constrain & Extend¶

The “constrain & extend” pattern combines the two previous patterns.

Principles¶

When extending, implementations should try to follow the design of HSDS as closely as possible.

If a field exists that’s close to one that you need, then it’s better to use it and describe how it’s used in your documentation.

Engaging the Community¶

The Open Referral community includes many people who’ve used HSDS in a range of contexts, from developing national ecosystems for sharing data, to deploying simple systems for use in low-tech community environments. They’re always happen to share their experience.

Developing the Standard¶

Extending the standard is a way to try out potential changes to the standard, so extensions play an important part in preparing for future releases.

This page is non-normative, which means that it doesn’t form part of the standard; if there is any ambiguity, the standard takes precedence. This page may be updated at any time in response to community demand.¶

Human Service Data API Suite (HSDA)¶

The Human Service Data API Suite (HSDA) consist of a set of protocols for accessing, updating, exchanging and synchronizing community resource directory data.

HSDA is one of the Open Referral specifications, and builds on HSDS. Open Referral’s goal is to enable interoperability among diverse technologies that might use resource directory information to help meet people’s needs.

When to use HSDA?

HSDA provides a family of OpenAPI specifications that can be used as a blueprint for the design or adaptation of API platforms to provide read or read/write access to information on organizations, services, locations and the details about them.

The core API protocol can be used by mobile apps, websites and other services to access individual resources, or listings. Providers can also support updates via API if they choose. In conjuction with the search protocol, this provides most of the functionality needed for simple access and exchange of data.

More complex data synchronization between distributed systems is supported through the additional protocols.

These specifications use the OpenAPI format. This is widely supported in a range of tools and software libraries.

The source of the specification is found on GitHub (openreferral/api-specification) and issues can be raised in the issue tracker here.

Overview¶

HSDA versioning is independent from HSDS. HSDA is currently in version 1.2

The Human Service Data API specifications consist of a core protocol and associated secondary protocols.

Core Protocol¶

The core HSDA protocol (HSDA) describes read/write functionality for the Open Referral’s Human Services Data Specification (HSDS), including resources for organizations, their locations, and their services. Through the HSDA Full protocol, third-parties can access entire contents of a database with a single call.

Find the core HSDA protocol in a YAML file here.

Secondary Protocols¶

HSDA v1.2 also includes complementary sets of “microservice” protocols that address specific user needs (as documented in user personas and use cases generated through our community’s participatory research process). This modular microservice approach enables specific protocols to be developed independently, while working complementarily in concert with each other.

Content Protocols¶

These secondary HSDA specifications facilitate the flow of resource directory data.

HSDA Search: the Search protocol is specifically designed for third-party software developers to enable their tools to query a resource database for specific sets of information.
HSDA Taxonomy: the Taxonomy protocol specifies the use of taxonomic schema for core resources. It can accommodate multiple classification formats.
HSDA Bulk: the Bulk protocol is specifically designed for database administrators to enable mass transfer of data between systems — with changelogs, scheduling, and other key features.

Administration Protocols:¶

These secondary specifications facilitate the monitoring, permissioning and associated management of a resource directory API platform. These are experimental features, and are subject to ongoing development.

HSDA Meta: the Meta protocol logs all activity across the above protocols. This data about API usage is sometimes known as ‘exhaust,’ or ‘paradata’ — valuable for both technical monitoring as well as research and analysis of community needs.
HSDA Management: the Management protocol specifies which users have access to what sections of the database, enabling API providers to have fine-grained control over their traffic.
HSDA Validator: tools for building and validating data schema to help stabilize operations.
HSDA Orchestration: the Orchestration protocol facilitates activities across and between HSDA protocols.

History¶

HSDA has been through a number of iterations during development:

HSDA v1.1 is accessible for reference.

Prior to HSDA, the Ohana API acted as a reference implementation of an early version the Human Services Data Spec, and it was used as one of the inputs to the recent API development process. Systems based on Ohana will need to be updated to follow the new HSDA specifications.

Acknowledgments¶

The HSDA has been designed by @kinlane, the API Evangelist, with guidance from a range of contributors in the Open Referral network.

The first cycle of HSDA’s development was made possible by support from the Digital Impact program at Stanford’s Center for Philanthropy and Civil Society.

Components¶

HSDA¶

The core HSDA protocol is defined by openapi-hsda.yaml. The details below show the available methods and responses.

You can also explore this using our OpenAPI viewer.

General principles

Applications should always support GET, but may choose whether or not to support POST. PUT and DELETE requests;
Each resource is named after a table in HSDS, and field names and definitions follow HSDS definitions;
Most resources have a /complete/ version which should be populated with content from linked tables to provide consumers with access to contextually relevant data;

GET /contacts/¶

Get all contacts

Returns a list of all registered contacts with filtering support

Query Parameters

query (string) – A query to filter list by (up to provider to determine what to search)
queries (string) – A comma separate list of queries with specific fields.
page (number) – The particular page of results.
per_page (number) – Number of records to return per page, up to 100.
sort_by (string) – Which field to sort by.
order (string) – Which order to sort by (asc,desc).

Status Codes

200 OK – Contact Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

POST /contacts/¶

Add contact

Creates a new named contact entry for services or organizations

Status Codes

200 OK – Contact Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

GET /contacts/complete/¶

Get all contacts with full details

Returns a list of contacts with full details and filtering support

Query Parameters

query (string) – A query to filter list by (up to provider to determine what to search)
queries (string) – A comma separate list of queries with specific fields.
page (number) – The particular page of results.
per_page (number) – Number of records to return per page, up to 100.
sort_by (string) – Which field to sort by.
order (string) – Which order to sort by (asc,desc).

Status Codes

200 OK – Contact Complete Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

POST /contacts/complete/¶

Add contact with full details

Creates a new contact entry with full details

Status Codes

200 OK – Contact Complete Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

GET /contacts/complete/{contact_id}/¶

Get contact with full details

Returns a contact entry with full details

Parameters

contact_id (string) – The contact id.

Status Codes

200 OK – Contact Complete Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

PUT /contacts/complete/{contact_id}/¶

Update contact with full details

Updates a contact entry with full details

Parameters

contact_id (string) – The contact id.

Status Codes

200 OK – Contact Complete Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

DELETE /contacts/complete/{contact_id}/¶

Delete contact with full details

Deletes a contact entry with full details

Parameters

contact_id (string) – The contact id.

Status Codes

200 OK – Contact Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

GET /contacts/{contact_id}/¶

Get contact

Returns a contact entry by its Id

Parameters

contact_id (string) – The contact id.

Status Codes

200 OK – Contact Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

PUT /contacts/{contact_id}/¶

Update a contact

Updates an existing contact by Id

Parameters

contact_id (string) – The contact id.

Status Codes

200 OK – Contact Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

DELETE /contacts/{contact_id}/¶

Delete contact

Deletes a contact by Id

Parameters

contact_id (string) – The contact id.

Status Codes

200 OK – Contact Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

GET /contacts/{contact_id}/phones/¶

Get all phones for contact

Returns a list of phones associated with a specific contact

Parameters

contact_id (string) – The unique contact id.

Status Codes

200 OK – Phone Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

POST /contacts/{contact_id}/phones/¶

Add phone for contact

Adds a new phone that is associated with a specific contact Id

Parameters

contact_id (string) – The unique contact id.

Status Codes

200 OK – Phone Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

GET /contacts/{contact_id}/phones/{phone_id}/¶

Get phone for contact

Returns the specific phone entity associated with a specific contact

Parameters

contact_id (string) – The unique contact id.
phone_id (string) – The unique phone id.

Status Codes

200 OK – Contact Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

PUT /contacts/{contact_id}/phones/{phone_id}/¶

Update phone for contact

Updates an existing contact’s phone entry

Parameters

contact_id (string) – The unique contact id.
phone_id (string) – The unique phone id.

Status Codes

200 OK – Phone Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

DELETE /contacts/{contact_id}/phones/{phone_id}/¶

Delete phone for contact

Deletes a specific phone instance associated with a specific contact Id

Parameters

contact_id (string) – The unique contact id.
phone_id (string) – The unique phone id.

Status Codes

200 OK – Phone Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

GET /locations/¶

Get all locations

Returns a list of locations with filtering support

Query Parameters

query (string) – A query to filter list by (up to provider to determine what to search)
queries (string) – A comma separate list of queries with specific fields.
page (number) – The particular page of results.
per_page (number) – Amount of locations to return per page, up to 100.
sort_by (string) – Which field to sort by.
order (string) – Which order to sort by (asc,desc).

Status Codes

200 OK – Location Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each location must have a unique identifier.	string	True
`organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`name`
	The name of the location.	string	True
`alternate_name`
	An alternative name for the location.	string	False
`description`
	A description of this location.	string	False
`transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False

POST /locations/¶

Add location

Creates a new location entry

Status Codes

200 OK – Location Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each location must have a unique identifier.	string	True
`organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`name`
	The name of the location.	string	True
`alternate_name`
	An alternative name for the location.	string	False
`description`
	A description of this location.	string	False
`transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False

GET /locations/complete/¶

Get all locations with full details

Returns a list of locations with full details and filtering support

Query Parameters

query (string) – A query to filter list by (up to provider to determine what to search)
queries (string) – A comma separate list of queries with specific fields.
page (number) – The particular page of results.
per_page (number) – Number of records to return per page, up to 100.
sort_by (string) – Which field to sort by.
order (string) – Which order to sort by (asc,desc).

Status Codes

200 OK – Location Complete Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each location must have a unique identifier.	string	True
`organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`name`
	The name of the location.	string	False
`alternate_name`
	An alternative name for the location.	string	False
`description`
	A description of this location.	string	False
`transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`languages/0/id`
	Each language must have a unique identifier.	string	True
`languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`postal_address/0/id`
	Each postal address must have a unique identifier.	string	True
`postal_address/0/location_id`
	The identifier of the location for which this is the postal address.	string	False
`postal_address/0/attention`
	The person or entity for whose attention mail should be marked.	string	False
`postal_address/0/address_1`
	The first line of the address.	string	False
`postal_address/0/address_2`
	The second line of the address.	string	False
`postal_address/0/address_3`
	The third line of the address.	string	False
`postal_address/0/address_4`
	The fourth line of the address.	string	False
`postal_address/0/city`
	The city in which the address is located.	string	False
`postal_address/0/region`
	The region in which the address is located (optional).	string	False
`postal_address/0/state_province`
	The state or province in which the address is located.	string	False
`postal_address/0/postal_code`
	The postal code for the address.	string	False
`postal_address/0/country`
	The country in which the address is located.	string	False
`physical_address/0/id`
	Each physical address must have a unique identifier.	string	True
`physical_address/0/location_id`
	The identifier of the location for which this is the address.	string	False
`physical_address/0/attention`
	The person or entity whose attention should be sought at the location.	string	False
`physical_address/0/address_1`
	The first line of the address.	string	True
`physical_address/0/address_2`
	The second line of the address.	string	False
`physical_address/0/address_3`
	The third line of the address.	string	False
`physical_address/0/address_4`
	The fourth line of the address.	string	False
`physical_address/0/city`
	The city in which the address is located.	string	True
`physical_address/0/region`
	The region in which the address is located (optional).	string	False
`physical_address/0/state_province`
	The state or province in which the address is located.	string	True
`physical_address/0/postal_code`
	The postal code for the address.	string	True
`physical_address/0/country`
	The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation).	string	True
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`service/0/id`
	Each service must have a unique identifier.	string	False
`service/0/organization_id`
	The identifier of the organization that provides this service.	string	False
`service/0/program_id`
	The identifier of the program this service is delivered under.	string	False
`service/0/location_id`
	The identifier of the location where this service is delivered.	string	False
`service/0/name`
	The official or public name of the service.	string	False
`service/0/alternate_name`
	Alternative or commonly used name for a service.	string	False
`service/0/description`
	A description of the service.	string	False
`service/0/url`
	URL of the service.	string	False
`service/0/email`
	Email address for the service.	string	False
`service/0/status`
	The current status of the service.	string	False
`service/0/interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`service/0/application_process`
	The steps needed to access the service.	string	False
`service/0/wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`service/0/fees`
	Details of any charges for service users to access this service.	string	False
`service/0/accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`service/0/licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`accessibility_for_disabilities/0/id`
	Each entry must have a unique identifier.	string	True
`accessibility_for_disabilities/0/location_id`
	The identifier of the location for which the entry describes the accessibility provision.	string	False
`accessibility_for_disabilities/0/accessibility`
	Description of assistance or infrastructure that facilitate access to clients with disabilities.	string	False
`accessibility_for_disabilities/0/details`
	Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.	string	False

POST /locations/complete/¶

Add location with full details

Creates a new location entry with full details

Status Codes

200 OK – Location Complete Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each location must have a unique identifier.	string	True
`organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`name`
	The name of the location.	string	False
`alternate_name`
	An alternative name for the location.	string	False
`description`
	A description of this location.	string	False
`transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`languages/0/id`
	Each language must have a unique identifier.	string	True
`languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`postal_address/0/id`
	Each postal address must have a unique identifier.	string	True
`postal_address/0/location_id`
	The identifier of the location for which this is the postal address.	string	False
`postal_address/0/attention`
	The person or entity for whose attention mail should be marked.	string	False
`postal_address/0/address_1`
	The first line of the address.	string	False
`postal_address/0/address_2`
	The second line of the address.	string	False
`postal_address/0/address_3`
	The third line of the address.	string	False
`postal_address/0/address_4`
	The fourth line of the address.	string	False
`postal_address/0/city`
	The city in which the address is located.	string	False
`postal_address/0/region`
	The region in which the address is located (optional).	string	False
`postal_address/0/state_province`
	The state or province in which the address is located.	string	False
`postal_address/0/postal_code`
	The postal code for the address.	string	False
`postal_address/0/country`
	The country in which the address is located.	string	False
`physical_address/0/id`
	Each physical address must have a unique identifier.	string	True
`physical_address/0/location_id`
	The identifier of the location for which this is the address.	string	False
`physical_address/0/attention`
	The person or entity whose attention should be sought at the location.	string	False
`physical_address/0/address_1`
	The first line of the address.	string	True
`physical_address/0/address_2`
	The second line of the address.	string	False
`physical_address/0/address_3`
	The third line of the address.	string	False
`physical_address/0/address_4`
	The fourth line of the address.	string	False
`physical_address/0/city`
	The city in which the address is located.	string	True
`physical_address/0/region`
	The region in which the address is located (optional).	string	False
`physical_address/0/state_province`
	The state or province in which the address is located.	string	True
`physical_address/0/postal_code`
	The postal code for the address.	string	True
`physical_address/0/country`
	The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation).	string	True
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`service/0/id`
	Each service must have a unique identifier.	string	False
`service/0/organization_id`
	The identifier of the organization that provides this service.	string	False
`service/0/program_id`
	The identifier of the program this service is delivered under.	string	False
`service/0/location_id`
	The identifier of the location where this service is delivered.	string	False
`service/0/name`
	The official or public name of the service.	string	False
`service/0/alternate_name`
	Alternative or commonly used name for a service.	string	False
`service/0/description`
	A description of the service.	string	False
`service/0/url`
	URL of the service.	string	False
`service/0/email`
	Email address for the service.	string	False
`service/0/status`
	The current status of the service.	string	False
`service/0/interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`service/0/application_process`
	The steps needed to access the service.	string	False
`service/0/wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`service/0/fees`
	Details of any charges for service users to access this service.	string	False
`service/0/accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`service/0/licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`accessibility_for_disabilities/0/id`
	Each entry must have a unique identifier.	string	True
`accessibility_for_disabilities/0/location_id`
	The identifier of the location for which the entry describes the accessibility provision.	string	False
`accessibility_for_disabilities/0/accessibility`
	Description of assistance or infrastructure that facilitate access to clients with disabilities.	string	False
`accessibility_for_disabilities/0/details`
	Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.	string	False

GET /locations/complete/{location_id}/¶

Get location with full details

Returns a location entry with full details

Parameters

location_id (string) – The location id.

Status Codes

200 OK – Location Complete Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each location must have a unique identifier.	string	True
`organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`name`
	The name of the location.	string	False
`alternate_name`
	An alternative name for the location.	string	False
`description`
	A description of this location.	string	False
`transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`languages/0/id`
	Each language must have a unique identifier.	string	True
`languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`postal_address/0/id`
	Each postal address must have a unique identifier.	string	True
`postal_address/0/location_id`
	The identifier of the location for which this is the postal address.	string	False
`postal_address/0/attention`
	The person or entity for whose attention mail should be marked.	string	False
`postal_address/0/address_1`
	The first line of the address.	string	False
`postal_address/0/address_2`
	The second line of the address.	string	False
`postal_address/0/address_3`
	The third line of the address.	string	False
`postal_address/0/address_4`
	The fourth line of the address.	string	False
`postal_address/0/city`
	The city in which the address is located.	string	False
`postal_address/0/region`
	The region in which the address is located (optional).	string	False
`postal_address/0/state_province`
	The state or province in which the address is located.	string	False
`postal_address/0/postal_code`
	The postal code for the address.	string	False
`postal_address/0/country`
	The country in which the address is located.	string	False
`physical_address/0/id`
	Each physical address must have a unique identifier.	string	True
`physical_address/0/location_id`
	The identifier of the location for which this is the address.	string	False
`physical_address/0/attention`
	The person or entity whose attention should be sought at the location.	string	False
`physical_address/0/address_1`
	The first line of the address.	string	True
`physical_address/0/address_2`
	The second line of the address.	string	False
`physical_address/0/address_3`
	The third line of the address.	string	False
`physical_address/0/address_4`
	The fourth line of the address.	string	False
`physical_address/0/city`
	The city in which the address is located.	string	True
`physical_address/0/region`
	The region in which the address is located (optional).	string	False
`physical_address/0/state_province`
	The state or province in which the address is located.	string	True
`physical_address/0/postal_code`
	The postal code for the address.	string	True
`physical_address/0/country`
	The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation).	string	True
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`service/0/id`
	Each service must have a unique identifier.	string	False
`service/0/organization_id`
	The identifier of the organization that provides this service.	string	False
`service/0/program_id`
	The identifier of the program this service is delivered under.	string	False
`service/0/location_id`
	The identifier of the location where this service is delivered.	string	False
`service/0/name`
	The official or public name of the service.	string	False
`service/0/alternate_name`
	Alternative or commonly used name for a service.	string	False
`service/0/description`
	A description of the service.	string	False
`service/0/url`
	URL of the service.	string	False
`service/0/email`
	Email address for the service.	string	False
`service/0/status`
	The current status of the service.	string	False
`service/0/interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`service/0/application_process`
	The steps needed to access the service.	string	False
`service/0/wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`service/0/fees`
	Details of any charges for service users to access this service.	string	False
`service/0/accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`service/0/licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`accessibility_for_disabilities/0/id`
	Each entry must have a unique identifier.	string	True
`accessibility_for_disabilities/0/location_id`
	The identifier of the location for which the entry describes the accessibility provision.	string	False
`accessibility_for_disabilities/0/accessibility`
	Description of assistance or infrastructure that facilitate access to clients with disabilities.	string	False
`accessibility_for_disabilities/0/details`
	Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.	string	False

PUT /locations/complete/{location_id}/¶

Update location with full details

Updates a location entry with full details

Parameters

location_id (string) – The location id.

Status Codes

200 OK – Location Complete Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each location must have a unique identifier.	string	True
`organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`name`
	The name of the location.	string	False
`alternate_name`
	An alternative name for the location.	string	False
`description`
	A description of this location.	string	False
`transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`languages/0/id`
	Each language must have a unique identifier.	string	True
`languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`postal_address/0/id`
	Each postal address must have a unique identifier.	string	True
`postal_address/0/location_id`
	The identifier of the location for which this is the postal address.	string	False
`postal_address/0/attention`
	The person or entity for whose attention mail should be marked.	string	False
`postal_address/0/address_1`
	The first line of the address.	string	False
`postal_address/0/address_2`
	The second line of the address.	string	False
`postal_address/0/address_3`
	The third line of the address.	string	False
`postal_address/0/address_4`
	The fourth line of the address.	string	False
`postal_address/0/city`
	The city in which the address is located.	string	False
`postal_address/0/region`
	The region in which the address is located (optional).	string	False
`postal_address/0/state_province`
	The state or province in which the address is located.	string	False
`postal_address/0/postal_code`
	The postal code for the address.	string	False
`postal_address/0/country`
	The country in which the address is located.	string	False
`physical_address/0/id`
	Each physical address must have a unique identifier.	string	True
`physical_address/0/location_id`
	The identifier of the location for which this is the address.	string	False
`physical_address/0/attention`
	The person or entity whose attention should be sought at the location.	string	False
`physical_address/0/address_1`
	The first line of the address.	string	True
`physical_address/0/address_2`
	The second line of the address.	string	False
`physical_address/0/address_3`
	The third line of the address.	string	False
`physical_address/0/address_4`
	The fourth line of the address.	string	False
`physical_address/0/city`
	The city in which the address is located.	string	True
`physical_address/0/region`
	The region in which the address is located (optional).	string	False
`physical_address/0/state_province`
	The state or province in which the address is located.	string	True
`physical_address/0/postal_code`
	The postal code for the address.	string	True
`physical_address/0/country`
	The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation).	string	True
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`service/0/id`
	Each service must have a unique identifier.	string	False
`service/0/organization_id`
	The identifier of the organization that provides this service.	string	False
`service/0/program_id`
	The identifier of the program this service is delivered under.	string	False
`service/0/location_id`
	The identifier of the location where this service is delivered.	string	False
`service/0/name`
	The official or public name of the service.	string	False
`service/0/alternate_name`
	Alternative or commonly used name for a service.	string	False
`service/0/description`
	A description of the service.	string	False
`service/0/url`
	URL of the service.	string	False
`service/0/email`
	Email address for the service.	string	False
`service/0/status`
	The current status of the service.	string	False
`service/0/interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`service/0/application_process`
	The steps needed to access the service.	string	False
`service/0/wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`service/0/fees`
	Details of any charges for service users to access this service.	string	False
`service/0/accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`service/0/licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`accessibility_for_disabilities/0/id`
	Each entry must have a unique identifier.	string	True
`accessibility_for_disabilities/0/location_id`
	The identifier of the location for which the entry describes the accessibility provision.	string	False
`accessibility_for_disabilities/0/accessibility`
	Description of assistance or infrastructure that facilitate access to clients with disabilities.	string	False
`accessibility_for_disabilities/0/details`
	Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.	string	False

GET /locations/{location_id}/¶

Get location

Returns a location entry by Id

Parameters

location_id (string) – The location id.

Status Codes

200 OK – Location Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each location must have a unique identifier.	string	True
`organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`name`
	The name of the location.	string	True
`alternate_name`
	An alternative name for the location.	string	False
`description`
	A description of this location.	string	False
`transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False

PUT /locations/{location_id}/¶

Update location

Updates a location entry

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Location Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each location must have a unique identifier.	string	True
`organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`name`
	The name of the location.	string	True
`alternate_name`
	An alternative name for the location.	string	False
`description`
	A description of this location.	string	False
`transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False

DELETE /locations/{location_id}/¶

Delete location

Deletes a location entry

Parameters

location_id (string) – The location id.

Status Codes

200 OK – Location Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each location must have a unique identifier.	string	True
`organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`name`
	The name of the location.	string	True
`alternate_name`
	An alternative name for the location.	string	False
`description`
	A description of this location.	string	False
`transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False

GET /locations/{location_id}/holiday-schedule/¶

Get all holiday schedules for a location

Returns the list of holiday schedules for a specific location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Holiday Schedule Response
404 Not Found – Not Found Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True

POST /locations/{location_id}/holiday-schedule/¶

Add holiday schedule for location

Creates a new holiday schedule entry for a location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Holiday Schedule Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True

GET /locations/{location_id}/holiday-schedule/{holiday_schedule_id}/¶

Get holiday schedule for location

Returns a specific holiday schedule for a location by Id

Parameters

location_id (string) – The unique location id.
holiday_schedule_id (string) – The unique holiday schedule id.

Status Codes

200 OK – Holiday Schedule Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True

PUT /locations/{location_id}/holiday-schedule/{holiday_schedule_id}/¶

Update holiday schedule for location

Updates a holiday schedule entry for a location

Parameters

location_id (string) – The unique location id.
holiday_schedule_id (string) – The unique holiday schedule id.

Status Codes

200 OK – Holiday Schedule Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True

DELETE /locations/{location_id}/holiday-schedule/{holiday_schedule_id}/¶

Delete holiday schedule for location

Deletes a holiday schedule entry for a location

Parameters

location_id (string) – The unique location id.
holiday_schedule_id (string) – The unique holiday schdule id.

Status Codes

200 OK – Holiday Schedule Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True

GET /locations/{location_id}/languages/¶

Get all languages for a location

Returns a list of all languages supported by a location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Language Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each language must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False

POST /locations/{location_id}/languages/¶

Add language for location

Adds a new language entry for a location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Language Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each language must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False

GET /locations/{location_id}/languages/{language_id}/¶

Get language for location

Returns a specific language entry for a specific location by Id

Parameters

location_id (string) – The unique location id.
language_id (string) – The unique language id.

Status Codes

200 OK – Language Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each language must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False

PUT /locations/{location_id}/languages/{language_id}/¶

Update a language for a location

Updates a language entry for a specific location

Parameters

location_id (string) – The unique location id.
language_id (string) – The unique language id.

Status Codes

200 OK – Language Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each language must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False

DELETE /locations/{location_id}/languages/{language_id}/¶

Delete language for location

Deletes a language entry for a specific location

Parameters

location_id (string) – The unique location id.
language_id (string) – The unique language id.

Status Codes

200 OK – Language Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each language must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False

GET /locations/{location_id}/postal-address/¶

Get all postal addresses of a location

Returns a list of postal addresses for a location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Postal Address Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each postal address must have a unique identifier.	string	True
`location_id`
	The identifier of the location for which this is the postal address.	string	False
`attention`
	The person or entity for whose attention mail should be marked.	string	False
`address_1`
	The first line of the address.	string	False
`address_2`
	The second line of the address.	string	False
`address_3`
	The third line of the address.	string	False
`address_4`
	The fourth line of the address.	string	False
`city`
	The city in which the address is located.	string	False
`region`
	The region in which the address is located (optional).	string	False
`state_province`
	The state or province in which the address is located.	string	False
`postal_code`
	The postal code for the address.	string	False
`country`
	The country in which the address is located.	string	False

POST /locations/{location_id}/postal-address/¶

Add postal address for location

Creates a new postal address for a specific location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Postal Address Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each postal address must have a unique identifier.	string	True
`location_id`
	The identifier of the location for which this is the postal address.	string	False
`attention`
	The person or entity for whose attention mail should be marked.	string	False
`address_1`
	The first line of the address.	string	False
`address_2`
	The second line of the address.	string	False
`address_3`
	The third line of the address.	string	False
`address_4`
	The fourth line of the address.	string	False
`city`
	The city in which the address is located.	string	False
`region`
	The region in which the address is located (optional).	string	False
`state_province`
	The state or province in which the address is located.	string	False
`postal_code`
	The postal code for the address.	string	False
`country`
	The country in which the address is located.	string	False

GET /locations/{location_id}/postal-address/{postal_address_id}/¶

Get postal address for location

Returns a postal address entry for a specific location

Parameters

location_id (string) – The unique location id.
postal_address_id (string) – The unique postal address id.

Status Codes

200 OK – Postal Address Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each postal address must have a unique identifier.	string	True
`location_id`
	The identifier of the location for which this is the postal address.	string	False
`attention`
	The person or entity for whose attention mail should be marked.	string	False
`address_1`
	The first line of the address.	string	False
`address_2`
	The second line of the address.	string	False
`address_3`
	The third line of the address.	string	False
`address_4`
	The fourth line of the address.	string	False
`city`
	The city in which the address is located.	string	False
`region`
	The region in which the address is located (optional).	string	False
`state_province`
	The state or province in which the address is located.	string	False
`postal_code`
	The postal code for the address.	string	False
`country`
	The country in which the address is located.	string	False

PUT /locations/{location_id}/postal-address/{postal_address_id}/¶

Update postal address for location

Updates a postal address entry for a specific location

Parameters

location_id (string) – The unique location id.
postal_address_id (string) – The unique postal address id.

Status Codes

200 OK – Postal Address Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each postal address must have a unique identifier.	string	True
`location_id`
	The identifier of the location for which this is the postal address.	string	False
`attention`
	The person or entity for whose attention mail should be marked.	string	False
`address_1`
	The first line of the address.	string	False
`address_2`
	The second line of the address.	string	False
`address_3`
	The third line of the address.	string	False
`address_4`
	The fourth line of the address.	string	False
`city`
	The city in which the address is located.	string	False
`region`
	The region in which the address is located (optional).	string	False
`state_province`
	The state or province in which the address is located.	string	False
`postal_code`
	The postal code for the address.	string	False
`country`
	The country in which the address is located.	string	False

DELETE /locations/{location_id}/postal-address/{postal_address_id}/¶

Delete postal address for location

Deletes a postal adress entry for a specific location

Parameters

location_id (string) – The unique location id.
postal_address_id (string) – The unique postal address id.

Status Codes

200 OK – Postal Address Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each postal address must have a unique identifier.	string	True
`location_id`
	The identifier of the location for which this is the postal address.	string	False
`attention`
	The person or entity for whose attention mail should be marked.	string	False
`address_1`
	The first line of the address.	string	False
`address_2`
	The second line of the address.	string	False
`address_3`
	The third line of the address.	string	False
`address_4`
	The fourth line of the address.	string	False
`city`
	The city in which the address is located.	string	False
`region`
	The region in which the address is located (optional).	string	False
`state_province`
	The state or province in which the address is located.	string	False
`postal_code`
	The postal code for the address.	string	False
`country`
	The country in which the address is located.	string	False

GET /locations/{location_id}/physical-address/¶

Get physical addresses for location

Returns a list of physical addresses for a specific location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Postal Address Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each postal address must have a unique identifier.	string	True
`location_id`
	The identifier of the location for which this is the postal address.	string	False
`attention`
	The person or entity for whose attention mail should be marked.	string	False
`address_1`
	The first line of the address.	string	False
`address_2`
	The second line of the address.	string	False
`address_3`
	The third line of the address.	string	False
`address_4`
	The fourth line of the address.	string	False
`city`
	The city in which the address is located.	string	False
`region`
	The region in which the address is located (optional).	string	False
`state_province`
	The state or province in which the address is located.	string	False
`postal_code`
	The postal code for the address.	string	False
`country`
	The country in which the address is located.	string	False

POST /locations/{location_id}/physical-address/¶

Add physical address for location

Creates a new phsycial address entry for a specific location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Postal Address Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each postal address must have a unique identifier.	string	True
`location_id`
	The identifier of the location for which this is the postal address.	string	False
`attention`
	The person or entity for whose attention mail should be marked.	string	False
`address_1`
	The first line of the address.	string	False
`address_2`
	The second line of the address.	string	False
`address_3`
	The third line of the address.	string	False
`address_4`
	The fourth line of the address.	string	False
`city`
	The city in which the address is located.	string	False
`region`
	The region in which the address is located (optional).	string	False
`state_province`
	The state or province in which the address is located.	string	False
`postal_code`
	The postal code for the address.	string	False
`country`
	The country in which the address is located.	string	False

GET /locations/{location_id}/physical-address/{postal_address_id}/¶

Get physical address for location

Returns a physical address entry for a specific location

Parameters

location_id (string) – The unique location id.
postal_address_id (string) – The unique postal address id.

Status Codes

200 OK – Postal Address Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each postal address must have a unique identifier.	string	True
`location_id`
	The identifier of the location for which this is the postal address.	string	False
`attention`
	The person or entity for whose attention mail should be marked.	string	False
`address_1`
	The first line of the address.	string	False
`address_2`
	The second line of the address.	string	False
`address_3`
	The third line of the address.	string	False
`address_4`
	The fourth line of the address.	string	False
`city`
	The city in which the address is located.	string	False
`region`
	The region in which the address is located (optional).	string	False
`state_province`
	The state or province in which the address is located.	string	False
`postal_code`
	The postal code for the address.	string	False
`country`
	The country in which the address is located.	string	False

PUT /locations/{location_id}/physical-address/{postal_address_id}/¶

Update physical address for location

Updates a physical address entry for a specific location

Parameters

location_id (string) – The unique location id.
postal_address_id (string) – The unique postal address id.

Status Codes

200 OK – Postal Address Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each postal address must have a unique identifier.	string	True
`location_id`
	The identifier of the location for which this is the postal address.	string	False
`attention`
	The person or entity for whose attention mail should be marked.	string	False
`address_1`
	The first line of the address.	string	False
`address_2`
	The second line of the address.	string	False
`address_3`
	The third line of the address.	string	False
`address_4`
	The fourth line of the address.	string	False
`city`
	The city in which the address is located.	string	False
`region`
	The region in which the address is located (optional).	string	False
`state_province`
	The state or province in which the address is located.	string	False
`postal_code`
	The postal code for the address.	string	False
`country`
	The country in which the address is located.	string	False

DELETE /locations/{location_id}/physical-address/{postal_address_id}/¶

Delete a physical address for a location

Deletes a phsysical address entry for a specific location

Parameters

location_id (string) – The unique location id.
postal_address_id (string) – The unique postal address id.

Status Codes

200 OK – Postal Address Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each postal address must have a unique identifier.	string	True
`location_id`
	The identifier of the location for which this is the postal address.	string	False
`attention`
	The person or entity for whose attention mail should be marked.	string	False
`address_1`
	The first line of the address.	string	False
`address_2`
	The second line of the address.	string	False
`address_3`
	The third line of the address.	string	False
`address_4`
	The fourth line of the address.	string	False
`city`
	The city in which the address is located.	string	False
`region`
	The region in which the address is located (optional).	string	False
`state_province`
	The state or province in which the address is located.	string	False
`postal_code`
	The postal code for the address.	string	False
`country`
	The country in which the address is located.	string	False

GET /locations/{location_id}/phones/¶

Get all phones for a location

Returns a list of all phones for a location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Phone Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

POST /locations/{location_id}/phones/¶

Add phone for location

Creates a new phone entry for a specific location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Phone Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

GET /locations/{location_id}/phones/{phone_id}/¶

Get phone for location

Returns a phone entry for a specific location

Parameters

location_id (string) – The unique location id.
phone_id (string) – The unique phone id.

Status Codes

200 OK – Phone Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

PUT /locations/{location_id}/phones/{phone_id}/¶

Update phone for location

Updates a phone entry for a location

Parameters

location_id (string) – The unique location id.
phone_id (string) – The unique phone id.

Status Codes

200 OK – Phone Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

DELETE /locations/{location_id}/phones/{phone_id}/¶

Delete phone for location

Deletes a phone entry for a location

Parameters

location_id (string) – The unique location id.
phone_id (string) – The unique phone id.

Status Codes

200 OK – Phone Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

GET /locations/{location_id}/regular-schedule/¶

Get all regular schedules for a location

Returns a list of regular schedules for a specific location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Regular Schedule Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`weekday`
	The day of the week that this entry relates to.	string	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False

POST /locations/{location_id}/regular-schedule/¶

Add regular schedule for location

Creates a regular schedule entry for a specific location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Regular Schedule Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`weekday`
	The day of the week that this entry relates to.	string	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False

GET /locations/{location_id}/regular-schedule/{regular_schedule_id}/¶

Get regular schedule for location

Returns a regular schedule entry for a specific location

Parameters

location_id (string) – The unique location id.
regular_schedule_id (string) – The unique regular schedule id.

Status Codes

200 OK – Regular Schedule Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`weekday`
	The day of the week that this entry relates to.	string	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False

PUT /locations/{location_id}/regular-schedule/{regular_schedule_id}/¶

Update regular schedule for location

Updates a regular schedule entry for a location

Parameters

location_id (string) – The unique location id.
regular_schedule_id (string) – The unique regular schedule id.

Status Codes

200 OK – Regular Schedule Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`weekday`
	The day of the week that this entry relates to.	string	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False

DELETE /locations/{location_id}/regular-schedule/{regular_schedule_id}/¶

Delete regular schedule for location

Deletes a regular schedule entry for a location

Parameters

location_id (string) – The unique location id.
regular_schedule_id (string) – The unique regular schedule id.

Status Codes

200 OK – Regular Schedule Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`weekday`
	The day of the week that this entry relates to.	string	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False

GET /locations/{location_id}/services/¶

Get all services for location

Returns a list of all services for a location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Service Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

POST /locations/{location_id}/services/¶

Add service for location

Creates a new service entry for a specific location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

GET /locations/{location_id}/services/{service_id}/¶

Get service for location

Returns a service entry for a specific location

Parameters

location_id (string) – The unique location id.
service_id (string) – The unique service id.

Status Codes

200 OK – Service Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

PUT /locations/{location_id}/services/{service_id}/¶

Update service for location

Updates a service entry for a specific location

Parameters

location_id (string) – The unique location id.
service_id (string) – The unique service id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

DELETE /locations/{location_id}/services/{service_id}/¶

Delete service for location

Deletes a service entry for a specific location

Parameters

location_id (string) – The unique location id.
service_id (string) – The unique service id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

GET /locations/{location_id}/accessibility/¶

Get list of accessibility for disabilities for location

Returns a list of all accessibility for disabilities for a specific location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Accessibility For Disabilities Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location for which the entry describes the accessibility provision.	string	False
`accessibility`
	Description of assistance or infrastructure that facilitate access to clients with disabilities.	string	False
`details`
	Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.	string	False

POST /locations/{location_id}/accessibility/¶

Add accessibility for disabilities for location

Creates a new accessibility for disabilities entry for a specific location

Parameters

location_id (string) – The unique location id.

Status Codes

200 OK – Accessibility For Disabilities Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location for which the entry describes the accessibility provision.	string	False
`accessibility`
	Description of assistance or infrastructure that facilitate access to clients with disabilities.	string	False
`details`
	Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.	string	False

GET /locations/{location_id}/accessibility/{accessibility_id}/¶

Get accessibility for disabilities for location

Returns an accessibility for disabilities entry for a specific location

Parameters

location_id (string) – The unique location id.
accessibility_id (string) – The unique accessibility for disabilities id.

Status Codes

200 OK – Accessibility For Disabilities Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location for which the entry describes the accessibility provision.	string	False
`accessibility`
	Description of assistance or infrastructure that facilitate access to clients with disabilities.	string	False
`details`
	Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.	string	False

PUT /locations/{location_id}/accessibility/{accessibility_id}/¶

Update accessibility for disabilities for location

Updates an existing accessibility for disabilities for a specific location

Parameters

location_id (string) – The unique location id.
accessibility_id (string) – The unique accessibility for disabilities id.

Status Codes

200 OK – Accessibility For Disabilities Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location for which the entry describes the accessibility provision.	string	False
`accessibility`
	Description of assistance or infrastructure that facilitate access to clients with disabilities.	string	False
`details`
	Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.	string	False

DELETE /locations/{location_id}/accessibility/{accessibility_id}/¶

Delete accessibility for disabilities for location

Deletes an accessibility for disabilities entry for a specific location

Parameters

location_id (string) – The unique location id.
accessibility_id (string) – The unique accessibility for disabilities id.

Status Codes

200 OK – Accessibility For Disabilities Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location for which the entry describes the accessibility provision.	string	False
`accessibility`
	Description of assistance or infrastructure that facilitate access to clients with disabilities.	string	False
`details`
	Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.	string	False

GET /organizations/¶

Get list of organizations

Returns a list of all organizations with filtering support

Query Parameters

query (string) – A query to filter list by (up to provider to determine what to search)
queries (string) – A comma separate list of queries with specific fields.
page (number) – The particular page of results.
per_page (number) – Number of records to return per page, up to 100.
sort_by (string) – Which field to sort by.
order (string) – Which order to sort by (asc,desc).

Status Codes

200 OK – Organization Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each organization must have a unique identifier.	string	True
`name`
	The official or public name of the organization.	string	False
`alternate_name`
	Alternative or commonly used name for the organization.	string	False
`description`
	A brief summary about the organization. It can contain markup such as HTML or Markdown.	string	True
`email`
	The contact e-mail address for the organization.	string	False
`url`
	The URL (website address) of the organization.	string	False
`tax_status`
	Government assigned tax designation for for tax-exempt organizations.	string	False
`tax_id`
	A government issued identifier used for the purpose of tax administration.	string	False
`year_incorporated`
	The year in which the organization was legally formed.	string	False
`legal_status`
	The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.	string	False

POST /organizations/¶

Add organization

Creates a new organization entry

Status Codes

200 OK – Organization Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each organization must have a unique identifier.	string	True
`name`
	The official or public name of the organization.	string	False
`alternate_name`
	Alternative or commonly used name for the organization.	string	False
`description`
	A brief summary about the organization. It can contain markup such as HTML or Markdown.	string	True
`email`
	The contact e-mail address for the organization.	string	False
`url`
	The URL (website address) of the organization.	string	False
`tax_status`
	Government assigned tax designation for for tax-exempt organizations.	string	False
`tax_id`
	A government issued identifier used for the purpose of tax administration.	string	False
`year_incorporated`
	The year in which the organization was legally formed.	string	False
`legal_status`
	The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.	string	False

GET /organizations/complete/¶

Get list of organizations with full details

Returns a list of organizations with full schema and filtering support

Query Parameters

query (string) – A query to filter list by (up to provider to determine what to search)
queries (string) – A comma separate list of queries with specific fields.
page (number) – The particular page of results.
per_page (number) – Number of records to return per page, up to 100.
sort_by (string) – Which field to sort by.
order (string) – Which order to sort by (asc,desc).

Status Codes

200 OK – Organization Complete Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each organization must have a unique identifier.	string	True
`name`
	The official or public name of the organization.	string	False
`alternate_name`
	Alternative or commonly used name for the organization.	string	False
`description`
	A brief summary about the organization. It can contain markup such as HTML or Markdow.	string	True
`email`
	The contact e-mail address for the organization.	string	False
`url`
	The URL (website address) of the organization.	string	False
`tax_status`
	Government assigned tax designation for for tax-exempt organizations.	string	False
`tax_id`
	A government issued identifier used for the purpose of tax administration.	string	False
`year_incorporated`
	The year in which the organization was legally formed.	string	False
`legal_status`
	The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.	string	False
`contacts/0/id`
	Each contact must have a unique identifier.	string	True
`contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`contacts/0/name`
	The name of the person.	string	False
`contacts/0/title`
	The job title of the person.	string	False
`contacts/0/department`
	The department that the person is part of.	string	False
`contacts/0/email`
	The email address of the person.	string	False
`funding/0/id`
	Each entry must have a unique identifier.	string	True
`funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`funding/0/source`
	Source of funds for organization or service.	string	False
`locations/0/id`
	Each location must have a unique identifier.	string	True
`locations/0/organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`locations/0/name`
	The name of the location.	string	True
`locations/0/alternate_name`
	An alternative name for the location.	string	False
`locations/0/description`
	A description of this location.	string	False
`locations/0/transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`locations/0/latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`locations/0/longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`programs/0/id`
	Each program must have a unique identifier.	string	True
`programs/0/organization_id`
	Each program must belong to a single organization. The identifier of the organization should be given here.	string	True
`programs/0/name`
	The name of the program.	string	True
`programs/0/alternate_name`
	NeAn alternative name for the program.	string	False
`services/0/id`
	Each service must have a unique identifier.	string	False
`services/0/organization_id`
	The identifier of the organization that provides this service.	string	False
`services/0/program_id`
	The identifier of the program this service is delivered under.	string	False
`services/0/location_id`
	The identifier of the location where this service is delivered.	string	False
`services/0/name`
	The official or public name of the service.	string	False
`services/0/alternate_name`
	Alternative or commonly used name for a service.	string	False
`services/0/description`
	A description of the service.	string	False
`services/0/url`
	URL of the service.	string	False
`services/0/email`
	Email address for the service.	string	False
`services/0/status`
	The current status of the service.	string	False
`services/0/interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`services/0/application_process`
	The steps needed to access the service.	string	False
`services/0/wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`services/0/fees`
	Details of any charges for service users to access this service.	string	False
`services/0/accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`services/0/licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

POST /organizations/complete/¶

Add organization with full details

Creates a new organization entry with full details

Status Codes

200 OK – Organization Complete Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each organization must have a unique identifier.	string	True
`name`
	The official or public name of the organization.	string	False
`alternate_name`
	Alternative or commonly used name for the organization.	string	False
`description`
	A brief summary about the organization. It can contain markup such as HTML or Markdow.	string	True
`email`
	The contact e-mail address for the organization.	string	False
`url`
	The URL (website address) of the organization.	string	False
`tax_status`
	Government assigned tax designation for for tax-exempt organizations.	string	False
`tax_id`
	A government issued identifier used for the purpose of tax administration.	string	False
`year_incorporated`
	The year in which the organization was legally formed.	string	False
`legal_status`
	The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.	string	False
`contacts/0/id`
	Each contact must have a unique identifier.	string	True
`contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`contacts/0/name`
	The name of the person.	string	False
`contacts/0/title`
	The job title of the person.	string	False
`contacts/0/department`
	The department that the person is part of.	string	False
`contacts/0/email`
	The email address of the person.	string	False
`funding/0/id`
	Each entry must have a unique identifier.	string	True
`funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`funding/0/source`
	Source of funds for organization or service.	string	False
`locations/0/id`
	Each location must have a unique identifier.	string	True
`locations/0/organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`locations/0/name`
	The name of the location.	string	True
`locations/0/alternate_name`
	An alternative name for the location.	string	False
`locations/0/description`
	A description of this location.	string	False
`locations/0/transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`locations/0/latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`locations/0/longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`programs/0/id`
	Each program must have a unique identifier.	string	True
`programs/0/organization_id`
	Each program must belong to a single organization. The identifier of the organization should be given here.	string	True
`programs/0/name`
	The name of the program.	string	True
`programs/0/alternate_name`
	NeAn alternative name for the program.	string	False
`services/0/id`
	Each service must have a unique identifier.	string	False
`services/0/organization_id`
	The identifier of the organization that provides this service.	string	False
`services/0/program_id`
	The identifier of the program this service is delivered under.	string	False
`services/0/location_id`
	The identifier of the location where this service is delivered.	string	False
`services/0/name`
	The official or public name of the service.	string	False
`services/0/alternate_name`
	Alternative or commonly used name for a service.	string	False
`services/0/description`
	A description of the service.	string	False
`services/0/url`
	URL of the service.	string	False
`services/0/email`
	Email address for the service.	string	False
`services/0/status`
	The current status of the service.	string	False
`services/0/interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`services/0/application_process`
	The steps needed to access the service.	string	False
`services/0/wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`services/0/fees`
	Details of any charges for service users to access this service.	string	False
`services/0/accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`services/0/licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

GET /organizations/complete/{organization_id}/¶

Get organization with full details

Returns an organization entry with full details by Id

Parameters

organization_id (string) – The organization id.

Status Codes

200 OK – Organization Complete Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each organization must have a unique identifier.	string	True
`name`
	The official or public name of the organization.	string	False
`alternate_name`
	Alternative or commonly used name for the organization.	string	False
`description`
	A brief summary about the organization. It can contain markup such as HTML or Markdow.	string	True
`email`
	The contact e-mail address for the organization.	string	False
`url`
	The URL (website address) of the organization.	string	False
`tax_status`
	Government assigned tax designation for for tax-exempt organizations.	string	False
`tax_id`
	A government issued identifier used for the purpose of tax administration.	string	False
`year_incorporated`
	The year in which the organization was legally formed.	string	False
`legal_status`
	The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.	string	False
`contacts/0/id`
	Each contact must have a unique identifier.	string	True
`contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`contacts/0/name`
	The name of the person.	string	False
`contacts/0/title`
	The job title of the person.	string	False
`contacts/0/department`
	The department that the person is part of.	string	False
`contacts/0/email`
	The email address of the person.	string	False
`funding/0/id`
	Each entry must have a unique identifier.	string	True
`funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`funding/0/source`
	Source of funds for organization or service.	string	False
`locations/0/id`
	Each location must have a unique identifier.	string	True
`locations/0/organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`locations/0/name`
	The name of the location.	string	True
`locations/0/alternate_name`
	An alternative name for the location.	string	False
`locations/0/description`
	A description of this location.	string	False
`locations/0/transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`locations/0/latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`locations/0/longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`programs/0/id`
	Each program must have a unique identifier.	string	True
`programs/0/organization_id`
	Each program must belong to a single organization. The identifier of the organization should be given here.	string	True
`programs/0/name`
	The name of the program.	string	True
`programs/0/alternate_name`
	NeAn alternative name for the program.	string	False
`services/0/id`
	Each service must have a unique identifier.	string	False
`services/0/organization_id`
	The identifier of the organization that provides this service.	string	False
`services/0/program_id`
	The identifier of the program this service is delivered under.	string	False
`services/0/location_id`
	The identifier of the location where this service is delivered.	string	False
`services/0/name`
	The official or public name of the service.	string	False
`services/0/alternate_name`
	Alternative or commonly used name for a service.	string	False
`services/0/description`
	A description of the service.	string	False
`services/0/url`
	URL of the service.	string	False
`services/0/email`
	Email address for the service.	string	False
`services/0/status`
	The current status of the service.	string	False
`services/0/interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`services/0/application_process`
	The steps needed to access the service.	string	False
`services/0/wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`services/0/fees`
	Details of any charges for service users to access this service.	string	False
`services/0/accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`services/0/licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

PUT /organizations/complete/{organization_id}/¶

Update organization with full details

Updates an organization entry with full details

Parameters

organization_id (string) – The organization id.

Status Codes

200 OK – Organization Complete Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each organization must have a unique identifier.	string	True
`name`
	The official or public name of the organization.	string	False
`alternate_name`
	Alternative or commonly used name for the organization.	string	False
`description`
	A brief summary about the organization. It can contain markup such as HTML or Markdow.	string	True
`email`
	The contact e-mail address for the organization.	string	False
`url`
	The URL (website address) of the organization.	string	False
`tax_status`
	Government assigned tax designation for for tax-exempt organizations.	string	False
`tax_id`
	A government issued identifier used for the purpose of tax administration.	string	False
`year_incorporated`
	The year in which the organization was legally formed.	string	False
`legal_status`
	The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.	string	False
`contacts/0/id`
	Each contact must have a unique identifier.	string	True
`contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`contacts/0/name`
	The name of the person.	string	False
`contacts/0/title`
	The job title of the person.	string	False
`contacts/0/department`
	The department that the person is part of.	string	False
`contacts/0/email`
	The email address of the person.	string	False
`funding/0/id`
	Each entry must have a unique identifier.	string	True
`funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`funding/0/source`
	Source of funds for organization or service.	string	False
`locations/0/id`
	Each location must have a unique identifier.	string	True
`locations/0/organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`locations/0/name`
	The name of the location.	string	True
`locations/0/alternate_name`
	An alternative name for the location.	string	False
`locations/0/description`
	A description of this location.	string	False
`locations/0/transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`locations/0/latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`locations/0/longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`programs/0/id`
	Each program must have a unique identifier.	string	True
`programs/0/organization_id`
	Each program must belong to a single organization. The identifier of the organization should be given here.	string	True
`programs/0/name`
	The name of the program.	string	True
`programs/0/alternate_name`
	NeAn alternative name for the program.	string	False
`services/0/id`
	Each service must have a unique identifier.	string	False
`services/0/organization_id`
	The identifier of the organization that provides this service.	string	False
`services/0/program_id`
	The identifier of the program this service is delivered under.	string	False
`services/0/location_id`
	The identifier of the location where this service is delivered.	string	False
`services/0/name`
	The official or public name of the service.	string	False
`services/0/alternate_name`
	Alternative or commonly used name for a service.	string	False
`services/0/description`
	A description of the service.	string	False
`services/0/url`
	URL of the service.	string	False
`services/0/email`
	Email address for the service.	string	False
`services/0/status`
	The current status of the service.	string	False
`services/0/interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`services/0/application_process`
	The steps needed to access the service.	string	False
`services/0/wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`services/0/fees`
	Details of any charges for service users to access this service.	string	False
`services/0/accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`services/0/licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

GET /organizations/{organization_id}/¶

Get organization

Returns a specific organization entry by Id

Parameters

organization_id (string) – The organization id.

Status Codes

200 OK – Organization Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each organization must have a unique identifier.	string	True
`name`
	The official or public name of the organization.	string	False
`alternate_name`
	Alternative or commonly used name for the organization.	string	False
`description`
	A brief summary about the organization. It can contain markup such as HTML or Markdown.	string	True
`email`
	The contact e-mail address for the organization.	string	False
`url`
	The URL (website address) of the organization.	string	False
`tax_status`
	Government assigned tax designation for for tax-exempt organizations.	string	False
`tax_id`
	A government issued identifier used for the purpose of tax administration.	string	False
`year_incorporated`
	The year in which the organization was legally formed.	string	False
`legal_status`
	The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.	string	False

PUT /organizations/{organization_id}/¶

Update organization

Updates an organization entry

Parameters

organization_id (string) – The unique organization id.

Status Codes

200 OK – Organization Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each organization must have a unique identifier.	string	True
`name`
	The official or public name of the organization.	string	False
`alternate_name`
	Alternative or commonly used name for the organization.	string	False
`description`
	A brief summary about the organization. It can contain markup such as HTML or Markdown.	string	True
`email`
	The contact e-mail address for the organization.	string	False
`url`
	The URL (website address) of the organization.	string	False
`tax_status`
	Government assigned tax designation for for tax-exempt organizations.	string	False
`tax_id`
	A government issued identifier used for the purpose of tax administration.	string	False
`year_incorporated`
	The year in which the organization was legally formed.	string	False
`legal_status`
	The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.	string	False

DELETE /organizations/{organization_id}/¶

Delete organization

Deletes an organization entry

Parameters

organization_id (string) – The organization id.

Status Codes

200 OK – Organization Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each organization must have a unique identifier.	string	True
`name`
	The official or public name of the organization.	string	False
`alternate_name`
	Alternative or commonly used name for the organization.	string	False
`description`
	A brief summary about the organization. It can contain markup such as HTML or Markdown.	string	True
`email`
	The contact e-mail address for the organization.	string	False
`url`
	The URL (website address) of the organization.	string	False
`tax_status`
	Government assigned tax designation for for tax-exempt organizations.	string	False
`tax_id`
	A government issued identifier used for the purpose of tax administration.	string	False
`year_incorporated`
	The year in which the organization was legally formed.	string	False
`legal_status`
	The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.	string	False

GET /organizations/{organization_id}/contacts/¶

Get all contacts for organization

Returns a full list of contacts for a specific organization

Parameters

organization_id (string) – The unique organization id.

Status Codes

200 OK – Contact Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

POST /organizations/{organization_id}/contacts/¶

Add contact for organization

Creates a new contact entry to a specific organization

Parameters

organization_id (string) – The unique organization id.

Status Codes

200 OK – Contact Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

GET /organizations/{organization_id}/contacts/{contact_id}/¶

Get contact for organization

Returns a contact entry for a specific organization

Parameters

organization_id (string) – The unique organization id.
contact_id (string) – The unique contact id.

Status Codes

200 OK – Contact Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

PUT /organizations/{organization_id}/contacts/{contact_id}/¶

Update contact for organization

Updates a contact entry for an organization

Parameters

organization_id (string) – The unique organization id.
contact_id (string) – The unique contact id.

Status Codes

200 OK – Contact Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

DELETE /organizations/{organization_id}/contacts/{contact_id}/¶

Delete contact for organization

Deletes a contact entry for a specific organization

Parameters

organization_id (string) – The unique organization id.
contact_id (string) – The unique contact id.

Status Codes

200 OK – Contact Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

GET /organizations/{organization_id}/funding/¶

Get funding for organization

Returns a full list of funding entries for a specific organization

Parameters

organization_id (string) – The unique organization id.

Status Codes

200 OK – Funding Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`source`
	Source of funds for organization or service.	string	False

POST /organizations/{organization_id}/funding/¶

Add funding for organization

Creates a new funding entry for a specific organization

Parameters

organization_id (string) – The unique organization id.

Status Codes

200 OK – Funding Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`source`
	Source of funds for organization or service.	string	False

GET /organizations/{organization_id}/funding/{funding_id}/¶

Get funding for organization

Returns a funding entry for a specific organization

Parameters

organization_id (string) – The unique organization id.
funding_id (string) – The unique funding id.

Status Codes

200 OK – Funding Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`source`
	Source of funds for organization or service.	string	False

PUT /organizations/{organization_id}/funding/{funding_id}/¶

Update funding for organization

Updates a funding entry for a specific organization

Parameters

organization_id (string) – The unique organization id.
funding_id (string) – The unique funding id.

Status Codes

200 OK – Funding Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`source`
	Source of funds for organization or service.	string	False

DELETE /organizations/{organization_id}/funding/{funding_id}/¶

Delete funding for organization

Deletes a funding entry for a specific organization

Parameters

organization_id (string) – The unique organization id.
funding_id (string) – The unique funding id.

Status Codes

200 OK – Funding Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`source`
	Source of funds for organization or service.	string	False

GET /organizations/{organization_id}/locations/¶

Get all locations for organization

Returns a full list of locations for a specific organization

Parameters

organization_id (string) – The id for the organization.

Status Codes

200 OK – Location Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each location must have a unique identifier.	string	True
`organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`name`
	The name of the location.	string	True
`alternate_name`
	An alternative name for the location.	string	False
`description`
	A description of this location.	string	False
`transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False

POST /organizations/{organization_id}/locations/¶

Add location for organization

Creates a new location entry for a specific organization

Parameters

organization_id (string) – The unique organization id.

Status Codes

200 OK – Location Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each location must have a unique identifier.	string	True
`organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`name`
	The name of the location.	string	True
`alternate_name`
	An alternative name for the location.	string	False
`description`
	A description of this location.	string	False
`transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False

GET /organizations/{organization_id}/locations/{location_id}/¶

Get location for organization

Returns a location entry for a specific organization

Parameters

organization_id (string) – The unique organization id.
location_id (string) – The unique location id.

Status Codes

200 OK – Location Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each location must have a unique identifier.	string	True
`organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`name`
	The name of the location.	string	True
`alternate_name`
	An alternative name for the location.	string	False
`description`
	A description of this location.	string	False
`transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False

PUT /organizations/{organization_id}/locations/{location_id}/¶

Update location for organization

Updates a location entry for a specific organization

Parameters

organization_id (string) – The unique organization id.
location_id (string) – The unique location id.

Status Codes

200 OK – Location Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each location must have a unique identifier.	string	True
`organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`name`
	The name of the location.	string	True
`alternate_name`
	An alternative name for the location.	string	False
`description`
	A description of this location.	string	False
`transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False

DELETE /organizations/{organization_id}/locations/{location_id}/¶

Delete location for organization

Deletes a location entry for a specific location

Parameters

organization_id (string) – The unique organization id.
location_id (string) – The unique location id.

Status Codes

200 OK – Location Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each location must have a unique identifier.	string	True
`organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`name`
	The name of the location.	string	True
`alternate_name`
	An alternative name for the location.	string	False
`description`
	A description of this location.	string	False
`transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False

GET /organizations/{organization_id}/phones/¶

Get all phones for organization

Returns a full list of phones for a specific organization

Parameters

organization_id (string) – The unique organization id.

Status Codes

200 OK – Phone Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

POST /organizations/{organization_id}/phones/¶

Add phone for an organization

Creates a new phone entry for a specific organization

Parameters

organization_id (string) – The unique organization id.

Status Codes

200 OK – Phone Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

GET /organizations/{organization_id}/phones/{phone_id}/¶

Get phone for organization

Returns a phone entry for a specific organization

Parameters

organization_id (string) – The unique organization id.
phone_id (string) – The unique phone id.

Status Codes

200 OK – Phone Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

PUT /organizations/{organization_id}/phones/{phone_id}/¶

Update phone for organization

Updates a phone entry for a specific organization

Parameters

organization_id (string) – The unique organization id.
phone_id (string) – The unique phone id.

Status Codes

200 OK – Phone Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

DELETE /organizations/{organization_id}/phones/{phone_id}/¶

Delete phone for organization

Deletes a phone entry for an organization

Parameters

organization_id (string) – The unique organization id.
phone_id (string) – The unique phone id.

Status Codes

200 OK – Phone Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

GET /organizations/{organization_id}/programs/¶

Get all programs for organization

Returns a full list of programs for a specific organization

Parameters

organization_id (string) – The unique organization id.

Status Codes

200 OK – Program Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each program must have a unique identifier.	string	True
`organization_id`
	Each program must belong to a single organization. The identifier of the organization should be given here.	string	True
`name`
	The name of the program.	string	True
`alternate_name`
	NeAn alternative name for the program.	string	False

POST /organizations/{organization_id}/programs/¶

Add program for organization

Creates a new program entry for a specific organization

Parameters

organization_id (string) – The unique organization id.

Status Codes

200 OK – Program Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each program must have a unique identifier.	string	True
`organization_id`
	Each program must belong to a single organization. The identifier of the organization should be given here.	string	True
`name`
	The name of the program.	string	True
`alternate_name`
	NeAn alternative name for the program.	string	False

GET /organizations/{organization_id}/programs/{program_id}/¶

Get program for organization

Returns a program entry for a specific organization

Parameters

organization_id (string) – The unique organization id.
program_id (string) – The unique program id.

Status Codes

200 OK – Program Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each program must have a unique identifier.	string	True
`organization_id`
	Each program must belong to a single organization. The identifier of the organization should be given here.	string	True
`name`
	The name of the program.	string	True
`alternate_name`
	NeAn alternative name for the program.	string	False

PUT /organizations/{organization_id}/programs/{program_id}/¶

Update program for organization

Updates a program entry for a specific organization

Parameters

organization_id (string) – The unique organization id.
program_id (string) – The unique program id.

Status Codes

200 OK – Program Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each program must have a unique identifier.	string	True
`organization_id`
	Each program must belong to a single organization. The identifier of the organization should be given here.	string	True
`name`
	The name of the program.	string	True
`alternate_name`
	NeAn alternative name for the program.	string	False

DELETE /organizations/{organization_id}/programs/{program_id}/¶

Delete program for organization

Deletes a program entry for a specific organization

Parameters

organization_id (string) – The unique organization id.
program_id (string) – The unique program id.

Status Codes

200 OK – Program Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each program must have a unique identifier.	string	True
`organization_id`
	Each program must belong to a single organization. The identifier of the organization should be given here.	string	True
`name`
	The name of the program.	string	True
`alternate_name`
	NeAn alternative name for the program.	string	False

GET /organizations/{organization_id}/programs/{program_id}/services/¶

Get all services for a specific program within an organization

Returns a full list of services for a specific program in a specific organization

Parameters

organization_id (string) – The unique organization id.
program_id (string) – The unique program id.

Status Codes

200 OK – Service Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

POST /organizations/{organization_id}/programs/{program_id}/services/¶

Add service for a program within an organization

Creates a new service entry for a specific program within an organization

Parameters

organization_id (string) – The unique organization id.
program_id (string) – The unique program id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

GET /organizations/{organization_id}/programs/{program_id}/services/{service_id}/¶

Get service from a specific program within an organization

Returns a service entry from a specific program within an organization

Parameters

organization_id (string) – The unique organization id.
program_id (string) – The unique program id.
service_id (string) – The unique service id.

Status Codes

200 OK – Service Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

PUT /organizations/{organization_id}/programs/{program_id}/services/{service_id}/¶

Update service for a specific program within an organization

Updates a service from a specific program within an organization

Parameters

organization_id (string) – The unique organization id.
program_id (string) – The unique program id.
service_id (string) – The unique service id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

DELETE /organizations/{organization_id}/programs/{program_id}/services/{service_id}/¶

Delete service for a specific program within an organization

Deletes a service from a specific program within an organization

Parameters

organization_id (string) – The unique organization id.
program_id (string) – The unique program id.
service_id (string) – The unique service id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

GET /organizations/{organization_id}/services/¶

Get all services for organization

Returns a full list of services for a specific organization

Parameters

organization_id (string) – The unique organization id.

Status Codes

200 OK – Service Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

POST /organizations/{organization_id}/services/¶

Add service for organization

Creates a new service entry for an organization

Parameters

organization_id (string) – The unique organization id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

GET /organizations/{organization_id}/services/{service_id}/¶

Get service for organization

Returns a service entry for a specific organization

Parameters

organization_id (string) – The unique organization id.
service_id (string) – The unique service id.

Status Codes

200 OK – Service Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

PUT /organizations/{organization_id}/services/{service_id}/¶

Update service for organization

Updates a service entry for a specific organization

Parameters

organization_id (string) – The unique organization id.
service_id (string) – The unique service id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

DELETE /organizations/{organization_id}/services/{service_id}/¶

Delete service for organization

Deletes a service entry for a specific organization

Parameters

organization_id (string) – The unique organization id.
service_id (string) – The unique service id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

GET /services/¶

Get all services

Returns a full list of services with filtering support

Query Parameters

query (string) – A query to filter list by (up to provider to determine what to search)
queries (string) – A comma separate list of queries with specific fields.
page (number) – The particular page of results.
per_page (number) – Number of records return per page, up to 100.
sort_by (string) – Which field to sort by.
order (string) – Which order to sort by (asc,desc).

Status Codes

200 OK – Service Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

POST /services/¶

Add service

Creates a new service entry

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

GET /services/complete/¶

Get all services with full details

Returns a list of services with full details and filtering support

Query Parameters

query (string) – A query to filter list by (up to provider to determine what to search)
queries (string) – A comma separate list of queries with specific fields.
page (number) – The particular page of results.
per_page (number) – Number of records to return per page, up to 100.
sort_by (string) – Which field to sort by.
order (string) – Which order to sort by (asc,desc).

Status Codes

200 OK – Service Complete Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization that provides this service.	string	True
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	True
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	True
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`contacts/0/id`
	Each contact must have a unique identifier.	string	True
`contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`contacts/0/name`
	The name of the person.	string	False
`contacts/0/title`
	The job title of the person.	string	False
`contacts/0/department`
	The department that the person is part of.	string	False
`contacts/0/email`
	The email address of the person.	string	False
`eligibility/0/id`
	Each entry must have a unique identifier.	string	True
`eligibility/0/service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`eligibility/0/eligibility`
	The rules or guidelines that determine who can receive the service.	string	False
`fees/0/id`
	Each entry must have a unique identifier.	string	True
`fees/0/service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`fees/0/fee`
	A listing of the costs of services, including free ones.	string	False
`funding/0/id`
	Each entry must have a unique identifier.	string	True
`funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`funding/0/source`
	Source of funds for organization or service.	string	False
`regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`languages/0/id`
	Each language must have a unique identifier.	string	True
`languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`payment_accepted/0/id`
	Each entry must have a unique identifier.	string	True
`payment_accepted/0/service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`payment_accepted/0/payment`
	The methods of payment accepted for the service.	string	False
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`required_documents/0/id`
	Each document must have a unique identifier.	string	True
`required_documents/0/service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`required_documents/0/document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False
`service_area/0/id`
	Each service area must have a unique identifier.	string	True
`service_area/0/service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`service_area/0/service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`service_area/0/description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False

POST /services/complete/¶

Add service with full details

Creates a new service entry with full details

Status Codes

200 OK – Service Complete Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization that provides this service.	string	True
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	True
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	True
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`contacts/0/id`
	Each contact must have a unique identifier.	string	True
`contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`contacts/0/name`
	The name of the person.	string	False
`contacts/0/title`
	The job title of the person.	string	False
`contacts/0/department`
	The department that the person is part of.	string	False
`contacts/0/email`
	The email address of the person.	string	False
`eligibility/0/id`
	Each entry must have a unique identifier.	string	True
`eligibility/0/service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`eligibility/0/eligibility`
	The rules or guidelines that determine who can receive the service.	string	False
`fees/0/id`
	Each entry must have a unique identifier.	string	True
`fees/0/service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`fees/0/fee`
	A listing of the costs of services, including free ones.	string	False
`funding/0/id`
	Each entry must have a unique identifier.	string	True
`funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`funding/0/source`
	Source of funds for organization or service.	string	False
`regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`languages/0/id`
	Each language must have a unique identifier.	string	True
`languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`payment_accepted/0/id`
	Each entry must have a unique identifier.	string	True
`payment_accepted/0/service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`payment_accepted/0/payment`
	The methods of payment accepted for the service.	string	False
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`required_documents/0/id`
	Each document must have a unique identifier.	string	True
`required_documents/0/service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`required_documents/0/document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False
`service_area/0/id`
	Each service area must have a unique identifier.	string	True
`service_area/0/service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`service_area/0/service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`service_area/0/description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False

GET /services/complete/{service_id}/¶

Get service with full details

Returns a service entry with full details

Parameters

service_id (string) – The service id.

Status Codes

200 OK – Service Complete Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization that provides this service.	string	True
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	True
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	True
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`contacts/0/id`
	Each contact must have a unique identifier.	string	True
`contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`contacts/0/name`
	The name of the person.	string	False
`contacts/0/title`
	The job title of the person.	string	False
`contacts/0/department`
	The department that the person is part of.	string	False
`contacts/0/email`
	The email address of the person.	string	False
`eligibility/0/id`
	Each entry must have a unique identifier.	string	True
`eligibility/0/service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`eligibility/0/eligibility`
	The rules or guidelines that determine who can receive the service.	string	False
`fees/0/id`
	Each entry must have a unique identifier.	string	True
`fees/0/service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`fees/0/fee`
	A listing of the costs of services, including free ones.	string	False
`funding/0/id`
	Each entry must have a unique identifier.	string	True
`funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`funding/0/source`
	Source of funds for organization or service.	string	False
`regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`languages/0/id`
	Each language must have a unique identifier.	string	True
`languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`payment_accepted/0/id`
	Each entry must have a unique identifier.	string	True
`payment_accepted/0/service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`payment_accepted/0/payment`
	The methods of payment accepted for the service.	string	False
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`required_documents/0/id`
	Each document must have a unique identifier.	string	True
`required_documents/0/service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`required_documents/0/document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False
`service_area/0/id`
	Each service area must have a unique identifier.	string	True
`service_area/0/service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`service_area/0/service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`service_area/0/description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False

PUT /services/complete/{service_id}/¶

Update service with full details

Updates a service entry with full details

Parameters

service_id (string) – The service id.

Status Codes

200 OK – Service Complete Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization that provides this service.	string	True
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	True
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	True
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`contacts/0/id`
	Each contact must have a unique identifier.	string	True
`contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`contacts/0/name`
	The name of the person.	string	False
`contacts/0/title`
	The job title of the person.	string	False
`contacts/0/department`
	The department that the person is part of.	string	False
`contacts/0/email`
	The email address of the person.	string	False
`eligibility/0/id`
	Each entry must have a unique identifier.	string	True
`eligibility/0/service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`eligibility/0/eligibility`
	The rules or guidelines that determine who can receive the service.	string	False
`fees/0/id`
	Each entry must have a unique identifier.	string	True
`fees/0/service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`fees/0/fee`
	A listing of the costs of services, including free ones.	string	False
`funding/0/id`
	Each entry must have a unique identifier.	string	True
`funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`funding/0/source`
	Source of funds for organization or service.	string	False
`regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`languages/0/id`
	Each language must have a unique identifier.	string	True
`languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`payment_accepted/0/id`
	Each entry must have a unique identifier.	string	True
`payment_accepted/0/service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`payment_accepted/0/payment`
	The methods of payment accepted for the service.	string	False
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`required_documents/0/id`
	Each document must have a unique identifier.	string	True
`required_documents/0/service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`required_documents/0/document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False
`service_area/0/id`
	Each service area must have a unique identifier.	string	True
`service_area/0/service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`service_area/0/service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`service_area/0/description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False

GET /services/{service_id}/¶

Get service

Returns a specific service entry by Id

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Organization Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each organization must have a unique identifier.	string	True
`name`
	The official or public name of the organization.	string	False
`alternate_name`
	Alternative or commonly used name for the organization.	string	False
`description`
	A brief summary about the organization. It can contain markup such as HTML or Markdown.	string	True
`email`
	The contact e-mail address for the organization.	string	False
`url`
	The URL (website address) of the organization.	string	False
`tax_status`
	Government assigned tax designation for for tax-exempt organizations.	string	False
`tax_id`
	A government issued identifier used for the purpose of tax administration.	string	False
`year_incorporated`
	The year in which the organization was legally formed.	string	False
`legal_status`
	The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.	string	False

PUT /services/{service_id}/¶

Update service

Updates a service entry

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

DELETE /services/{service_id}/¶

Delete service

Deletes a service entry

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

GET /services/{service_id}/contacts/¶

Get all contacts for service

Returns a full list of contacts for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Contact Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

POST /services/{service_id}/contacts/¶

Add contact for service

Creates a new contact entry for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Contact Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

GET /services/{service_id}/contacts/{contact_id}/¶

Get contact for service

Returns a contact entry for a specific service by Id

Parameters

service_id (string) – The unique service id.
contact_id (string) – The unique contact id.

Status Codes

200 OK – Contact Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

PUT /services/{service_id}/contacts/{contact_id}/¶

Update contact for service

Updates a contact entry for a specific service

Parameters

service_id (string) – The unique service id.
contact_id (string) – The unique contact id.

Status Codes

200 OK – Contact Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

DELETE /services/{service_id}/contacts/{contact_id}/¶

Delete contact for service

Deletes a contact entry for a specific service

Parameters

service_id (string) – The unique service id.
contact_id (string) – The unique contact id.

Status Codes

200 OK – Contact Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False

GET /services/{service_id}/eligibility/¶

Get all eligibilities for service

Returns a full list of eligibilities for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Eligibility Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`eligibility`
	The rules or guidelines that determine who can receive the service.	string	False

POST /services/{service_id}/eligibility/¶

Add eligibility for service

Creates a new eligibility entry for a service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Eligibility Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`eligibility`
	The rules or guidelines that determine who can receive the service.	string	False

GET /services/{service_id}/eligibility/{eligibility_id}/¶

Get eligibility for service

Returns an eligibility entry for a specific service

Parameters

eligibility_id (string) – The unique eligibility id.
service_id (string) – The unique service id.

Status Codes

200 OK – Eligibility Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`eligibility`
	The rules or guidelines that determine who can receive the service.	string	False

PUT /services/{service_id}/eligibility/{eligibility_id}/¶

Update eligibility for service

Updates an eligibility entry for a specific service

Parameters

eligibility_id (string) – The unique eligibility id.
service_id (string) – The unique service id.

Status Codes

200 OK – Eligibility Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`eligibility`
	The rules or guidelines that determine who can receive the service.	string	False

DELETE /services/{service_id}/eligibility/{eligibility_id}/¶

Delete eligibility for service

Deletes an eligibility entry for a specific service

Parameters

eligibility_id (string) – The unique eligibility id.
service_id (string) – The unique service id.

Status Codes

200 OK – Eligibility Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`eligibility`
	The rules or guidelines that determine who can receive the service.	string	False

GET /services/{service_id}/fees/¶

Get all fees for service

Returns a full list of fees for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Fees Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`fee`
	A listing of the costs of services, including free ones.	string	False

POST /services/{service_id}/fees/¶

Add fee for service

Creates a fee entry for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Fees Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`fee`
	A listing of the costs of services, including free ones.	string	False

GET /services/{service_id}/fees/{feed_id}/¶

Get fee for service

Returns a fee entry for a specific service

Parameters

service_id (string) – The unique service id.
feed_id (string) – The unique feed id.

Status Codes

200 OK – Fees Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`fee`
	A listing of the costs of services, including free ones.	string	False

PUT /services/{service_id}/fees/{feed_id}/¶

Update fee for service

Updates a fee entry for a service

Parameters

service_id (string) – The unique service id.
feed_id (string) – The unique feed id.

Status Codes

200 OK – Fees Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`fee`
	A listing of the costs of services, including free ones.	string	False

DELETE /services/{service_id}/fees/{feed_id}/¶

Delete fee for service

Deletes a fee entry for a service

Parameters

service_id (string) – The unique service id.
feed_id (string) – The unique feed id.

Status Codes

200 OK – Fees Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`fee`
	A listing of the costs of services, including free ones.	string	False

GET /services/{service_id}/funding/¶

Get all funding for service

Returns a full list of funding entries for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Funding Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`source`
	Source of funds for organization or service.	string	False

POST /services/{service_id}/funding/¶

Add funding for service

Creates a funding entry for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Funding Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`source`
	Source of funds for organization or service.	string	False

GET /services/{service_id}/funding/{funding_id}/¶

Get funding for service

Returns a funding entry for a specific service

Parameters

service_id (string) – The unique service id.
funding_id (string) – The unique funding id.

Status Codes

200 OK – Funding Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`source`
	Source of funds for organization or service.	string	False

PUT /services/{service_id}/funding/{funding_id}/¶

Update funding for service

Updates a funding entry for a specific service

Parameters

service_id (string) – The unique service id.
funding_id (string) – The unique funding id.

Status Codes

200 OK – Funding Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`source`
	Source of funds for organization or service.	string	False

DELETE /services/{service_id}/funding/{funding_id}/¶

Delete funding for service

Deletes a funding entry for a specific service

Parameters

service_id (string) – The unique service id.
funding_id (string) – The unique funding id.

Status Codes

200 OK – Funding Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`source`
	Source of funds for organization or service.	string	False

GET /services/{service_id}/holiday-schedule/¶

Get all holiday schedules for service

Returns a list of holiday schedule entries for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Holiday Schedule Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True

POST /services/{service_id}/holiday-schedule/¶

Add holiday schedule for service

Creates a new holiday schedule entry for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Holiday Schedule Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True

GET /services/{service_id}/holiday-schedule/{holiday_schedule_id}/¶

Get holiday schedule for service

Returns a holiday schedule entry for a specific service

Parameters

service_id (string) – The unique service id.
holiday_schedule_id (string) – The unique holiday schedule id.

Status Codes

200 OK – Holiday Schedule Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True

PUT /services/{service_id}/holiday-schedule/{holiday_schedule_id}/¶

Update holiday schedule

Updates a holiday schedule entry for a specific service

Parameters

service_id (string) – The unique service id.
holiday_schedule_id (string) – The unique holiday schedule id.

Status Codes

200 OK – Holiday Schedule Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True

DELETE /services/{service_id}/holiday-schedule/{holiday_schedule_id}/¶

Delete holiday schedule for service

Deletes a holiday schedule entry for a specific service

Parameters

service_id (string) – The unique service id.
holiday_schedule_id (string) – The unique holiday schedule id.

Status Codes

200 OK – Holiday Schedule Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True

GET /services/{service_id}/languages/¶

Get languages for service

Returns a list of languages supported by a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Language Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each language must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False

POST /services/{service_id}/languages/¶

Add languages for service

Creates new language entries for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Language Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each language must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False

GET /services/{service_id}/languages/{language_id}/¶

Get language for service

Returns a language entry for a specific service

Parameters

service_id (string) – The unique service id.
language_id (string) – The unique language id.

Status Codes

200 OK – Language Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each language must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False

PUT /services/{service_id}/languages/{language_id}/¶

Update language for service

Updates a language entry for a specific service

Parameters

service_id (string) – The unique service id.
language_id (string) – The unique language id.

Status Codes

200 OK – Language Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each language must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False

DELETE /services/{service_id}/languages/{language_id}/¶

Delete language for service

Deletes a language entry for a specific service

Parameters

service_id (string) – The unique service id.
language_id (string) – The unique language id.

Status Codes

200 OK – Language Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each language must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False

GET /services/{service_id}/payment-accepted/¶

Get all accepted paymement methods for service

Returns a list of all accepted payment methods for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Payment Accepted Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`payment`
	The methods of payment accepted for the service.	string	False

POST /services/{service_id}/payment-accepted/¶

Add accepted payment method for service

Creates a new accepted payment method entry for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Payment Accepted Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`payment`
	The methods of payment accepted for the service.	string	False

GET /services/{service_id}/payment-accepted/{payment_accepted_id}/¶

Get accepted payment method

Returns an accepted payment method for a specific service

Parameters

service_id (string) – The unique service id.
payment_accepted_id (string) – The unique payment accepted id.

Status Codes

200 OK – Payment Accepted Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`payment`
	The methods of payment accepted for the service.	string	False

PUT /services/{service_id}/payment-accepted/{payment_accepted_id}/¶

Updates accepted payment method for service

Updates an accepted payment method entry for a specific service

Parameters

service_id (string) – The unique service id.
payment_accepted_id (string) – The unique payment accepted id.

Status Codes

200 OK – Payment Accepted Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`payment`
	The methods of payment accepted for the service.	string	False

DELETE /services/{service_id}/payment-accepted/{payment_accepted_id}/¶

Delete accepted payment method for service

Deletes an accepted payment method for a specific service

Parameters

service_id (string) – The unique service id.
payment_accepted_id (string) – The unique payment accepted id.

Status Codes

200 OK – Payment Accepted Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`payment`
	The methods of payment accepted for the service.	string	False

GET /services/{service_id}/phones/¶

Get all phones for service

Returns a list of phones for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Phone Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

POST /services/{service_id}/phones/¶

Add phone for service

Creates a new phone entry for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Phone Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

GET /services/{service_id}/phones/{phone_id}/¶

Get phone for service

Returns a phone entry for a specific service

Parameters

service_id (string) – The unique service id.
phone_id (string) – The unique phone id.

Status Codes

200 OK – Phone Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

PUT /services/{service_id}/phones/{phone_id}/¶

Update phone for service

Updates a phone entry for a specific service

Parameters

service_id (string) – The unique service id.
phone_id (string) – The unique phone id.

Status Codes

200 OK – Phone Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

DELETE /services/{service_id}/phones/{phone_id}/¶

Delete phone for service

Deletes a phone entry for a specific service

Parameters

service_id (string) – The unique service id.
phone_id (string) – The unique phone id.

Status Codes

200 OK – Phone Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`location_id`
	The identifier of the location where this phone number is located.	string	False
`service_id`
	The identifier of the service for which this is the phone number.	string	False
`organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`number`
	The phone number.	string	True
`extension`
	The extension of the phone number.	string	False
`type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`department`
	The department for which this is the phone number.	string	False
`language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

GET /services/{service_id}/regular-schedule/¶

Get all regular schedules for service

Returns a list of regular schedules for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Regular Schedule Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`weekday`
	The day of the week that this entry relates to.	string	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False

POST /services/{service_id}/regular-schedule/¶

Add regular schedule for service

Creates a new regular schedule entry for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Regular Schedule Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`weekday`
	The day of the week that this entry relates to.	string	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False

GET /services/{service_id}/regular-schedule/{regular_schedule_id}/¶

Get regular schedule for service

Returns a regular schedule entry for a specific service

Parameters

service_id (string) – The unique service id.
regular_schedule_id (string) – The unique regular schedule id

Status Codes

200 OK – Regular Schedule Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`weekday`
	The day of the week that this entry relates to.	string	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False

PUT /services/{service_id}/regular-schedule/{regular_schedule_id}/¶

Update regular schedule for service

Updates a regular schedule entry for a specific service

Parameters

service_id (string) – The unique service id.
regular_schedule_id (string) – The unique regular schedule id

Status Codes

200 OK – Regular Schedule Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`weekday`
	The day of the week that this entry relates to.	string	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False

DELETE /services/{service_id}/regular-schedule/{regular_schedule_id}/¶

Delete regular schedule for service

Deletes a regular schedule entry for a service

Parameters

service_id (string) – The unique service id.
regular_schedule_id (string) – The unique regular schedule id

Status Codes

200 OK – Regular Schedule Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`weekday`
	The day of the week that this entry relates to.	string	True
`opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False

GET /services/{service_id}/required-document/¶

Get all required documents for service

Returns a list of required documents for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Required Document Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each document must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False

POST /services/{service_id}/required-document/¶

Add required document for service

Creates a new required document entry for a specific service

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Required Document Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each document must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False

GET /services/{service_id}/required-document/{required_document_id}/¶

Get required document for service

Returns a required document entry for a specific service

Parameters

service_id (string) – The unique service id.
required_document_id (string) – The unique required document id.

Status Codes

200 OK – Required Document Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each document must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False

PUT /services/{service_id}/required-document/{required_document_id}/¶

Update required document for service

Updates a required document entry for a specific service

Parameters

service_id (string) – The unique service id.
required_document_id (string) – The unique required document id.

Status Codes

200 OK – Required Document Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each document must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False

DELETE /services/{service_id}/required-document/{required_document_id}/¶

Delete required document for service

Deletes a required document entry for a specific service

Parameters

service_id (string) – The unique service id.
required_document_id (string) – The unique required document id.

Status Codes

200 OK – Required Document Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each document must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False

GET /services/{service_id}/service-area/¶

Get all service areas

Returns a list of all service areas

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Required Document Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service area must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False

POST /services/{service_id}/service-area/¶

Add service area

Creates a new service area entry

Parameters

service_id (string) – The unique service id.

Status Codes

200 OK – Service Area Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service area must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False

GET /services/{service_id}/service-area/{service_area_id}/¶

Get service area

Returns a service area entry

Parameters

service_id (string) – The unique service id.
service_area_id (string) – The unique service area id.

Status Codes

200 OK – Service Area Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service area must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False

PUT /services/{service_id}/service-area/{service_area_id}/¶

Update service area

Updates a service area entry

Parameters

service_id (string) – The unique service id.
service_area_id (string) – The unique service area id.

Status Codes

200 OK – Service Area Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service area must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False

DELETE /services/{service_id}/service-area/{service_area_id}/¶

Delete service area

Deletes a service area entry

Parameters

service_id (string) – The unique service id.
service_area_id (string) – The unique service area id.

Status Codes

200 OK – Service Area Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service area must have a unique identifier.	string	True
`service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False

HSDA Search¶

The HSDA search protocol is defined by openapi-hsda-search.yaml. The details below show the available methods and responses.

In general, responses should be a collection of organization, services and/or location arrays. Applications may choose how complete the records they provide in response are.

You can also explore this using our OpenAPI viewer.

GET /search/¶

Search

Search across organizations, locations, services, and contacts

Query Parameters

query (string) – A query to filter list by (up to provider to determine what to search)
queries (string) – A comma separate list of queries with specific fields.
page (number) – The particular page of results.
per_page (number) – Number of records to return per page, up to 100.
sortby (string) – Which field to sort by.
order (string) – Which order to sort by (asc,desc).

Status Codes

200 OK – Item Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`organizations/0/id`
	Each organization must have a unique identifier.	string	True
`organizations/0/name`
	The official or public name of the organization.	string	False
`organizations/0/alternate_name`
	Alternative or commonly used name for the organization.	string	False
`organizations/0/description`
	A brief summary about the organization. It can contain markup such as HTML or Markdow.	string	True
`organizations/0/email`
	The contact e-mail address for the organization.	string	False
`organizations/0/url`
	The URL (website address) of the organization.	string	False
`organizations/0/tax_status`
	Government assigned tax designation for for tax-exempt organizations.	string	False
`organizations/0/tax_id`
	A government issued identifier used for the purpose of tax administration.	string	False
`organizations/0/year_incorporated`
	The year in which the organization was legally formed.	string	False
`organizations/0/legal_status`
	The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.	string	False
`organizations/0/contacts/0/id`
	Each contact must have a unique identifier.	string	True
`organizations/0/contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`organizations/0/contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`organizations/0/contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`organizations/0/contacts/0/name`
	The name of the person.	string	False
`organizations/0/contacts/0/title`
	The job title of the person.	string	False
`organizations/0/contacts/0/department`
	The department that the person is part of.	string	False
`organizations/0/contacts/0/email`
	The email address of the person.	string	False
`organizations/0/contacts/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/contacts/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`organizations/0/contacts/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`organizations/0/contacts/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`organizations/0/contacts/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`organizations/0/contacts/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`organizations/0/contacts/0/phones/0/number`
	The phone number.	string	True
`organizations/0/contacts/0/phones/0/extension`
	The extension of the phone number.	string	False
`organizations/0/contacts/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`organizations/0/contacts/0/phones/0/department`
	The department for which this is the phone number.	string	False
`organizations/0/contacts/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`organizations/0/contacts/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`organizations/0/funding/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`organizations/0/funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`organizations/0/funding/0/source`
	Source of funds for organization or service.	string	False
`organizations/0/locations/0/id`
	Each location must have a unique identifier.	string	True
`organizations/0/locations/0/organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`organizations/0/locations/0/name`
	The name of the location.	string	False
`organizations/0/locations/0/alternate_name`
	An alternative name for the location.	string	False
`organizations/0/locations/0/description`
	A description of this location.	string	False
`organizations/0/locations/0/transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`organizations/0/locations/0/latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`organizations/0/locations/0/longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`organizations/0/locations/0/regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/locations/0/regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`organizations/0/locations/0/regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`organizations/0/locations/0/regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`organizations/0/locations/0/regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`organizations/0/locations/0/regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`organizations/0/locations/0/regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`organizations/0/locations/0/holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/locations/0/holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`organizations/0/locations/0/holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`organizations/0/locations/0/holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`organizations/0/locations/0/holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`organizations/0/locations/0/holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`organizations/0/locations/0/holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`organizations/0/locations/0/holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`organizations/0/locations/0/holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`organizations/0/locations/0/languages/0/id`
	Each language must have a unique identifier.	string	True
`organizations/0/locations/0/languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`organizations/0/locations/0/languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`organizations/0/locations/0/languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`organizations/0/locations/0/postal_address/0/id`
	Each postal address must have a unique identifier.	string	True
`organizations/0/locations/0/postal_address/0/location_id`
	The identifier of the location for which this is the postal address.	string	False
`organizations/0/locations/0/postal_address/0/attention`
	The person or entity for whose attention mail should be marked.	string	False
`organizations/0/locations/0/postal_address/0/address_1`
	The first line of the address.	string	False
`organizations/0/locations/0/postal_address/0/address_2`
	The second line of the address.	string	False
`organizations/0/locations/0/postal_address/0/address_3`
	The third line of the address.	string	False
`organizations/0/locations/0/postal_address/0/address_4`
	The fourth line of the address.	string	False
`organizations/0/locations/0/postal_address/0/city`
	The city in which the address is located.	string	False
`organizations/0/locations/0/postal_address/0/region`
	The region in which the address is located (optional).	string	False
`organizations/0/locations/0/postal_address/0/state_province`
	The state or province in which the address is located.	string	False
`organizations/0/locations/0/postal_address/0/postal_code`
	The postal code for the address.	string	False
`organizations/0/locations/0/postal_address/0/country`
	The country in which the address is located.	string	False
`organizations/0/locations/0/physical_address/0/id`
	Each physical address must have a unique identifier.	string	True
`organizations/0/locations/0/physical_address/0/location_id`
	The identifier of the location for which this is the address.	string	False
`organizations/0/locations/0/physical_address/0/attention`
	The person or entity whose attention should be sought at the location.	string	False
`organizations/0/locations/0/physical_address/0/address_1`
	The first line of the address.	string	True
`organizations/0/locations/0/physical_address/0/address_2`
	The second line of the address.	string	False
`organizations/0/locations/0/physical_address/0/address_3`
	The third line of the address.	string	False
`organizations/0/locations/0/physical_address/0/address_4`
	The fourth line of the address.	string	False
`organizations/0/locations/0/physical_address/0/city`
	The city in which the address is located.	string	True
`organizations/0/locations/0/physical_address/0/region`
	The region in which the address is located (optional).	string	False
`organizations/0/locations/0/physical_address/0/state_province`
	The state or province in which the address is located.	string	True
`organizations/0/locations/0/physical_address/0/postal_code`
	The postal code for the address.	string	True
`organizations/0/locations/0/physical_address/0/country`
	The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation).	string	True
`organizations/0/locations/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/locations/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`organizations/0/locations/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`organizations/0/locations/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`organizations/0/locations/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`organizations/0/locations/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`organizations/0/locations/0/phones/0/number`
	The phone number.	string	True
`organizations/0/locations/0/phones/0/extension`
	The extension of the phone number.	string	False
`organizations/0/locations/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`organizations/0/locations/0/phones/0/department`
	The department for which this is the phone number.	string	False
`organizations/0/locations/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`organizations/0/locations/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`organizations/0/locations/0/service/0/id`
	Each service must have a unique identifier.	string	True
`organizations/0/locations/0/service/0/organization_id`
	The identifier of the organization that provides this service.	string	True
`organizations/0/locations/0/service/0/program_id`
	The identifier of the program this service is delivered under.	string	False
`organizations/0/locations/0/service/0/location_id`
	The identifier of the location where this service is delivered.	string	False
`organizations/0/locations/0/service/0/name`
	The official or public name of the service.	string	True
`organizations/0/locations/0/service/0/alternate_name`
	Alternative or commonly used name for a service.	string	False
`organizations/0/locations/0/service/0/description`
	A description of the service.	string	False
`organizations/0/locations/0/service/0/url`
	URL of the service.	string	False
`organizations/0/locations/0/service/0/email`
	Email address for the service.	string	False
`organizations/0/locations/0/service/0/status`
	The current status of the service.	string	True
`organizations/0/locations/0/service/0/interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`organizations/0/locations/0/service/0/application_process`
	The steps needed to access the service.	string	False
`organizations/0/locations/0/service/0/wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`organizations/0/locations/0/service/0/accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`organizations/0/locations/0/service/0/licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`organizations/0/locations/0/service/0/contacts/0/id`
	Each contact must have a unique identifier.	string	True
`organizations/0/locations/0/service/0/contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`organizations/0/locations/0/service/0/contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`organizations/0/locations/0/service/0/contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`organizations/0/locations/0/service/0/contacts/0/name`
	The name of the person.	string	False
`organizations/0/locations/0/service/0/contacts/0/title`
	The job title of the person.	string	False
`organizations/0/locations/0/service/0/contacts/0/department`
	The department that the person is part of.	string	False
`organizations/0/locations/0/service/0/contacts/0/email`
	The email address of the person.	string	False
`organizations/0/locations/0/service/0/contacts/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/locations/0/service/0/contacts/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`organizations/0/locations/0/service/0/contacts/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`organizations/0/locations/0/service/0/contacts/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`organizations/0/locations/0/service/0/contacts/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`organizations/0/locations/0/service/0/contacts/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`organizations/0/locations/0/service/0/contacts/0/phones/0/number`
	The phone number.	string	True
`organizations/0/locations/0/service/0/contacts/0/phones/0/extension`
	The extension of the phone number.	string	False
`organizations/0/locations/0/service/0/contacts/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`organizations/0/locations/0/service/0/contacts/0/phones/0/department`
	The department for which this is the phone number.	string	False
`organizations/0/locations/0/service/0/contacts/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`organizations/0/locations/0/service/0/contacts/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`organizations/0/locations/0/service/0/eligibility/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/locations/0/service/0/eligibility/0/service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`organizations/0/locations/0/service/0/eligibility/0/eligibility`
	The rules or guidelines that determine who can receive the service.	string	False
`organizations/0/locations/0/service/0/fees/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/locations/0/service/0/fees/0/service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`organizations/0/locations/0/service/0/fees/0/fee`
	A listing of the costs of services, including free ones.	string	False
`organizations/0/locations/0/service/0/funding/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/locations/0/service/0/funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`organizations/0/locations/0/service/0/funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`organizations/0/locations/0/service/0/funding/0/source`
	Source of funds for organization or service.	string	False
`organizations/0/locations/0/service/0/regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/locations/0/service/0/regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`organizations/0/locations/0/service/0/regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`organizations/0/locations/0/service/0/regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`organizations/0/locations/0/service/0/regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`organizations/0/locations/0/service/0/regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`organizations/0/locations/0/service/0/regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`organizations/0/locations/0/service/0/holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/locations/0/service/0/holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`organizations/0/locations/0/service/0/holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`organizations/0/locations/0/service/0/holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`organizations/0/locations/0/service/0/holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`organizations/0/locations/0/service/0/holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`organizations/0/locations/0/service/0/holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`organizations/0/locations/0/service/0/holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`organizations/0/locations/0/service/0/holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`organizations/0/locations/0/service/0/languages/0/id`
	Each language must have a unique identifier.	string	True
`organizations/0/locations/0/service/0/languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`organizations/0/locations/0/service/0/languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`organizations/0/locations/0/service/0/languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`organizations/0/locations/0/service/0/payment_accepted/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/locations/0/service/0/payment_accepted/0/service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`organizations/0/locations/0/service/0/payment_accepted/0/payment`
	The methods of payment accepted for the service.	string	False
`organizations/0/locations/0/service/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/locations/0/service/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`organizations/0/locations/0/service/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`organizations/0/locations/0/service/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`organizations/0/locations/0/service/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`organizations/0/locations/0/service/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`organizations/0/locations/0/service/0/phones/0/number`
	The phone number.	string	True
`organizations/0/locations/0/service/0/phones/0/extension`
	The extension of the phone number.	string	False
`organizations/0/locations/0/service/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`organizations/0/locations/0/service/0/phones/0/department`
	The department for which this is the phone number.	string	False
`organizations/0/locations/0/service/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`organizations/0/locations/0/service/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`organizations/0/locations/0/service/0/required_documents/0/id`
	Each document must have a unique identifier.	string	True
`organizations/0/locations/0/service/0/required_documents/0/service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`organizations/0/locations/0/service/0/required_documents/0/document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False
`organizations/0/locations/0/service/0/service_area/0/id`
	Each service area must have a unique identifier.	string	True
`organizations/0/locations/0/service/0/service_area/0/service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`organizations/0/locations/0/service/0/service_area/0/service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`organizations/0/locations/0/service/0/service_area/0/description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False
`organizations/0/locations/0/accessibility_for_disabilities/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/locations/0/accessibility_for_disabilities/0/location_id`
	The identifier of the location for which the entry describes the accessibility provision.	string	False
`organizations/0/locations/0/accessibility_for_disabilities/0/accessibility`
	Description of assistance or infrastructure that facilitate access to clients with disabilities.	string	False
`organizations/0/locations/0/accessibility_for_disabilities/0/details`
	Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.	string	False
`organizations/0/programs/0/id`
	Each program must have a unique identifier.	string	True
`organizations/0/programs/0/organization_id`
	Each program must belong to a single organization. The identifier of the organization should be given here.	string	True
`organizations/0/programs/0/name`
	The name of the program.	string	True
`organizations/0/programs/0/alternate_name`
	NeAn alternative name for the program.	string	False
`organizations/0/services/0/id`
	Each service must have a unique identifier.	string	True
`organizations/0/services/0/organization_id`
	The identifier of the organization that provides this service.	string	True
`organizations/0/services/0/program_id`
	The identifier of the program this service is delivered under.	string	False
`organizations/0/services/0/location_id`
	The identifier of the location where this service is delivered.	string	False
`organizations/0/services/0/name`
	The official or public name of the service.	string	True
`organizations/0/services/0/alternate_name`
	Alternative or commonly used name for a service.	string	False
`organizations/0/services/0/description`
	A description of the service.	string	False
`organizations/0/services/0/url`
	URL of the service.	string	False
`organizations/0/services/0/email`
	Email address for the service.	string	False
`organizations/0/services/0/status`
	The current status of the service.	string	True
`organizations/0/services/0/interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`organizations/0/services/0/application_process`
	The steps needed to access the service.	string	False
`organizations/0/services/0/wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`organizations/0/services/0/accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`organizations/0/services/0/licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`organizations/0/services/0/contacts/0/id`
	Each contact must have a unique identifier.	string	True
`organizations/0/services/0/contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`organizations/0/services/0/contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`organizations/0/services/0/contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`organizations/0/services/0/contacts/0/name`
	The name of the person.	string	False
`organizations/0/services/0/contacts/0/title`
	The job title of the person.	string	False
`organizations/0/services/0/contacts/0/department`
	The department that the person is part of.	string	False
`organizations/0/services/0/contacts/0/email`
	The email address of the person.	string	False
`organizations/0/services/0/contacts/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/services/0/contacts/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`organizations/0/services/0/contacts/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`organizations/0/services/0/contacts/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`organizations/0/services/0/contacts/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`organizations/0/services/0/contacts/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`organizations/0/services/0/contacts/0/phones/0/number`
	The phone number.	string	True
`organizations/0/services/0/contacts/0/phones/0/extension`
	The extension of the phone number.	string	False
`organizations/0/services/0/contacts/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`organizations/0/services/0/contacts/0/phones/0/department`
	The department for which this is the phone number.	string	False
`organizations/0/services/0/contacts/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`organizations/0/services/0/contacts/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`organizations/0/services/0/eligibility/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/services/0/eligibility/0/service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`organizations/0/services/0/eligibility/0/eligibility`
	The rules or guidelines that determine who can receive the service.	string	False
`organizations/0/services/0/fees/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/services/0/fees/0/service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`organizations/0/services/0/fees/0/fee`
	A listing of the costs of services, including free ones.	string	False
`organizations/0/services/0/funding/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/services/0/funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`organizations/0/services/0/funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`organizations/0/services/0/funding/0/source`
	Source of funds for organization or service.	string	False
`organizations/0/services/0/regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/services/0/regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`organizations/0/services/0/regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`organizations/0/services/0/regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`organizations/0/services/0/regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`organizations/0/services/0/regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`organizations/0/services/0/regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`organizations/0/services/0/holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/services/0/holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`organizations/0/services/0/holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`organizations/0/services/0/holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`organizations/0/services/0/holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`organizations/0/services/0/holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`organizations/0/services/0/holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`organizations/0/services/0/holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`organizations/0/services/0/holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`organizations/0/services/0/languages/0/id`
	Each language must have a unique identifier.	string	True
`organizations/0/services/0/languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`organizations/0/services/0/languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`organizations/0/services/0/languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`organizations/0/services/0/payment_accepted/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/services/0/payment_accepted/0/service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`organizations/0/services/0/payment_accepted/0/payment`
	The methods of payment accepted for the service.	string	False
`organizations/0/services/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`organizations/0/services/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`organizations/0/services/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`organizations/0/services/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`organizations/0/services/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`organizations/0/services/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`organizations/0/services/0/phones/0/number`
	The phone number.	string	True
`organizations/0/services/0/phones/0/extension`
	The extension of the phone number.	string	False
`organizations/0/services/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`organizations/0/services/0/phones/0/department`
	The department for which this is the phone number.	string	False
`organizations/0/services/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`organizations/0/services/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`organizations/0/services/0/required_documents/0/id`
	Each document must have a unique identifier.	string	True
`organizations/0/services/0/required_documents/0/service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`organizations/0/services/0/required_documents/0/document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False
`organizations/0/services/0/service_area/0/id`
	Each service area must have a unique identifier.	string	True
`organizations/0/services/0/service_area/0/service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`organizations/0/services/0/service_area/0/service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`organizations/0/services/0/service_area/0/description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False
`locations/0/id`
	Each location must have a unique identifier.	string	True
`locations/0/organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`locations/0/name`
	The name of the location.	string	False
`locations/0/alternate_name`
	An alternative name for the location.	string	False
`locations/0/description`
	A description of this location.	string	False
`locations/0/transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`locations/0/latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`locations/0/longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`locations/0/regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`locations/0/regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`locations/0/regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`locations/0/regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`locations/0/regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`locations/0/holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`locations/0/holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`locations/0/holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`locations/0/holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`locations/0/holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`locations/0/languages/0/id`
	Each language must have a unique identifier.	string	True
`locations/0/languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`locations/0/languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`locations/0/languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`locations/0/postal_address/0/id`
	Each postal address must have a unique identifier.	string	True
`locations/0/postal_address/0/location_id`
	The identifier of the location for which this is the postal address.	string	False
`locations/0/postal_address/0/attention`
	The person or entity for whose attention mail should be marked.	string	False
`locations/0/postal_address/0/address_1`
	The first line of the address.	string	False
`locations/0/postal_address/0/address_2`
	The second line of the address.	string	False
`locations/0/postal_address/0/address_3`
	The third line of the address.	string	False
`locations/0/postal_address/0/address_4`
	The fourth line of the address.	string	False
`locations/0/postal_address/0/city`
	The city in which the address is located.	string	False
`locations/0/postal_address/0/region`
	The region in which the address is located (optional).	string	False
`locations/0/postal_address/0/state_province`
	The state or province in which the address is located.	string	False
`locations/0/postal_address/0/postal_code`
	The postal code for the address.	string	False
`locations/0/postal_address/0/country`
	The country in which the address is located.	string	False
`locations/0/physical_address/0/id`
	Each physical address must have a unique identifier.	string	True
`locations/0/physical_address/0/location_id`
	The identifier of the location for which this is the address.	string	False
`locations/0/physical_address/0/attention`
	The person or entity whose attention should be sought at the location.	string	False
`locations/0/physical_address/0/address_1`
	The first line of the address.	string	True
`locations/0/physical_address/0/address_2`
	The second line of the address.	string	False
`locations/0/physical_address/0/address_3`
	The third line of the address.	string	False
`locations/0/physical_address/0/address_4`
	The fourth line of the address.	string	False
`locations/0/physical_address/0/city`
	The city in which the address is located.	string	True
`locations/0/physical_address/0/region`
	The region in which the address is located (optional).	string	False
`locations/0/physical_address/0/state_province`
	The state or province in which the address is located.	string	True
`locations/0/physical_address/0/postal_code`
	The postal code for the address.	string	True
`locations/0/physical_address/0/country`
	The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation).	string	True
`locations/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`locations/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`locations/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`locations/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`locations/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`locations/0/phones/0/number`
	The phone number.	string	True
`locations/0/phones/0/extension`
	The extension of the phone number.	string	False
`locations/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`locations/0/phones/0/department`
	The department for which this is the phone number.	string	False
`locations/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`locations/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`locations/0/service/0/id`
	Each service must have a unique identifier.	string	True
`locations/0/service/0/organization_id`
	The identifier of the organization that provides this service.	string	True
`locations/0/service/0/program_id`
	The identifier of the program this service is delivered under.	string	False
`locations/0/service/0/location_id`
	The identifier of the location where this service is delivered.	string	False
`locations/0/service/0/name`
	The official or public name of the service.	string	True
`locations/0/service/0/alternate_name`
	Alternative or commonly used name for a service.	string	False
`locations/0/service/0/description`
	A description of the service.	string	False
`locations/0/service/0/url`
	URL of the service.	string	False
`locations/0/service/0/email`
	Email address for the service.	string	False
`locations/0/service/0/status`
	The current status of the service.	string	True
`locations/0/service/0/interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`locations/0/service/0/application_process`
	The steps needed to access the service.	string	False
`locations/0/service/0/wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`locations/0/service/0/accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`locations/0/service/0/licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`locations/0/service/0/contacts/0/id`
	Each contact must have a unique identifier.	string	True
`locations/0/service/0/contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`locations/0/service/0/contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`locations/0/service/0/contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`locations/0/service/0/contacts/0/name`
	The name of the person.	string	False
`locations/0/service/0/contacts/0/title`
	The job title of the person.	string	False
`locations/0/service/0/contacts/0/department`
	The department that the person is part of.	string	False
`locations/0/service/0/contacts/0/email`
	The email address of the person.	string	False
`locations/0/service/0/contacts/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/contacts/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`locations/0/service/0/contacts/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`locations/0/service/0/contacts/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`locations/0/service/0/contacts/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`locations/0/service/0/contacts/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`locations/0/service/0/contacts/0/phones/0/number`
	The phone number.	string	True
`locations/0/service/0/contacts/0/phones/0/extension`
	The extension of the phone number.	string	False
`locations/0/service/0/contacts/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`locations/0/service/0/contacts/0/phones/0/department`
	The department for which this is the phone number.	string	False
`locations/0/service/0/contacts/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`locations/0/service/0/contacts/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`locations/0/service/0/eligibility/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/eligibility/0/service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`locations/0/service/0/eligibility/0/eligibility`
	The rules or guidelines that determine who can receive the service.	string	False
`locations/0/service/0/fees/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/fees/0/service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`locations/0/service/0/fees/0/fee`
	A listing of the costs of services, including free ones.	string	False
`locations/0/service/0/funding/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`locations/0/service/0/funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`locations/0/service/0/funding/0/source`
	Source of funds for organization or service.	string	False
`locations/0/service/0/regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`locations/0/service/0/regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`locations/0/service/0/regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`locations/0/service/0/regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`locations/0/service/0/regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/service/0/regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/service/0/holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`locations/0/service/0/holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`locations/0/service/0/holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`locations/0/service/0/holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`locations/0/service/0/holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/service/0/holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/service/0/holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`locations/0/service/0/holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`locations/0/service/0/languages/0/id`
	Each language must have a unique identifier.	string	True
`locations/0/service/0/languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`locations/0/service/0/languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`locations/0/service/0/languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`locations/0/service/0/payment_accepted/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/payment_accepted/0/service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`locations/0/service/0/payment_accepted/0/payment`
	The methods of payment accepted for the service.	string	False
`locations/0/service/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`locations/0/service/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`locations/0/service/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`locations/0/service/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`locations/0/service/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`locations/0/service/0/phones/0/number`
	The phone number.	string	True
`locations/0/service/0/phones/0/extension`
	The extension of the phone number.	string	False
`locations/0/service/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`locations/0/service/0/phones/0/department`
	The department for which this is the phone number.	string	False
`locations/0/service/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`locations/0/service/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`locations/0/service/0/required_documents/0/id`
	Each document must have a unique identifier.	string	True
`locations/0/service/0/required_documents/0/service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`locations/0/service/0/required_documents/0/document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False
`locations/0/service/0/service_area/0/id`
	Each service area must have a unique identifier.	string	True
`locations/0/service/0/service_area/0/service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`locations/0/service/0/service_area/0/service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`locations/0/service/0/service_area/0/description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False
`locations/0/accessibility_for_disabilities/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/accessibility_for_disabilities/0/location_id`
	The identifier of the location for which the entry describes the accessibility provision.	string	False
`locations/0/accessibility_for_disabilities/0/accessibility`
	Description of assistance or infrastructure that facilitate access to clients with disabilities.	string	False
`locations/0/accessibility_for_disabilities/0/details`
	Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.	string	False
`services/0/id`
	Each service must have a unique identifier.	string	True
`services/0/organization_id`
	The identifier of the organization that provides this service.	string	True
`services/0/program_id`
	The identifier of the program this service is delivered under.	string	False
`services/0/location_id`
	The identifier of the location where this service is delivered.	string	False
`services/0/name`
	The official or public name of the service.	string	True
`services/0/alternate_name`
	Alternative or commonly used name for a service.	string	False
`services/0/description`
	A description of the service.	string	False
`services/0/url`
	URL of the service.	string	False
`services/0/email`
	Email address for the service.	string	False
`services/0/status`
	The current status of the service.	string	True
`services/0/interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`services/0/application_process`
	The steps needed to access the service.	string	False
`services/0/wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`services/0/accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`services/0/licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`services/0/contacts/0/id`
	Each contact must have a unique identifier.	string	True
`services/0/contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`services/0/contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`services/0/contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`services/0/contacts/0/name`
	The name of the person.	string	False
`services/0/contacts/0/title`
	The job title of the person.	string	False
`services/0/contacts/0/department`
	The department that the person is part of.	string	False
`services/0/contacts/0/email`
	The email address of the person.	string	False
`services/0/contacts/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/contacts/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`services/0/contacts/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`services/0/contacts/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`services/0/contacts/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`services/0/contacts/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`services/0/contacts/0/phones/0/number`
	The phone number.	string	True
`services/0/contacts/0/phones/0/extension`
	The extension of the phone number.	string	False
`services/0/contacts/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`services/0/contacts/0/phones/0/department`
	The department for which this is the phone number.	string	False
`services/0/contacts/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`services/0/contacts/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`services/0/eligibility/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/eligibility/0/service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`services/0/eligibility/0/eligibility`
	The rules or guidelines that determine who can receive the service.	string	False
`services/0/fees/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/fees/0/service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`services/0/fees/0/fee`
	A listing of the costs of services, including free ones.	string	False
`services/0/funding/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`services/0/funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`services/0/funding/0/source`
	Source of funds for organization or service.	string	False
`services/0/regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`services/0/regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`services/0/regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`services/0/regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`services/0/regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`services/0/regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`services/0/holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`services/0/holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`services/0/holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`services/0/holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`services/0/holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`services/0/holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`services/0/holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`services/0/holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`services/0/languages/0/id`
	Each language must have a unique identifier.	string	True
`services/0/languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`services/0/languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`services/0/languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`services/0/payment_accepted/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/payment_accepted/0/service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`services/0/payment_accepted/0/payment`
	The methods of payment accepted for the service.	string	False
`services/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`services/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`services/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`services/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`services/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`services/0/phones/0/number`
	The phone number.	string	True
`services/0/phones/0/extension`
	The extension of the phone number.	string	False
`services/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`services/0/phones/0/department`
	The department for which this is the phone number.	string	False
`services/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`services/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`services/0/required_documents/0/id`
	Each document must have a unique identifier.	string	True
`services/0/required_documents/0/service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`services/0/required_documents/0/document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False
`services/0/service_area/0/id`
	Each service area must have a unique identifier.	string	True
`services/0/service_area/0/service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`services/0/service_area/0/service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`services/0/service_area/0/description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False

HSDA Taxonomy¶

The HSDA taxonomy protocol is defined by openapi-hsda-taxonomy.yaml. The details below show the available methods and responses.

This is a separate HSDA service for working with taxonomy across all the core human services resources, support any categorization or taxonomy, and allowing for filtering of services by taxonomy.

You can also explore this using our OpenAPI viewer.

Warning

This is an experimental feature. Feedback is welcome to shape its further development.

GET /taxonomy/¶

Get Taxonomy

Get Taxonomy

Status Codes

200 OK – Item Response

200 Response Body:

	Description	Type	Required
`id`
	Each taxonomy entry must have a unique identifier. If combining multiple taxonomies with overlapping identifiers, use a prefix to distinguish them.	string	True
`name`
	The name of this taxonomy term or category.	string	True
`parent_id`
	If this is a child category in a hierarchical taxonomy, give the identifier of the parent category. For top-level categories, this should be left blank.	string	False
`parent_name`
	If this is a child category in a hierarchical taxonomy, give the name of the parent category. For top-level categories, this should be left blank.	string	False
`vocabulary`
	If this is an established taxonomy, detail which taxonomy is in use. For example, AIRS or Open Eligibility.	string	False

POST /taxonomy/¶

Add taxonomy

Addtaxonomy

Status Codes

200 OK – Taxonomy Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each taxonomy entry must have a unique identifier. If combining multiple taxonomies with overlapping identifiers, use a prefix to distinguish them.	string	True
`name`
	The name of this taxonomy term or category.	string	True
`parent_id`
	If this is a child category in a hierarchical taxonomy, give the identifier of the parent category. For top-level categories, this should be left blank.	string	False
`parent_name`
	If this is a child category in a hierarchical taxonomy, give the name of the parent category. For top-level categories, this should be left blank.	string	False
`vocabulary`
	If this is an established taxonomy, detail which taxonomy is in use. For example, AIRS or Open Eligibility.	string	False

GET /taxonomys/{taxonomy_id}/¶

Get Taxonomy

Get Taxonomy

Parameters

taxonomy_id (string) – The taxonomy id.

Status Codes

200 OK – Taxonomy Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each taxonomy entry must have a unique identifier. If combining multiple taxonomies with overlapping identifiers, use a prefix to distinguish them.	string	True
`name`
	The name of this taxonomy term or category.	string	True
`parent_id`
	If this is a child category in a hierarchical taxonomy, give the identifier of the parent category. For top-level categories, this should be left blank.	string	False
`parent_name`
	If this is a child category in a hierarchical taxonomy, give the name of the parent category. For top-level categories, this should be left blank.	string	False
`vocabulary`
	If this is an established taxonomy, detail which taxonomy is in use. For example, AIRS or Open Eligibility.	string	False

PUT /taxonomys/{taxonomy_id}/¶

Update Taxonomy

Update Taxonomy

Parameters

taxonomy_id (string) – The unique taxonomy id.

Status Codes

200 OK – Taxonomy Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each taxonomy entry must have a unique identifier. If combining multiple taxonomies with overlapping identifiers, use a prefix to distinguish them.	string	True
`name`
	The name of this taxonomy term or category.	string	True
`parent_id`
	If this is a child category in a hierarchical taxonomy, give the identifier of the parent category. For top-level categories, this should be left blank.	string	False
`parent_name`
	If this is a child category in a hierarchical taxonomy, give the name of the parent category. For top-level categories, this should be left blank.	string	False
`vocabulary`
	If this is an established taxonomy, detail which taxonomy is in use. For example, AIRS or Open Eligibility.	string	False

DELETE /taxonomys/{taxonomy_id}/¶

Delete Taxonomy

Delete Taxonomy

Parameters

taxonomy_id (string) – The taxonomy id.

Status Codes

200 OK – Taxonomy Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each taxonomy entry must have a unique identifier. If combining multiple taxonomies with overlapping identifiers, use a prefix to distinguish them.	string	True
`name`
	The name of this taxonomy term or category.	string	True
`parent_id`
	If this is a child category in a hierarchical taxonomy, give the identifier of the parent category. For top-level categories, this should be left blank.	string	False
`parent_name`
	If this is a child category in a hierarchical taxonomy, give the name of the parent category. For top-level categories, this should be left blank.	string	False
`vocabulary`
	If this is an established taxonomy, detail which taxonomy is in use. For example, AIRS or Open Eligibility.	string	False

GET /services/{taxonomy_name}/¶

Get Services

Get Services

Parameters

taxonomy_name (string) – The taxonomy name.

Query Parameters

query (string) – A query to filter list by (up to provider to determine what to search)
queries (string) – A comma separate list of queries with specific fields.
page (number) – The particular page of results.
per_page (number) – Number of records return per page, up to 100.
sort_by (string) – Which field to sort by.
order (string) – Which order to sort by (asc,desc).

Status Codes

200 OK – Service Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	False
`organization_id`
	The identifier of the organization that provides this service.	string	False
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	False
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	False
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`fees`
	Details of any charges for service users to access this service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False

GET /services/complete/{taxonomy_name}/¶

Get Services (Complete)

Get Services (Complete)

Parameters

taxonomy_name (string) – The taxonomy name.

Query Parameters

query (string) – A query to filter list by (up to provider to determine what to search)
queries (string) – A comma separate list of queries with specific fields.
page (number) – The particular page of results.
per_page (number) – Number of records to return per page, up to 100.
sort_by (string) – Which field to sort by.
order (string) – Which order to sort by (asc,desc).

Status Codes

200 OK – Service Complete Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization that provides this service.	string	True
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	True
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	True
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`contacts/0/id`
	Each contact must have a unique identifier.	string	True
`contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`contacts/0/name`
	The name of the person.	string	False
`contacts/0/title`
	The job title of the person.	string	False
`contacts/0/department`
	The department that the person is part of.	string	False
`contacts/0/email`
	The email address of the person.	string	False
`eligibility/0/id`
	Each entry must have a unique identifier.	string	True
`eligibility/0/service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`eligibility/0/eligibility`
	The rules or guidelines that determine who can receive the service.	string	False
`fees/0/id`
	Each entry must have a unique identifier.	string	True
`fees/0/service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`fees/0/fee`
	A listing of the costs of services, including free ones.	string	False
`funding/0/id`
	Each entry must have a unique identifier.	string	True
`funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`funding/0/source`
	Source of funds for organization or service.	string	False
`regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`languages/0/id`
	Each language must have a unique identifier.	string	True
`languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`payment_accepted/0/id`
	Each entry must have a unique identifier.	string	True
`payment_accepted/0/service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`payment_accepted/0/payment`
	The methods of payment accepted for the service.	string	False
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`required_documents/0/id`
	Each document must have a unique identifier.	string	True
`required_documents/0/service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`required_documents/0/document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False
`service_area/0/id`
	Each service area must have a unique identifier.	string	True
`service_area/0/service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`service_area/0/service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`service_area/0/description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False

HSDA Bulk¶

The HSDA bulk protocol is defined by openapi-hsda-bulk.yaml. The details below show the available methods and responses.

This is a service for handling bulk loading of data into any HSDA service, allowing each POST and PUT to be queued up as a job, and be run on schedule, or based upon other events.

You can also explore this using our OpenAPI viewer.

Warning

This is an experimental feature. Feedback is welcome to shape its further development.

POST /contacts/¶

Submit Bulk Contact

Submit Bulk Contact

Status Codes

200 OK – Contact Response

200 Response Body:

	Description	Type	Required
`id`
	Each contact must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service_id`
	The identifier of the service for which this is a contact.	string	False
`service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`name`
	The name of the person.	string	False
`title`
	The job title of the person.	string	False
`department`
	The department that the person is part of.	string	False
`email`
	The email address of the person.	string	False
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False

POST /locations/¶

Submit Bulk Location

Submit Bulk Location

Status Codes

200 OK – Location Response

200 Response Body:

	Description	Type	Required
`id`
	Each location must have a unique identifier.	string	True
`organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`name`
	The name of the location.	string	False
`alternate_name`
	An alternative name for the location.	string	False
`description`
	A description of this location.	string	False
`transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`languages/0/id`
	Each language must have a unique identifier.	string	True
`languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`postal_address/0/id`
	Each postal address must have a unique identifier.	string	True
`postal_address/0/location_id`
	The identifier of the location for which this is the postal address.	string	False
`postal_address/0/attention`
	The person or entity for whose attention mail should be marked.	string	False
`postal_address/0/address_1`
	The first line of the address.	string	False
`postal_address/0/address_2`
	The second line of the address.	string	False
`postal_address/0/address_3`
	The third line of the address.	string	False
`postal_address/0/address_4`
	The fourth line of the address.	string	False
`postal_address/0/city`
	The city in which the address is located.	string	False
`postal_address/0/region`
	The region in which the address is located (optional).	string	False
`postal_address/0/state_province`
	The state or province in which the address is located.	string	False
`postal_address/0/postal_code`
	The postal code for the address.	string	False
`postal_address/0/country`
	The country in which the address is located.	string	False
`physical_address/0/id`
	Each physical address must have a unique identifier.	string	True
`physical_address/0/location_id`
	The identifier of the location for which this is the address.	string	False
`physical_address/0/attention`
	The person or entity whose attention should be sought at the location.	string	False
`physical_address/0/address_1`
	The first line of the address.	string	True
`physical_address/0/address_2`
	The second line of the address.	string	False
`physical_address/0/address_3`
	The third line of the address.	string	False
`physical_address/0/address_4`
	The fourth line of the address.	string	False
`physical_address/0/city`
	The city in which the address is located.	string	True
`physical_address/0/region`
	The region in which the address is located (optional).	string	False
`physical_address/0/state_province`
	The state or province in which the address is located.	string	True
`physical_address/0/postal_code`
	The postal code for the address.	string	True
`physical_address/0/country`
	The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation).	string	True
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`service/0/id`
	Each service must have a unique identifier.	string	True
`service/0/organization_id`
	The identifier of the organization that provides this service.	string	True
`service/0/program_id`
	The identifier of the program this service is delivered under.	string	False
`service/0/location_id`
	The identifier of the location where this service is delivered.	string	False
`service/0/name`
	The official or public name of the service.	string	True
`service/0/alternate_name`
	Alternative or commonly used name for a service.	string	False
`service/0/description`
	A description of the service.	string	False
`service/0/url`
	URL of the service.	string	False
`service/0/email`
	Email address for the service.	string	False
`service/0/status`
	The current status of the service.	string	True
`service/0/interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`service/0/application_process`
	The steps needed to access the service.	string	False
`service/0/wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`service/0/accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`service/0/licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`service/0/contacts/0/id`
	Each contact must have a unique identifier.	string	True
`service/0/contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`service/0/contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`service/0/contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`service/0/contacts/0/name`
	The name of the person.	string	False
`service/0/contacts/0/title`
	The job title of the person.	string	False
`service/0/contacts/0/department`
	The department that the person is part of.	string	False
`service/0/contacts/0/email`
	The email address of the person.	string	False
`service/0/contacts/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`service/0/contacts/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`service/0/contacts/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`service/0/contacts/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`service/0/contacts/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service/0/contacts/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`service/0/contacts/0/phones/0/number`
	The phone number.	string	True
`service/0/contacts/0/phones/0/extension`
	The extension of the phone number.	string	False
`service/0/contacts/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`service/0/contacts/0/phones/0/department`
	The department for which this is the phone number.	string	False
`service/0/contacts/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`service/0/contacts/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`service/0/eligibility/0/id`
	Each entry must have a unique identifier.	string	True
`service/0/eligibility/0/service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`service/0/eligibility/0/eligibility`
	The rules or guidelines that determine who can receive the service.	string	False
`service/0/fees/0/id`
	Each entry must have a unique identifier.	string	True
`service/0/fees/0/service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`service/0/fees/0/fee`
	A listing of the costs of services, including free ones.	string	False
`service/0/funding/0/id`
	Each entry must have a unique identifier.	string	True
`service/0/funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`service/0/funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`service/0/funding/0/source`
	Source of funds for organization or service.	string	False
`service/0/regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`service/0/regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`service/0/regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`service/0/regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`service/0/regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`service/0/regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`service/0/regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`service/0/holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`service/0/holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`service/0/holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`service/0/holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`service/0/holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`service/0/holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`service/0/holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`service/0/holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`service/0/holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`service/0/languages/0/id`
	Each language must have a unique identifier.	string	True
`service/0/languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`service/0/languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`service/0/languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`service/0/payment_accepted/0/id`
	Each entry must have a unique identifier.	string	True
`service/0/payment_accepted/0/service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`service/0/payment_accepted/0/payment`
	The methods of payment accepted for the service.	string	False
`service/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`service/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`service/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`service/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`service/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`service/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`service/0/phones/0/number`
	The phone number.	string	True
`service/0/phones/0/extension`
	The extension of the phone number.	string	False
`service/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`service/0/phones/0/department`
	The department for which this is the phone number.	string	False
`service/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`service/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`service/0/required_documents/0/id`
	Each document must have a unique identifier.	string	True
`service/0/required_documents/0/service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`service/0/required_documents/0/document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False
`service/0/service_area/0/id`
	Each service area must have a unique identifier.	string	True
`service/0/service_area/0/service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`service/0/service_area/0/service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`service/0/service_area/0/description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False
`accessibility_for_disabilities/0/id`
	Each entry must have a unique identifier.	string	True
`accessibility_for_disabilities/0/location_id`
	The identifier of the location for which the entry describes the accessibility provision.	string	False
`accessibility_for_disabilities/0/accessibility`
	Description of assistance or infrastructure that facilitate access to clients with disabilities.	string	False
`accessibility_for_disabilities/0/details`
	Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.	string	False

POST /organizations/¶

Submit Bulk Organizations

Submit Bulk Organizations

Status Codes

200 OK – Organization Response

200 Response Body:

	Description	Type	Required
`id`
	Each organization must have a unique identifier.	string	True
`name`
	The official or public name of the organization.	string	False
`alternate_name`
	Alternative or commonly used name for the organization.	string	False
`description`
	A brief summary about the organization. It can contain markup such as HTML or Markdow.	string	True
`email`
	The contact e-mail address for the organization.	string	False
`url`
	The URL (website address) of the organization.	string	False
`tax_status`
	Government assigned tax designation for for tax-exempt organizations.	string	False
`tax_id`
	A government issued identifier used for the purpose of tax administration.	string	False
`year_incorporated`
	The year in which the organization was legally formed.	string	False
`legal_status`
	The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.	string	False
`contacts/0/id`
	Each contact must have a unique identifier.	string	True
`contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`contacts/0/name`
	The name of the person.	string	False
`contacts/0/title`
	The job title of the person.	string	False
`contacts/0/department`
	The department that the person is part of.	string	False
`contacts/0/email`
	The email address of the person.	string	False
`contacts/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`contacts/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`contacts/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`contacts/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contacts/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`contacts/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`contacts/0/phones/0/number`
	The phone number.	string	True
`contacts/0/phones/0/extension`
	The extension of the phone number.	string	False
`contacts/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`contacts/0/phones/0/department`
	The department for which this is the phone number.	string	False
`contacts/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`contacts/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`funding/0/id`
	Each entry must have a unique identifier.	string	True
`funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`funding/0/source`
	Source of funds for organization or service.	string	False
`locations/0/id`
	Each location must have a unique identifier.	string	True
`locations/0/organization_id`
	Each location must belong to a single organization. The identifier of the organization should be given here.	string	False
`locations/0/name`
	The name of the location.	string	False
`locations/0/alternate_name`
	An alternative name for the location.	string	False
`locations/0/description`
	A description of this location.	string	False
`locations/0/transportation`
	A description of the access to public or private transportation to and from the location.	string	False
`locations/0/latitude`
	Y coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`locations/0/longitude`
	X coordinate of location expressed in decimal degrees in WGS84 datum.	string	False
`locations/0/regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`locations/0/regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`locations/0/regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`locations/0/regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`locations/0/regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`locations/0/holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`locations/0/holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`locations/0/holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`locations/0/holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`locations/0/holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`locations/0/languages/0/id`
	Each language must have a unique identifier.	string	True
`locations/0/languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`locations/0/languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`locations/0/languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`locations/0/postal_address/0/id`
	Each postal address must have a unique identifier.	string	True
`locations/0/postal_address/0/location_id`
	The identifier of the location for which this is the postal address.	string	False
`locations/0/postal_address/0/attention`
	The person or entity for whose attention mail should be marked.	string	False
`locations/0/postal_address/0/address_1`
	The first line of the address.	string	False
`locations/0/postal_address/0/address_2`
	The second line of the address.	string	False
`locations/0/postal_address/0/address_3`
	The third line of the address.	string	False
`locations/0/postal_address/0/address_4`
	The fourth line of the address.	string	False
`locations/0/postal_address/0/city`
	The city in which the address is located.	string	False
`locations/0/postal_address/0/region`
	The region in which the address is located (optional).	string	False
`locations/0/postal_address/0/state_province`
	The state or province in which the address is located.	string	False
`locations/0/postal_address/0/postal_code`
	The postal code for the address.	string	False
`locations/0/postal_address/0/country`
	The country in which the address is located.	string	False
`locations/0/physical_address/0/id`
	Each physical address must have a unique identifier.	string	True
`locations/0/physical_address/0/location_id`
	The identifier of the location for which this is the address.	string	False
`locations/0/physical_address/0/attention`
	The person or entity whose attention should be sought at the location.	string	False
`locations/0/physical_address/0/address_1`
	The first line of the address.	string	True
`locations/0/physical_address/0/address_2`
	The second line of the address.	string	False
`locations/0/physical_address/0/address_3`
	The third line of the address.	string	False
`locations/0/physical_address/0/address_4`
	The fourth line of the address.	string	False
`locations/0/physical_address/0/city`
	The city in which the address is located.	string	True
`locations/0/physical_address/0/region`
	The region in which the address is located (optional).	string	False
`locations/0/physical_address/0/state_province`
	The state or province in which the address is located.	string	True
`locations/0/physical_address/0/postal_code`
	The postal code for the address.	string	True
`locations/0/physical_address/0/country`
	The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation).	string	True
`locations/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`locations/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`locations/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`locations/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`locations/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`locations/0/phones/0/number`
	The phone number.	string	True
`locations/0/phones/0/extension`
	The extension of the phone number.	string	False
`locations/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`locations/0/phones/0/department`
	The department for which this is the phone number.	string	False
`locations/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`locations/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`locations/0/service/0/id`
	Each service must have a unique identifier.	string	True
`locations/0/service/0/organization_id`
	The identifier of the organization that provides this service.	string	True
`locations/0/service/0/program_id`
	The identifier of the program this service is delivered under.	string	False
`locations/0/service/0/location_id`
	The identifier of the location where this service is delivered.	string	False
`locations/0/service/0/name`
	The official or public name of the service.	string	True
`locations/0/service/0/alternate_name`
	Alternative or commonly used name for a service.	string	False
`locations/0/service/0/description`
	A description of the service.	string	False
`locations/0/service/0/url`
	URL of the service.	string	False
`locations/0/service/0/email`
	Email address for the service.	string	False
`locations/0/service/0/status`
	The current status of the service.	string	True
`locations/0/service/0/interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`locations/0/service/0/application_process`
	The steps needed to access the service.	string	False
`locations/0/service/0/wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`locations/0/service/0/accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`locations/0/service/0/licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`locations/0/service/0/contacts/0/id`
	Each contact must have a unique identifier.	string	True
`locations/0/service/0/contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`locations/0/service/0/contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`locations/0/service/0/contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`locations/0/service/0/contacts/0/name`
	The name of the person.	string	False
`locations/0/service/0/contacts/0/title`
	The job title of the person.	string	False
`locations/0/service/0/contacts/0/department`
	The department that the person is part of.	string	False
`locations/0/service/0/contacts/0/email`
	The email address of the person.	string	False
`locations/0/service/0/contacts/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/contacts/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`locations/0/service/0/contacts/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`locations/0/service/0/contacts/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`locations/0/service/0/contacts/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`locations/0/service/0/contacts/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`locations/0/service/0/contacts/0/phones/0/number`
	The phone number.	string	True
`locations/0/service/0/contacts/0/phones/0/extension`
	The extension of the phone number.	string	False
`locations/0/service/0/contacts/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`locations/0/service/0/contacts/0/phones/0/department`
	The department for which this is the phone number.	string	False
`locations/0/service/0/contacts/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`locations/0/service/0/contacts/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`locations/0/service/0/eligibility/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/eligibility/0/service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`locations/0/service/0/eligibility/0/eligibility`
	The rules or guidelines that determine who can receive the service.	string	False
`locations/0/service/0/fees/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/fees/0/service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`locations/0/service/0/fees/0/fee`
	A listing of the costs of services, including free ones.	string	False
`locations/0/service/0/funding/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`locations/0/service/0/funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`locations/0/service/0/funding/0/source`
	Source of funds for organization or service.	string	False
`locations/0/service/0/regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`locations/0/service/0/regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`locations/0/service/0/regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`locations/0/service/0/regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`locations/0/service/0/regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/service/0/regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/service/0/holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`locations/0/service/0/holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`locations/0/service/0/holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`locations/0/service/0/holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`locations/0/service/0/holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/service/0/holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`locations/0/service/0/holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`locations/0/service/0/holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`locations/0/service/0/languages/0/id`
	Each language must have a unique identifier.	string	True
`locations/0/service/0/languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`locations/0/service/0/languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`locations/0/service/0/languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`locations/0/service/0/payment_accepted/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/payment_accepted/0/service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`locations/0/service/0/payment_accepted/0/payment`
	The methods of payment accepted for the service.	string	False
`locations/0/service/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/service/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`locations/0/service/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`locations/0/service/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`locations/0/service/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`locations/0/service/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`locations/0/service/0/phones/0/number`
	The phone number.	string	True
`locations/0/service/0/phones/0/extension`
	The extension of the phone number.	string	False
`locations/0/service/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`locations/0/service/0/phones/0/department`
	The department for which this is the phone number.	string	False
`locations/0/service/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`locations/0/service/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`locations/0/service/0/required_documents/0/id`
	Each document must have a unique identifier.	string	True
`locations/0/service/0/required_documents/0/service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`locations/0/service/0/required_documents/0/document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False
`locations/0/service/0/service_area/0/id`
	Each service area must have a unique identifier.	string	True
`locations/0/service/0/service_area/0/service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`locations/0/service/0/service_area/0/service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`locations/0/service/0/service_area/0/description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False
`locations/0/accessibility_for_disabilities/0/id`
	Each entry must have a unique identifier.	string	True
`locations/0/accessibility_for_disabilities/0/location_id`
	The identifier of the location for which the entry describes the accessibility provision.	string	False
`locations/0/accessibility_for_disabilities/0/accessibility`
	Description of assistance or infrastructure that facilitate access to clients with disabilities.	string	False
`locations/0/accessibility_for_disabilities/0/details`
	Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.	string	False
`programs/0/id`
	Each program must have a unique identifier.	string	True
`programs/0/organization_id`
	Each program must belong to a single organization. The identifier of the organization should be given here.	string	True
`programs/0/name`
	The name of the program.	string	True
`programs/0/alternate_name`
	NeAn alternative name for the program.	string	False
`services/0/id`
	Each service must have a unique identifier.	string	True
`services/0/organization_id`
	The identifier of the organization that provides this service.	string	True
`services/0/program_id`
	The identifier of the program this service is delivered under.	string	False
`services/0/location_id`
	The identifier of the location where this service is delivered.	string	False
`services/0/name`
	The official or public name of the service.	string	True
`services/0/alternate_name`
	Alternative or commonly used name for a service.	string	False
`services/0/description`
	A description of the service.	string	False
`services/0/url`
	URL of the service.	string	False
`services/0/email`
	Email address for the service.	string	False
`services/0/status`
	The current status of the service.	string	True
`services/0/interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`services/0/application_process`
	The steps needed to access the service.	string	False
`services/0/wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`services/0/accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`services/0/licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`services/0/contacts/0/id`
	Each contact must have a unique identifier.	string	True
`services/0/contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`services/0/contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`services/0/contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`services/0/contacts/0/name`
	The name of the person.	string	False
`services/0/contacts/0/title`
	The job title of the person.	string	False
`services/0/contacts/0/department`
	The department that the person is part of.	string	False
`services/0/contacts/0/email`
	The email address of the person.	string	False
`services/0/contacts/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/contacts/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`services/0/contacts/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`services/0/contacts/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`services/0/contacts/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`services/0/contacts/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`services/0/contacts/0/phones/0/number`
	The phone number.	string	True
`services/0/contacts/0/phones/0/extension`
	The extension of the phone number.	string	False
`services/0/contacts/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`services/0/contacts/0/phones/0/department`
	The department for which this is the phone number.	string	False
`services/0/contacts/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`services/0/contacts/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`services/0/eligibility/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/eligibility/0/service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`services/0/eligibility/0/eligibility`
	The rules or guidelines that determine who can receive the service.	string	False
`services/0/fees/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/fees/0/service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`services/0/fees/0/fee`
	A listing of the costs of services, including free ones.	string	False
`services/0/funding/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`services/0/funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`services/0/funding/0/source`
	Source of funds for organization or service.	string	False
`services/0/regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`services/0/regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`services/0/regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`services/0/regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`services/0/regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`services/0/regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`services/0/holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`services/0/holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`services/0/holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`services/0/holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`services/0/holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`services/0/holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`services/0/holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`services/0/holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`services/0/languages/0/id`
	Each language must have a unique identifier.	string	True
`services/0/languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`services/0/languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`services/0/languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`services/0/payment_accepted/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/payment_accepted/0/service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`services/0/payment_accepted/0/payment`
	The methods of payment accepted for the service.	string	False
`services/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`services/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`services/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`services/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`services/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`services/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`services/0/phones/0/number`
	The phone number.	string	True
`services/0/phones/0/extension`
	The extension of the phone number.	string	False
`services/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`services/0/phones/0/department`
	The department for which this is the phone number.	string	False
`services/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`services/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`services/0/required_documents/0/id`
	Each document must have a unique identifier.	string	True
`services/0/required_documents/0/service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`services/0/required_documents/0/document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False
`services/0/service_area/0/id`
	Each service area must have a unique identifier.	string	True
`services/0/service_area/0/service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`services/0/service_area/0/service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`services/0/service_area/0/description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False

POST /services/¶

Submit Bulk Service

Submit Bulk Service

Status Codes

200 OK – Service Response

200 Response Body:

	Description	Type	Required
`id`
	Each service must have a unique identifier.	string	True
`organization_id`
	The identifier of the organization that provides this service.	string	True
`program_id`
	The identifier of the program this service is delivered under.	string	False
`location_id`
	The identifier of the location where this service is delivered.	string	False
`name`
	The official or public name of the service.	string	True
`alternate_name`
	Alternative or commonly used name for a service.	string	False
`description`
	A description of the service.	string	False
`url`
	URL of the service.	string	False
`email`
	Email address for the service.	string	False
`status`
	The current status of the service.	string	True
`interpretation_services`
	A description of any interpretation services available for accessing this service.	string	False
`application_process`
	The steps needed to access the service.	string	False
`wait_time`
	Time a client may expect to wait before receiving a service.	string	False
`accreditations`
	Details of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.	string	False
`licenses`
	An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.	string	False
`contacts/0/id`
	Each contact must have a unique identifier.	string	True
`contacts/0/organization_id`
	The identifier of the organization for which this is a contact.	string	False
`contacts/0/service_id`
	The identifier of the service for which this is a contact.	string	False
`contacts/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this contact is specific to a service in a particular location.	string	False
`contacts/0/name`
	The name of the person.	string	False
`contacts/0/title`
	The job title of the person.	string	False
`contacts/0/department`
	The department that the person is part of.	string	False
`contacts/0/email`
	The email address of the person.	string	False
`contacts/0/phones/0/id`
	Each entry must have a unique identifier.	string	True
`contacts/0/phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`contacts/0/phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`contacts/0/phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`contacts/0/phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`contacts/0/phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`contacts/0/phones/0/number`
	The phone number.	string	True
`contacts/0/phones/0/extension`
	The extension of the phone number.	string	False
`contacts/0/phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`contacts/0/phones/0/department`
	The department for which this is the phone number.	string	False
`contacts/0/phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`contacts/0/phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`eligibility/0/id`
	Each entry must have a unique identifier.	string	True
`eligibility/0/service_id`
	The identifier of the service for which this entry describes the eligibility criteria.	string	False
`eligibility/0/eligibility`
	The rules or guidelines that determine who can receive the service.	string	False
`fees/0/id`
	Each entry must have a unique identifier.	string	True
`fees/0/service_id`
	The identifier of the service for which this entry describes the costs of service.	string	False
`fees/0/fee`
	A listing of the costs of services, including free ones.	string	False
`funding/0/id`
	Each entry must have a unique identifier.	string	True
`funding/0/organization_id`
	The identifier of the organization for which this entry describes the source of funding.	string	False
`funding/0/service_id`
	The identifier of the service for which this entry describes the source of funding.	string	False
`funding/0/source`
	Source of funds for organization or service.	string	False
`regular_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`regular_schedule/0/service_id`
	The identifier of the service for which this is the regular schedule.	string	False
`regular_schedule/0/location_id`
	The identifier of the location for which this is the regular schedule.	string	False
`regular_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`regular_schedule/0/weekday`
	The day of the week that this entry relates to.	string	True
`regular_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`regular_schedule/0/closes_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/id`
	Each entry must have a unique identifier.	string	True
`holiday_schedule/0/service_id`
	The identifier of the service for which this is the holiday schedule.	string	False
`holiday_schedule/0/location_id`
	The identifier of the location for which this is the holiday schedule.	string	False
`holiday_schedule/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.	string	False
`holiday_schedule/0/closed`
	Indicates if a service or location is closed during a public holiday.	boolean	True
`holiday_schedule/0/opens_at`
	The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/closes_at`
	The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.	string	False
`holiday_schedule/0/start_date`
	The first day that a service or location is closed during a public or private holiday.	string	True
`holiday_schedule/0/end_date`
	The last day that a service or location is closed during a public or private holiday.	string	True
`languages/0/id`
	Each language must have a unique identifier.	string	True
`languages/0/service_id`
	The identifier of the service for which the entry describes the languages in which services are delivered.	string	False
`languages/0/location_id`
	The identifier of the location for which the entry describes the languages in which services are delivered.	string	False
`languages/0/language`
	Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..	string	False
`payment_accepted/0/id`
	Each entry must have a unique identifier.	string	True
`payment_accepted/0/service_id`
	The identifier of the services for which the entry describes the accepted payment methods.	string	False
`payment_accepted/0/payment`
	The methods of payment accepted for the service.	string	False
`phones/0/id`
	Each entry must have a unique identifier.	string	True
`phones/0/location_id`
	The identifier of the location where this phone number is located.	string	False
`phones/0/service_id`
	The identifier of the service for which this is the phone number.	string	False
`phones/0/organization_id`
	The identifier of the organisation for which this is the phone number.	string	False
`phones/0/contact_id`
	The identifier of the contact for which this is the phone number.	string	False
`phones/0/service_at_location_id`
	The identifier of the ‘service at location’ table entry, when this phone number is specific to a service in a particular location.	string	False
`phones/0/number`
	The phone number.	string	True
`phones/0/extension`
	The extension of the phone number.	string	False
`phones/0/type`
	Whether the phone number relates to a fixed or cellular phone.	string	False
`phones/0/department`
	The department for which this is the phone number.	string	False
`phones/0/language`
	A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.	string	False
`phones/0/description`
	A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.	string	False
`required_documents/0/id`
	Each document must have a unique identifier.	string	True
`required_documents/0/service_id`
	The identifier of the service for which this entry describes the required document.	string	False
`required_documents/0/document`
	The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.	string	False
`service_area/0/id`
	Each service area must have a unique identifier.	string	True
`service_area/0/service_id`
	The identifier of the service for which this entry describes the service area.	string	False
`service_area/0/service_area`
	The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.	string	False
`service_area/0/description`
	A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.	string	False

GET /jobs/¶

Get Jobs

Get Jobs

Query Parameters

query (string) – A query to filter list by (up to provider to determine what to search)
queries (string) – A comma separate list of queries with specific fields.
page (number) – The particular page of results.
per_page (number) – Number of records to return per page, up to 100.
sort_by (string) – Which field to sort by.
order (string) – Which order to sort by (asc,desc).

Status Codes

200 OK – Job Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	The unique id of the job	string	False
`path`
	The path the job is being run against.	string	False
`verb`
	The verb the job is being run against.	string	False
`status`
	The status of the job.	string	False
`complete`
	The date the job was completed.	date	False

GET /jobs/{job_id}/run/¶

Run Job

Run a specific job

Parameters

job_id (string) – The unique id of the job to run.

Status Codes

200 OK – Job Complete Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	The unique id of the job	string	False
`path`
	The path the job is being run against.	string	False
`verb`
	The verb the job is being run against.	string	False
`status`
	The status of the job.	string	False
`complete`
	The date the job was completed.	date	False

HSDA Orchestration¶

The HSDA orchestration protocol is defined by openapi-hsda-orchestration.yaml. The details below show the available methods and responses.

This is a HSDA sevice specifically intended to manage orchestration around HSDA operations, enabling the system to become a two-way street, pushing data outside individual implementations. The system uses webhooks, and events to understand changes made to the HSDA system, and the data stored within.

You can also explore this using our OpenAPI viewer.

Warning

This is an experimental feature. Feedback is welcome to shape its further development.

GET /services/¶

Services

The services being used across ochestration.

Status Codes

200 OK – Service Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`user_id`
	The id for the user.	string	True
`service`
	The service name.	string	False
`path`
	The path name.	string	True
`verb`
	The verb.	string	True

POST /services/¶

Add Service

Add Service

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`user_id`
	The id for the user.	string	True
`service`
	The service name.	string	False
`path`
	The path name.	string	True
`verb`
	The verb.	string	True

GET /services/{service_id}/¶

Get Service

Get Service

Parameters

service_id (string) – The service id.

Status Codes

200 OK – Service Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`user_id`
	The id for the user.	string	True
`service`
	The service name.	string	False
`path`
	The path name.	string	True
`verb`
	The verb.	string	True

PUT /services/{service_id}/¶

Update Service

Update an existing service.

Parameters

service_id (string) – The service id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`user_id`
	The id for the user.	string	True
`service`
	The service name.	string	False
`path`
	The path name.	string	True
`verb`
	The verb.	string	True

DELETE /services/{service_id}/¶

Delete Service

Delete Service

Parameters

service_id (string) – The service id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`user_id`
	The id for the user.	string	True
`service`
	The service name.	string	False
`path`
	The path name.	string	True
`verb`
	The verb.	string	True

GET /events/¶

Events

The are the events that can occur.

Status Codes

200 OK – Event Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each event has unique identifier.	string	True
`service`
	The name of the service the event will run against.	string	True
`path`
	The path the event will run against.	string	True
`verb`
	The verb the event will run against.	string	True
`description`
	The description of the event.	string	True

POST /events/¶

Add Event

Add Event

Status Codes

200 OK – Event Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each event has unique identifier.	string	True
`service`
	The name of the service the event will run against.	string	True
`path`
	The path the event will run against.	string	True
`verb`
	The verb the event will run against.	string	True
`description`
	The description of the event.	string	True

GET /events/{event_id}/¶

Get Event

Get Event

Parameters

event_id (string) – The event id.

Status Codes

200 OK – Event Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each event has unique identifier.	string	True
`service`
	The name of the service the event will run against.	string	True
`path`
	The path the event will run against.	string	True
`verb`
	The verb the event will run against.	string	True
`description`
	The description of the event.	string	True

PUT /events/{event_id}/¶

Update Event

Update an existing event.

Parameters

event_id (string) – The event id.

Status Codes

200 OK – Event Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each event has unique identifier.	string	True
`service`
	The name of the service the event will run against.	string	True
`path`
	The path the event will run against.	string	True
`verb`
	The verb the event will run against.	string	True
`description`
	The description of the event.	string	True

DELETE /events/{event_id}/¶

Delete Event

Delete Event

Parameters

event_id (string) – The event id.

Status Codes

200 OK – Event Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each event has unique identifier.	string	True
`service`
	The name of the service the event will run against.	string	True
`path`
	The path the event will run against.	string	True
`verb`
	The verb the event will run against.	string	True
`description`
	The description of the event.	string	True

GET /webhooks/¶

Webhooks

The webhooks currently in operation.

Status Codes

200 OK – Webhook Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each webhook has a unique identifier.	string	True
`event_id`
	The event id for this webhook.	string	True

POST /webhooks/¶

Add Webhook

Add Webhook

Status Codes

200 OK – Webhook Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each webhook has a unique identifier.	string	True
`event_id`
	The event id for this webhook.	string	True

GET /webhooks/{webhook_id}/¶

Get Webhook

Get Webhook

Parameters

webhook_id (string) – The webhook id.

Status Codes

200 OK – Webhook Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each webhook has a unique identifier.	string	True
`event_id`
	The event id for this webhook.	string	True

PUT /webhooks/{webhook_id}/¶

Update Webhook

Update Webhook

Parameters

webhook_id (string) – The webhook id.

Status Codes

200 OK – Webhook Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each webhook has a unique identifier.	string	True
`event_id`
	The event id for this webhook.	string	True

DELETE /webhooks/{webhook_id}/¶

Delete Webhook

Delete Webhook

Parameters

webhook_id (string) – The webhook id.

Status Codes

200 OK – Webhook Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each webhook has a unique identifier.	string	True
`event_id`
	The event id for this webhook.	string	True

HSDA Meta¶

The HSDA meta protocol is defined by openapi-hsda-meta.yaml. The details below show the available methods and responses.

This is a HSDA service specifically intended to manage the meta data around human services data API operations. Essentially this is a logging system, providing access to data about what API calls are made, managing individual resources, as well as any other service in use association with HSDA operations.

You can also explore this using our OpenAPI viewer.

Warning

This is an experimental feature. Feedback is welcome to shape its further development.

GET /meta/¶

Get Meta

Get Meta

Status Codes

200 OK – Item Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`timestamp`
	The timestamp for entry (yyyy-mm-dd)	string	False
`appid`
	The appid for entry.	string	False
`system`
	The system for entry.	string	False
`path`
	The path for entry.	string	False
`verb`
	The verb for entry.	string	False
`request_parameters`
	The parameters for entry.	string	False
`request_headers`
	The header for entry.	string	False
`request_body`
	The body for entry.	string	False
`response_body`
	The body for entry.	string	False
`status`
	The status of this entry (Complete, Waiting)	string	False

POST /meta/¶

Add Meta

Add Meta

Status Codes

200 OK – Meta Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`timestamp`
	The timestamp for entry (yyyy-mm-dd)	string	False
`appid`
	The appid for entry.	string	False
`system`
	The system for entry.	string	False
`path`
	The path for entry.	string	False
`verb`
	The verb for entry.	string	False
`request_parameters`
	The parameters for entry.	string	False
`request_headers`
	The header for entry.	string	False
`request_body`
	The body for entry.	string	False
`response_body`
	The body for entry.	string	False
`status`
	The status of this entry (Complete, Waiting)	string	False

GET /meta/{meta_id}/¶

Get Meta

Get Meta

Parameters

meta_id (string) – The meta id.

Status Codes

200 OK – Meta Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`timestamp`
	The timestamp for entry (yyyy-mm-dd)	string	False
`appid`
	The appid for entry.	string	False
`system`
	The system for entry.	string	False
`path`
	The path for entry.	string	False
`verb`
	The verb for entry.	string	False
`request_parameters`
	The parameters for entry.	string	False
`request_headers`
	The header for entry.	string	False
`request_body`
	The body for entry.	string	False
`response_body`
	The body for entry.	string	False
`status`
	The status of this entry (Complete, Waiting)	string	False

PUT /meta/{meta_id}/¶

Update Meta

Update an existing meta entry.

Parameters

meta_id (string) – The meta id.

Status Codes

200 OK – Meta Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`timestamp`
	The timestamp for entry (yyyy-mm-dd)	string	False
`appid`
	The appid for entry.	string	False
`system`
	The system for entry.	string	False
`path`
	The path for entry.	string	False
`verb`
	The verb for entry.	string	False
`request_parameters`
	The parameters for entry.	string	False
`request_headers`
	The header for entry.	string	False
`request_body`
	The body for entry.	string	False
`response_body`
	The body for entry.	string	False
`status`
	The status of this entry (Complete, Waiting)	string	False

HSDA Management¶

The HSDA management protocol is defined by openapi-hsda-management.yaml. The details below show the available methods and responses.

This is a HSDA service specifically intended to assist in managing HSDA access, allowing users to get at resources made available any HSDA implementation. Providing the ability to manage users, and the HSDA services they have access to.

Note: services in this context refers to ‘web services’, not to ‘human services’.

You can also explore this using our OpenAPI viewer.

Warning

This is an experimental feature. Feedback is welcome to shape its further development.

GET /users/¶

Get Users

Get Users

Query Parameters

query (string) – A query to filter list by (up to provider to determine what to search)
queries (string) – A comma separate list of queries with specific fields.
page (number) – The particular page of results.
per_page (number) – Number of records to return per page, up to 100.
sortby (string) – Which field to sort by.
order (string) – Which order to sort by (asc,desc).

Status Codes

200 OK – Item Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`login`
	The login for a user.	string	True
`name`
	The name for a user.	string	True
`email`
	The email for a user.	string	True
`code`
	The unique code for user (Github Token)	string	True

POST /users/¶

Add User

Add User

Status Codes

200 OK – User Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`login`
	The login for a user.	string	True
`name`
	The name for a user.	string	True
`email`
	The email for a user.	string	True
`code`
	The unique code for user (Github Token)	string	True

GET /users/auth/¶

Auth Users

Auth Users

Query Parameters

login (string) – A users login
code (string) – A uses code

Status Codes

200 OK – Auth Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`user_id`
	The id for the user.	string	True
`name`
	The name of the service the user has access to.	string	False
`path`
	The path user has access to.	string	True
`verb`
	The verb user has access to.	string	True

GET /users/{user_id}/¶

Get User

Get User

Parameters

user_id (string) – The user id.

Status Codes

200 OK – User Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`login`
	The login for a user.	string	True
`name`
	The name for a user.	string	True
`email`
	The email for a user.	string	True
`code`
	The unique code for user (Github Token)	string	True

PUT /users/{user_id}/¶

Update User

Update an existing user.

Parameters

user_id (string) – The user id.

Status Codes

200 OK – User Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`login`
	The login for a user.	string	True
`name`
	The name for a user.	string	True
`email`
	The email for a user.	string	True
`code`
	The unique code for user (Github Token)	string	True

DELETE /users/{user_id}/¶

Delete User

Delete User

Parameters

user_id (string) – The user id.

Status Codes

200 OK – User Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`login`
	The login for a user.	string	True
`name`
	The name for a user.	string	True
`email`
	The email for a user.	string	True
`code`
	The unique code for user (Github Token)	string	True

GET /services/¶

Get Services

Get Services

Query Parameters

query (string) – A query to filter list by (up to provider to determine what to search)
queries (string) – A comma separate list of queries with specific fields.
page (number) – The particular page of results.
per_page (number) – Number of records to return per page, up to 100.
sortby (string) – Which field to sort by.
order (string) – Which order to sort by (asc,desc).

Status Codes

200 OK – Item Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`user_id`
	The id for the user.	string	True
`name`
	The name of the service the user has access to.	string	False
`path`
	The path user has access to.	string	True
`verb`
	The verb user has access to.	string	True

POST /services/¶

Add Service

Add Service

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`user_id`
	The id for the user.	string	True
`name`
	The name of the service the user has access to.	string	False
`path`
	The path user has access to.	string	True
`verb`
	The verb user has access to.	string	True

GET /services/{service_id}/¶

Get Service

Get Service

Parameters

service_id (string) – The service id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`user_id`
	The id for the user.	string	True
`name`
	The name of the service the user has access to.	string	False
`path`
	The path user has access to.	string	True
`verb`
	The verb user has access to.	string	True

PUT /services/{service_id}/¶

Update Service

Update an existing service.

Parameters

service_id (string) – The service id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`user_id`
	The id for the user.	string	True
`name`
	The name of the service the user has access to.	string	False
`path`
	The path user has access to.	string	True
`verb`
	The verb user has access to.	string	True

DELETE /services/{service_id}/¶

Delete Service

Delete Service

Parameters

service_id (string) – The service id.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`user_id`
	The id for the user.	string	True
`name`
	The name of the service the user has access to.	string	False
`path`
	The path user has access to.	string	True
`verb`
	The verb user has access to.	string	True

HSDA Utility¶

The HSDA utility protocol is defined by openapi-hsda-utility.yaml. The details below show the available methods and responses.

You can also explore this using our OpenAPI viewer.

Warning

This is an experimental feature. Feedback is welcome to shape its further development.

GET /services/¶

Services

The services being used across ochestration.

Status Codes

200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each entry must have a unique identifier.	string	True
`name`
	The service name.	string	True
`path`
	The path name.	string	True
`verb`
	The verb.	string	True

GET /schema/build/¶

Schema Build

This will generate static files for all definitions in OpenAPIs

Status Codes

200 OK – Schema Build Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`service`
	The service of the schema	string	False
`definition`
	The definition of the schema.	string	False
`file`
	The file name being created.	string	False

POST /validate/hsda/definition/¶

Validate HSDA Response

Validate HSDA Response

Query Parameters

name (string) – The name of the service which is being validated.
path (string) – The path which is being validated.
verb (string) – The verb which is being validated.

Status Codes

200 OK – Validate HSDA Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each validation has a unique id.	string	True
`service`
	The service that is being validated.	string	True
`path`
	The path that is being validated.	string	True
`verb`
	The verb that is being validated.	string	True
`valid`
	Whether or not the schema was valid.	boolean	False
`message`
	A message describing the validation.	string	False

POST /validate/hsda/openapi/¶

Validate HSDA OpenAPI

Validate HSDA OpenAPI

Status Codes

200 OK – Validate HSDA OpenAPI Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response

200 Response Body:

	Description	Type	Required
`id`
	Each validation has a unique id.	string	True
`service`
	The service that is being validated.	string	True
`valid`
	Whether or not the schema was valid.	boolean	False
`message`
	A message describing the validation.	string	False

Reference Implementation¶

_images/hsda-miami.png

The Open Referral Developer Portal serves as both fully-functional documentation of the HSDA suite and re-deployable code that can serve as a developer portal for any resource referral platform.

You can use the portal to explore how a fully implemented API should respond to various requests. As the Miami implementation of this portal shows you can fork the code and use it provide developers with clear information on your own API implementation.

Governance¶

To promote participation and accessibility, this site serves as the working draft of the next version of Human Services Data Specification and the Human Services Data API.

Our specifications evolve through iterative cycles of proposals, requests for comment, testing, and evaluation. During active development phases, we designate technical leads and ad hoc working groups to facilitate these cycles.

Open Referral’s governance model is described in greater detail in our Project Documentation.

Get Involved¶

You can contribute to the development of these protocols in several ways:

Add annotations to this documentation site using hypothes.is - hypothes.is is an annotation service that is embedded in this site. (See the buttons in the top-right of this page.) Just highlight any text, and then use the pop-up box to add your comments. You will need to sign-up for a free account with hypothes.is.
Add a new issue or engage with an existing issue on GitHub. We use this issue tracker to schedule all formal updates to the specification. Anyone can view and search the issues already raised. You will need to sign-up for a free GitHub account to comment or create issues.
Join our community forum where discussions around the specification are encouraged.
Attend our weekly office hours. At noon EST each week (more or less!) the Open Referral leadership convenes to discuss any issues that participants bring up. We coordinate this in Slack; email info@openreferral.org to request an invite.

Roadmap¶

You can find upcoming milestones and issues on our development roadmap through the specification’s issue tracker

Design Principles¶

The design of Human Services Data Specification (HSDS) is based on five principles: simplicity, factuality, fidelity, provenance, and accessibility.

The underlying model is simple, consisting of four entities and associated properties that support who, what, where, when, and how questions. The relationships between the entities are flexible and can model the majority of use cases for human services data. The goal is to build the simplest useful thing.

The data provided in HSDS are factual. This means that the information is verifiable and can be reproduced across different systems and applications.

Data fidelity is important. Data reproduced and used across different information systems must retain the same meaning and be represented in a consistent way. Toward this end, HSDS leverages the use of existing standards such as ISO time and date formats.

The format also specifies information about the provenance of the data, as well as a history of changes, in order to provide an authoritative source. The format supports column level metadata for a high degree of granularity.

In order to ensure accessibility, the data must be a machine-readable and -writable format that can also be created, updated and deleted with a basic text editor.

Frequently Asked Questions¶

This FAQ provides context for the Open Referral Initiative and its Human Services Data Specification (HSDS). You can read more about Open Referral at https://openreferral.org

What is Open Referral?¶

The Open Referral Initiative is a network of people and organizations working to promote the accessibility of information about health, human, and social services — i.e. community resource directory data.

Our Human Service Data Specification (AKA ‘the Open Referral format’) is a data exchange format that enables resource directory data to be shared among heterogeneous information systems.

Open Referral’s ecosystem includes a range of open source tools and web applications that facilitate the flow of resource directory information. The the Ohana API is an open source ‘reference implementation’ for the Open Referral format, and Ohana Web Search (for example) is a resource locator website that works with the Ohana API (or compatible APIs).

More tools are in development by members of Open Referral’s network, members of which are primarily assembled in our Google Group.

Who started Open Referral?¶

Greg Bloom is the instigator and lead organizer of Open Referral, which emerged from work done in the DC Open211 project, and which was first described Towards a Community Data Commons, an essay published in Code for America’s 2013 book Beyond Transparency.

Our work was initially co-sponsored by Code for America and the Ohana Project, with funding from the Knight Foundation.

Who is the audience for Open Referral?¶

There are three types of ultimate stakeholders for Open Referral: 1) people in need of help of some kind (‘help-seekers’) — and 2) people who are in some kind of position to assist such help-seekers (‘service providers’). Another important stakeholder group is comprised of 3) ‘researchers’ — i.e. analysts, as well as policymakers and funders and anyone seeking to understand the patterns of resource allocation in their community.

The primary users of Open Referral are people and organizations that aggregate, maintain, and/or deliver community resource directory data — we simplify this by referring to such stakeholders as database administrators. Our objective is to help such database administrators share higher quality resource directory data at lower cost, with the goal of making it easier for people to find such information across a wide array of channels.

Read more about each of these types of users here in our User Personas documentation.

How is this project relevant to me?¶

Open Referral helps people and organizations grapple with the complex problem of maintaining and publishing reliable information about the health, human, and social services available to people in need.

Most of our work does not involve writing code. We facilitate collaborative action among institutions that have mutual interest in cooperation.

That said, Open Referral is an open network. Anyone is free to use our data specification and tools in pursuit of our shared goals.

If you have resource directory data that you wish to make more available — or if there’s an organization in your community that might make its data more broadly accessible, then you could get to work right away.

Read more in our Contributors Guide. Reach out to info@openreferral.org to get directly in touch.

If I maintain a community resource directory — or if I partner with an organization that does — how would I get started?¶

You can start by testing the viability of our format for your context. That may entail mapping your database’s schema to the Human Services Data Specification.

Once you’ve mapped your schema to ours, analyze the gaps. (You can ask questions or submit suggestions for improvements to our schema in our Issues Queue.)

Then you can write a script to transform your data into this open format.

Finally, you can deploy the Ohana API, load your transformed data in (loading instructions here), and start building new tools that can help people in your community use this data in new ways.

If you have questions about how this might be useful in your community, please reach out to info@openreferral.org

Here are some examples of mapped schema: A comparative analysis of a resource directory from Evanston to an earlier version of HSDS. The humanitarian service data model (more about this project here). The DMV Maternal Mental Health resource guide. Here is an example of a script to transform and load data into Ohana, from Boston’s Helpsteps roject.

How are decisions made about the Open Referral specifications?¶

Our governance model is structured around three activities: 1) a semi-regular Assembly video call, open to all participants [see an archive of these videos here], 2) convenings of diverse stakeholders in Open Referral workshops [read the reportback here], and 3) ad hoc ‘workgroups’ consisting of leaders with a varied set of perspectives and experiences [see the workgroup archive here].

Of all the feedback received from many different contributors, we assign priority to the perspectives of the lead stakeholders of our pilot projects. This feedback is submitted to Open Referral’s deputized technical leads, who ultimately make decisions with documentation and established methods for future review.

[Open Referral’s initial governance model is described in more detail in this memo. You can also read more about the nature of this ‘polycentric’ approach to governance in Derek Coursen’s blog post here.]

What is the Human Services Data Specification (HSDS)?¶

AKA ‘the Open Referral format,’ the HSDS is a data interchange format that enables resource directory data to be published in bulk for use by many systems. HSDS provides a common vocabulary for information about services, the organizations that provide them, and the locations where they can be accessed. HSDS is essentially an interlingua — in other words, it’s a common language that can be used by anyone to enable community resource directories to ’talk’ to each other. [See the data specification in Github or on our Documentation Site.]

What is in the Human Services Data Specification (HSDS)?¶

First, HSDS identifies a vocabulary of terms that describe what a service is, the institution that provides it, where the service can be accessed, and how to access it. These terms are designated as ‘required,’ ‘recommended,’ and ‘optional.’ The spec provides instructions for formatting these terms, with examples.

On a more technical level, HSDS also includes a logical model that diagrams the relationships between these terms.

Finally, HSDS provides guidance for structuring and packaging data so that it can be published on the web and/or exchanged between systems. [See: Github or our documentation site.]

What is not in the Human Services Data Specification (HSDS)?¶

HSDS does not attempt to describe every type of information that might be relevant to people working with resource directory data. We have attempted to maintain a strict focus on specifying only relevant factual attributes that are shared by most services. That means we excluded many kinds of information that are unique to specific kinds of services (such as the accreditation of child care providers, or the availability of beds in a shelter).

HSDS also does not specify a taxonomy of types of services and types of personal attributes that determine eligibility for various types of services. Many such taxonomies already exist, so HSDS merely provides instructions for how to overlay a taxonomy of the user’s choosing. By default, information systems that use HSDS and/or the Ohana API can use the open source Open Eligibility taxonomy. (Expect future cycles of the Open Referral initiative to take on these issues more directly; however, for now we are merely looking to learn from the different ways in which various users address these common problems.)

Finally, HSDS does not specify any information regarding how referrals actually get made (i.e. setting appointments, following up, etc) or as to feedback regarding the quality of those services. These kinds of information are critically important, but inherently so variable and context-dependent that we don’t think it’s feasible or appropriate to specify them at this point in time.

That said, this model can and should be extended! Users can expand HSDS to meet their own needs, in their own systems. Groups of stakeholders from particular subdomains can develop extended ‘profiles’ that are tailored to their situation. (A group of civil legal service providers have already begun working on precisely that.) In future iterations of the Open Referral process, these expansions will then be considered for inclusion as part of the primary model.

What is the format of the HSDS? Why CSV?¶

With the goal of broad accessibility in mind, the initial HSDS developer Sophia Parafina chose Comma-Separated Values (CSV) as the building blocks for HSDS. CSV serves as a ‘lowest common denominator’ that is simplest to use and most accessible to users with a modicum of technical abilities, as it can be edited in a simple text editor, and ingested by almost any information system. (For more reasoning behind this decision, consider Waldo Jaquith’s recent post, ‘In Praise of CSV.’)

For version 1.0, Parafina chose to accompany a more-complex set of CSV files with a JSON datapackage (using the Open Knowledge Foundation’s frictionless data specification) to describe the CSVs’ contents.

Members of the Open Referral community have observed that they may need more structured data formats for use cases that involve complex, sensitive, and/or large-scale uses. We recognize the validity of these perspectives, and in fact we expect the HSDS model to evolve over time. Pilot projects and community members are already discussing plans to develop complementary formats (such as XML and JSON-LD) — and as these formats are field-tested and validated, they may become formal components of HSDS in future iterations.

How do you address the matter of taxonomy (of types of services and situations)?¶

Open Referral recognizes the existence of a diverse array of taxonomies to describe types of services, organizations, and people for whom services are available. Given that such categories are inherently subjective, whereas Open Referral’s format is describing only factual data, we do not prescribe a specific taxonomy. We do recognize the existence of an array of taxonomies currently in use, and our HSDS format includes specifications for including any taxonomy in open data.

What if I collect important information that isn’t included in the Human Service Data specification?¶

That’s ok! The Human Services Data Specification is an extensible format to which additional layers of information can be added. (But we’d like to learn from your experience, so please share these insights!)

What if the Human Service Data Specification requires kinds of information that I don’t collect?¶

The Open Referral format has been developed to require a pretty minimal set of information. If your resource directory doesn’t contain certain required elements, we may need to get creative. Ask in our Issues queue for clarification and context, and we’ll try to answer you promptly.

What if I need help collecting this data in the first place?¶

Open Referral is working to build tools to help produce and verify accurate resource directory data. If you’re interested in developing such tools — and/or if you already have experience with such tools — we want to hear from you! Please reach out to info@openreferral.org to discuss.

Who has adapted this project and can I see examples?¶

We have a network of projects around the United States, Canada, and beyond. See this network map here.

You can also see deployments of the Ohana API and compatible APIs here and here. Some groups have adapted our data specification to their context, such as the Human Services Data Model (in the field of Humanitarian Crisis Response).

Who do I contact if I need help with this project?¶

You can contact Greg Bloom (@greggish | bloom@openreferral.org), the chief organizing officer for Open Referral.

What languages is this project in?¶

Currently Open Referral is in English, though we have at least one Spanish deployment in Madrid :)

Oh, do you mean machine language? Our data specification calls for CSV files with a JSON datapackage. Our reference implementation, the Ohana API, is in Ruby.

If I wanted to help with this project, what is the best way to do that?¶

Get in touch with Greg at bloom@openreferral.org. You can also start by finding other people in your community who work with information systems that keep track of the health, human, and social services available to people in need.

You could also look through our Issues queue, comment away, and even offer Pull Requests to our documentation with your own documentation of why. It might be a while before we are able to address your issue directly, but your feedback is very welcome as it helps us set our agenda!

Is the project in active development?¶

The Human Services Data Specification is entering an upgrade phase of development, under the interim leadership of the Open Data Services Cooperative. Check out our issues queue.

We are seeking sponsorship to support long-term institutional development of Open Referral and our data specification. Please reach out to info@openreferral.org for more information.

What is the licensing on this project?¶

Human Services Data Specification v1.0 is now available as a CC BY-SA 4.0.

Credits¶

The Open Referral Initiative is led by Greg Bloom (@greggish). Its launch in 2014 was co-sponsored by Code for America, with funding from the Knight Foundation.

The Human Services Data Specification is developing under the technical leadership of the Open Data Services Cooperative (read more here).

The Human Services Data API is developing under the technical leaderhsip of @kinlane, the API Evangelist, with support from the Digital Impact program at Stanford’s Center for Philanthropy and Civil Society.

Open Referral’s Explainer Video was made possible by a small grant from the Shuttleworth Foundation.

Our work is made possible by a broad array of supporters and contributors. Thank you for all that you do!

About¶

Data Specifications¶

Our ecosystem¶

Get in touch¶

Site contents¶

Human Services Data Specification (HSDS)¶

About HSDS¶

HSDS Reference¶

Names and descriptions¶

Objects and fields¶

organization¶

program¶

service¶

service_attribute¶

other_attribute¶

service_at_location¶

location¶

phone¶

contact¶

physical_address¶

postal_address¶

schedule¶

funding¶

eligibility¶

service_area¶

required_document¶

payment_accepted¶

language¶

accessibility_for_disabilities¶

taxonomy_term¶

metadata¶

meta_table_description¶

Logical Model¶

ER Diagram¶

Variations & Interoperability¶

Tables-to-fields Transformation¶

Producing and Sharing Compliant Data¶

CSV Formatting¶

Telephone Formatting¶

Address Formatting¶

Description Field Formatting¶

Changelog¶

Use Cases¶

This page is non-normative, which means that it doesn’t form part of the standard; if there is any ambiguity, the standard takes precedence. This page may be updated at any time in response to community demand.¶

Schedules¶

Exceptional schedules¶

24h opening¶

Worked Example¶

This page is non-normative, which means that it doesn’t form part of the standard; if there is any ambiguity, the standard takes precedence. This page may be updated at any time in response to community demand.¶

Producing and Sharing Compliant Data¶

Guidance on Mapping Fields and Values¶

Files & Attributes Summary¶

This page is non-normative, which means that it doesn’t form part of the standard; if there is any ambiguity, the standard takes precedence. This page may be updated at any time in response to community demand.¶

Classifications, Attributes & Taxonomies¶

Scope of HSDS¶

Terminology¶

Vocabulary¶

Taxonomy¶

Embedded Taxonomy¶

External Taxonomy¶

Taxonomy Term¶

Attribute¶

Applying a taxonomy term to an object¶

Example¶

services¶

taxonomy_terms¶

programs¶

service_attributes¶

other_attributes¶

Identifiers¶

id fields¶

This page is non-normative, which means that it doesn’t form part of the standard; if there is any ambiguity, the standard takes precedence. This page may be updated at any time in response to community demand.¶

Extending HSDS¶

Patterns¶

Constrain¶

Extend¶

Constrain & Extend¶

Principles¶

Engaging the Community¶

Sharing Your Work¶