Human Services Data API (HSDA) v1.1

This is the OpenAPI definiton for the Human Services Data API (HSDA) v1.1. This is the core set of API resources for managing organizations, locations, and services. It is available as this HTML list or YAML OpenAPI definition, with an accompanying demo site, and link to current Github Issues for support.

Contacts
Get Contacts /contacts/ GET
Request Parameters:
query: A query to filter list by.
page: The particular page of results.
per_page: Amount of locations to return per page, up to 100.
Reponse Body:
id (string) Each contact must have a unique identifier.
organization_id (string) The identifier of the organization for which this is a contact.
service_id (string) The identifier of the service for which this is a contact.
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.
name (string) The name of the person.
title (string) The job title of the person.
department (string) The department that the person is part of.
email (string) The email address of the person.
Add Contact /contacts/ POST
Request Body:
id (string) Each contact must have a unique identifier.
organization_id (string) The identifier of the organization for which this is a contact.
service_id (string) The identifier of the service for which this is a contact.
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.
name (string) The name of the person.
title (string) The job title of the person.
department (string) The department that the person is part of.
email (string) The email address of the person.
Reponse Body:
id (string) Each contact must have a unique identifier.
organization_id (string) The identifier of the organization for which this is a contact.
service_id (string) The identifier of the service for which this is a contact.
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.
name (string) The name of the person.
title (string) The job title of the person.
department (string) The department that the person is part of.
email (string) The email address of the person.
Get Contact /contacts/{contact_id}/ GET
Path Parameters:
contact_id: The contact id.
Reponse Body:
id (string) Each contact must have a unique identifier.
organization_id (string) The identifier of the organization for which this is a contact.
service_id (string) The identifier of the service for which this is a contact.
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.
name (string) The name of the person.
title (string) The job title of the person.
department (string) The department that the person is part of.
email (string) The email address of the person.
Update Contact /contacts/{contact_id}/ PUT
Path Parameters:
contact_id: The contact id.
Request Body:
id (string) Each contact must have a unique identifier.
organization_id (string) The identifier of the organization for which this is a contact.
service_id (string) The identifier of the service for which this is a contact.
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.
name (string) The name of the person.
title (string) The job title of the person.
department (string) The department that the person is part of.
email (string) The email address of the person.
Reponse Body:
id (string) Each contact must have a unique identifier.
organization_id (string) The identifier of the organization for which this is a contact.
service_id (string) The identifier of the service for which this is a contact.
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.
name (string) The name of the person.
title (string) The job title of the person.
department (string) The department that the person is part of.
email (string) The email address of the person.
Delete Contact /contacts/{contact_id}/ DELETE
Path Parameters:
contact_id: The contact id.
Reponse Body:
id (string) Each contact must have a unique identifier.
organization_id (string) The identifier of the organization for which this is a contact.
service_id (string) The identifier of the service for which this is a contact.
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.
name (string) The name of the person.
title (string) The job title of the person.
department (string) The department that the person is part of.
email (string) The email address of the person.
Get Phones /contacts/{contact_id}/phones/ GET
Path Parameters:
contact_id: The unique contact id.
Reponse Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location where this phone number is located.
service_id (string) The identifier of the service for which this is the phone number.
organization_id (string) The identifier of the organisation for which this is the phone number.
contact_id (string) The identifier of the contact for which this is the phone number.
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.
number (string) The phone number.
extension (numbernull) The extension of the phone number.
type (string) Whether the phone number relates to a fixed or cellular phone.
department (string) The department for which this is the phone number.
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.
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.
Add Phone /contacts/{contact_id}/phones/ POST
Path Parameters:
contact_id: The unique contact id.
Request Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location where this phone number is located.
service_id (string) The identifier of the service for which this is the phone number.
organization_id (string) The identifier of the organisation for which this is the phone number.
contact_id (string) The identifier of the contact for which this is the phone number.
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.
number (string) The phone number.
extension (numbernull) The extension of the phone number.
type (string) Whether the phone number relates to a fixed or cellular phone.
department (string) The department for which this is the phone number.
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.
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.
Reponse Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location where this phone number is located.
service_id (string) The identifier of the service for which this is the phone number.
organization_id (string) The identifier of the organisation for which this is the phone number.
contact_id (string) The identifier of the contact for which this is the phone number.
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.
number (string) The phone number.
extension (numbernull) The extension of the phone number.
type (string) Whether the phone number relates to a fixed or cellular phone.
department (string) The department for which this is the phone number.
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.
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.
Get Phone /contacts/{contact_id}/phones/{phone_id}/ GET
Path Parameters:
contact_id: The unique contact id.
phone_id: The unique phone id.
Reponse Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location where this phone number is located.
service_id (string) The identifier of the service for which this is the phone number.
organization_id (string) The identifier of the organisation for which this is the phone number.
contact_id (string) The identifier of the contact for which this is the phone number.
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.
number (string) The phone number.
extension (numbernull) The extension of the phone number.
type (string) Whether the phone number relates to a fixed or cellular phone.
department (string) The department for which this is the phone number.
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.
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.
Update Phone /contacts/{contact_id}/phones/{phone_id}/ PUT
Path Parameters:
contact_id: The unique contact id.
phone_id: The unique phone id.
Request Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location where this phone number is located.
service_id (string) The identifier of the service for which this is the phone number.
organization_id (string) The identifier of the organisation for which this is the phone number.
contact_id (string) The identifier of the contact for which this is the phone number.
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.
number (string) The phone number.
extension (numbernull) The extension of the phone number.
type (string) Whether the phone number relates to a fixed or cellular phone.
department (string) The department for which this is the phone number.
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.
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.
Reponse Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location where this phone number is located.
service_id (string) The identifier of the service for which this is the phone number.
organization_id (string) The identifier of the organisation for which this is the phone number.
contact_id (string) The identifier of the contact for which this is the phone number.
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.
number (string) The phone number.
extension (numbernull) The extension of the phone number.
type (string) Whether the phone number relates to a fixed or cellular phone.
department (string) The department for which this is the phone number.
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.
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.
Delete Phone /contacts/{contact_id}/phones/{phone_id}/ DELETE
Path Parameters:
contact_id: The unique contact id.
phone_id: The unique phone id.
Reponse Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location where this phone number is located.
service_id (string) The identifier of the service for which this is the phone number.
organization_id (string) The identifier of the organisation for which this is the phone number.
contact_id (string) The identifier of the contact for which this is the phone number.
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.
number (string) The phone number.
extension (numbernull) The extension of the phone number.
type (string) Whether the phone number relates to a fixed or cellular phone.
department (string) The department for which this is the phone number.
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.
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.
Locations
Get Locations /locations/ GET
Request Parameters:
query: A query to filter result by.
page: The particular page of results.
per_page: Amount of locations to return per page, up to 100.
Reponse Body:
id (string) Each location must have a unique identifier.
organization_id (string) Each location must belong to a single organization. The identifier of the organization should be given here.
name (string) The name of the location.
alternate_name (string) An alternative name for the location.
description (string) A description of this location.
transportation (string) A description of the access to public or private transportation to and from the location.
latitude (numbernull) Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude (numbernull) X coordinate of location expressed in decimal degrees in WGS84 datum.
Add Location /locations/ POST
Request Body:
id (string) Each location must have a unique identifier.
organization_id (string) Each location must belong to a single organization. The identifier of the organization should be given here.
name (string) The name of the location.
alternate_name (string) An alternative name for the location.
description (string) A description of this location.
transportation (string) A description of the access to public or private transportation to and from the location.
latitude (numbernull) Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude (numbernull) X coordinate of location expressed in decimal degrees in WGS84 datum.
Reponse Body:
id (string) Each location must have a unique identifier.
organization_id (string) Each location must belong to a single organization. The identifier of the organization should be given here.
name (string) The name of the location.
alternate_name (string) An alternative name for the location.
description (string) A description of this location.
transportation (string) A description of the access to public or private transportation to and from the location.
latitude (numbernull) Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude (numbernull) X coordinate of location expressed in decimal degrees in WGS84 datum.
Get Location /locations/{location_id}/ GET
Path Parameters:
location_id: The location id.
Reponse Body:
id (string) Each location must have a unique identifier.
organization_id (string) Each location must belong to a single organization. The identifier of the organization should be given here.
name (string) The name of the location.
alternate_name (string) An alternative name for the location.
description (string) A description of this location.
transportation (string) A description of the access to public or private transportation to and from the location.
latitude (numbernull) Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude (numbernull) X coordinate of location expressed in decimal degrees in WGS84 datum.
Update Location /locations/{location_id}/ PUT
Path Parameters:
location_id: The unique location id.
Request Body:
id (string) Each location must have a unique identifier.
organization_id (string) Each location must belong to a single organization. The identifier of the organization should be given here.
name (string) The name of the location.
alternate_name (string) An alternative name for the location.
description (string) A description of this location.
transportation (string) A description of the access to public or private transportation to and from the location.
latitude (numbernull) Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude (numbernull) X coordinate of location expressed in decimal degrees in WGS84 datum.
Reponse Body:
id (string) Each location must have a unique identifier.
organization_id (string) Each location must belong to a single organization. The identifier of the organization should be given here.
name (string) The name of the location.
alternate_name (string) An alternative name for the location.
description (string) A description of this location.
transportation (string) A description of the access to public or private transportation to and from the location.
latitude (numbernull) Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude (numbernull) X coordinate of location expressed in decimal degrees in WGS84 datum.
Delete Location /locations/{location_id}/ DELETE
Path Parameters:
location_id: The location id.
Reponse Body:
id (string) Each location must have a unique identifier.
organization_id (string) Each location must belong to a single organization. The identifier of the organization should be given here.
name (string) The name of the location.
alternate_name (string) An alternative name for the location.
description (string) A description of this location.
transportation (string) A description of the access to public or private transportation to and from the location.
latitude (numbernull) Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude (numbernull) X coordinate of location expressed in decimal degrees in WGS84 datum.
Get Holiday Schedule /locations/{location_id}/holiday-schedule/ GET
Path Parameters:
location_id: The unique location id.
Reponse Body:
id (string) Each entry must have a unique identifier.
service_id (string) The identifier of the service for which this is the holiday schedule.
location_id (string) The identifier of the location for which this is the holiday schedule.
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.
closed (boolean) Indicates if a service or location is closed during a public holiday.
opens_at (string) 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.
closes_at (string) 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.
start_date (string) The first day that a service or location is closed during a public or private holiday.
end_date (string) The last day that a service or location is closed during a public or private holiday.
Add Holiday Schedule /locations/{location_id}/holiday-schedule/ POST
Path Parameters:
location_id: The unique location id.
Request Body:
id (string) Each entry must have a unique identifier.
service_id (string) The identifier of the service for which this is the holiday schedule.
location_id (string) The identifier of the location for which this is the holiday schedule.
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.
closed (boolean) Indicates if a service or location is closed during a public holiday.
opens_at (string) 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.
closes_at (string) 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.
start_date (string) The first day that a service or location is closed during a public or private holiday.
end_date (string) The last day that a service or location is closed during a public or private holiday.
Reponse Body:
id (string) Each entry must have a unique identifier.
service_id (string) The identifier of the service for which this is the holiday schedule.
location_id (string) The identifier of the location for which this is the holiday schedule.
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.
closed (boolean) Indicates if a service or location is closed during a public holiday.
opens_at (string) 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.
closes_at (string) 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.
start_date (string) The first day that a service or location is closed during a public or private holiday.
end_date (string) The last day that a service or location is closed during a public or private holiday.
Get Holiday Schedule /locations/{location_id}/holiday-schedule/{holiday_schedule_id}/ GET
Path Parameters:
location_id: The unique location id.
holiday_schedule_id: The unique holiday schedule id.
Reponse Body:
id (string) Each entry must have a unique identifier.
service_id (string) The identifier of the service for which this is the holiday schedule.
location_id (string) The identifier of the location for which this is the holiday schedule.
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.
closed (boolean) Indicates if a service or location is closed during a public holiday.
opens_at (string) 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.
closes_at (string) 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.
start_date (string) The first day that a service or location is closed during a public or private holiday.
end_date (string) The last day that a service or location is closed during a public or private holiday.
Update Holiday Schedule /locations/{location_id}/holiday-schedule/{holiday_schedule_id}/ PUT
Path Parameters:
location_id: The unique location id.
holiday_schedule_id: The unique holiday schedule id.
Request Body:
id (string) Each entry must have a unique identifier.
service_id (string) The identifier of the service for which this is the holiday schedule.
location_id (string) The identifier of the location for which this is the holiday schedule.
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.
closed (boolean) Indicates if a service or location is closed during a public holiday.
opens_at (string) 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.
closes_at (string) 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.
start_date (string) The first day that a service or location is closed during a public or private holiday.
end_date (string) The last day that a service or location is closed during a public or private holiday.
Reponse Body:
id (string) Each entry must have a unique identifier.
service_id (string) The identifier of the service for which this is the holiday schedule.
location_id (string) The identifier of the location for which this is the holiday schedule.
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.
closed (boolean) Indicates if a service or location is closed during a public holiday.
opens_at (string) 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.
closes_at (string) 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.
start_date (string) The first day that a service or location is closed during a public or private holiday.
end_date (string) The last day that a service or location is closed during a public or private holiday.
Delete Holiday Schedule /locations/{location_id}/holiday-schedule/{holiday_schedule_id}/ DELETE
Path Parameters:
location_id: The unique location id.
holiday_schedule_id: The unique holiday schdule id.
Reponse Body:
id (string) Each entry must have a unique identifier.
service_id (string) The identifier of the service for which this is the holiday schedule.
location_id (string) The identifier of the location for which this is the holiday schedule.
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.
closed (boolean) Indicates if a service or location is closed during a public holiday.
opens_at (string) 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.
closes_at (string) 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.
start_date (string) The first day that a service or location is closed during a public or private holiday.
end_date (string) The last day that a service or location is closed during a public or private holiday.
Get Languages /locations/{location_id}/languages/ GET
Path Parameters:
location_id: The unique location id.
Reponse Body:
id (string) Each language must have a unique identifier.
service_id (string) The identifier of the service for which the entry describes the languages in which services are delivered.
location_id (string) The identifier of the location for which the entry describes the languages in which services are delivered.
language (string) Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Add Languages /locations/{location_id}/languages/ POST
Path Parameters:
location_id: The unique location id.
Request Body:
id (string) Each language must have a unique identifier.
service_id (string) The identifier of the service for which the entry describes the languages in which services are delivered.
location_id (string) The identifier of the location for which the entry describes the languages in which services are delivered.
language (string) Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Reponse Body:
id (string) Each language must have a unique identifier.
service_id (string) The identifier of the service for which the entry describes the languages in which services are delivered.
location_id (string) The identifier of the location for which the entry describes the languages in which services are delivered.
language (string) Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Get Languages /locations/{location_id}/languages/{language_id}/ GET
Path Parameters:
location_id: The unique location id.
language_id: The unique language id.
Reponse Body:
id (string) Each language must have a unique identifier.
service_id (string) The identifier of the service for which the entry describes the languages in which services are delivered.
location_id (string) The identifier of the location for which the entry describes the languages in which services are delivered.
language (string) Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Update Languages /locations/{location_id}/languages/{language_id}/ PUT
Path Parameters:
location_id: The unique location id.
language_id: The unique language id.
Request Body:
id (string) Each language must have a unique identifier.
service_id (string) The identifier of the service for which the entry describes the languages in which services are delivered.
location_id (string) The identifier of the location for which the entry describes the languages in which services are delivered.
language (string) Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Reponse Body:
id (string) Each language must have a unique identifier.
service_id (string) The identifier of the service for which the entry describes the languages in which services are delivered.
location_id (string) The identifier of the location for which the entry describes the languages in which services are delivered.
language (string) Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Delete Languages /locations/{location_id}/languages/{language_id}/ DELETE
Path Parameters:
location_id: The unique location id.
language_id: The unique language id.
Reponse Body:
id (string) Each language must have a unique identifier.
service_id (string) The identifier of the service for which the entry describes the languages in which services are delivered.
location_id (string) The identifier of the location for which the entry describes the languages in which services are delivered.
language (string) Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Get Postal Addresses /locations/{location_id}/postal-address/ GET
Path Parameters:
location_id: The unique location id.
Reponse Body:
id (string) Each postal address must have a unique identifier.
location_id (string) The identifier of the location for which this is the postal address.
attention (string) The person or entity for whose attention mail should be marked.
address_1 (string) The first line of the address.
address_2 (string) The second line of the address.
address_3 (string) The third line of the address.
address_4 (string) The fourth line of the address.
city (string) The city in which the address is located.
region (string) The region in which the address is located (optional).
state_province (string) The state or province in which the address is located.
postal_code (string) The postal code for the address.
country (string) The country in which the address is located.
Add Postal Adress /locations/{location_id}/postal-address/ POST
Path Parameters:
location_id: The unique location id.
Request Body:
id (string) Each postal address must have a unique identifier.
location_id (string) The identifier of the location for which this is the postal address.
attention (string) The person or entity for whose attention mail should be marked.
address_1 (string) The first line of the address.
address_2 (string) The second line of the address.
address_3 (string) The third line of the address.
address_4 (string) The fourth line of the address.
city (string) The city in which the address is located.
region (string) The region in which the address is located (optional).
state_province (string) The state or province in which the address is located.
postal_code (string) The postal code for the address.
country (string) The country in which the address is located.
Reponse Body:
id (string) Each postal address must have a unique identifier.
location_id (string) The identifier of the location for which this is the postal address.
attention (string) The person or entity for whose attention mail should be marked.
address_1 (string) The first line of the address.
address_2 (string) The second line of the address.
address_3 (string) The third line of the address.
address_4 (string) The fourth line of the address.
city (string) The city in which the address is located.
region (string) The region in which the address is located (optional).
state_province (string) The state or province in which the address is located.
postal_code (string) The postal code for the address.
country (string) The country in which the address is located.
Get Postal Address /locations/{location_id}/postal-address/{postal_address_id}/ GET
Path Parameters:
location_id: The unique location id.
postal_address_id: The unique postal address id.
Reponse Body:
id (string) Each postal address must have a unique identifier.
location_id (string) The identifier of the location for which this is the postal address.
attention (string) The person or entity for whose attention mail should be marked.
address_1 (string) The first line of the address.
address_2 (string) The second line of the address.
address_3 (string) The third line of the address.
address_4 (string) The fourth line of the address.
city (string) The city in which the address is located.
region (string) The region in which the address is located (optional).
state_province (string) The state or province in which the address is located.
postal_code (string) The postal code for the address.
country (string) The country in which the address is located.
Update Postal Address /locations/{location_id}/postal-address/{postal_address_id}/ PUT
Path Parameters:
location_id: The unique location id.
postal_address_id: The unique postal address id.
Request Body:
id (string) Each postal address must have a unique identifier.
location_id (string) The identifier of the location for which this is the postal address.
attention (string) The person or entity for whose attention mail should be marked.
address_1 (string) The first line of the address.
address_2 (string) The second line of the address.
address_3 (string) The third line of the address.
address_4 (string) The fourth line of the address.
city (string) The city in which the address is located.
region (string) The region in which the address is located (optional).
state_province (string) The state or province in which the address is located.
postal_code (string) The postal code for the address.
country (string) The country in which the address is located.
Reponse Body:
id (string) Each postal address must have a unique identifier.
location_id (string) The identifier of the location for which this is the postal address.
attention (string) The person or entity for whose attention mail should be marked.
address_1 (string) The first line of the address.
address_2 (string) The second line of the address.
address_3 (string) The third line of the address.
address_4 (string) The fourth line of the address.
city (string) The city in which the address is located.
region (string) The region in which the address is located (optional).
state_province (string) The state or province in which the address is located.
postal_code (string) The postal code for the address.
country (string) The country in which the address is located.
Delete Postal Address /locations/{location_id}/postal-address/{postal_address_id}/ DELETE
Path Parameters:
location_id: The unique location id.
postal_address_id: The unique postal address id.
Reponse Body:
id (string) Each postal address must have a unique identifier.
location_id (string) The identifier of the location for which this is the postal address.
attention (string) The person or entity for whose attention mail should be marked.
address_1 (string) The first line of the address.
address_2 (string) The second line of the address.
address_3 (string) The third line of the address.
address_4 (string) The fourth line of the address.
city (string) The city in which the address is located.
region (string) The region in which the address is located (optional).
state_province (string) The state or province in which the address is located.
postal_code (string) The postal code for the address.
country (string) The country in which the address is located.
Get Physical Address /locations/{location_id}/physical-address/ GET
Path Parameters:
location_id: The unique location id.
Reponse Body:
id (string) Each postal address must have a unique identifier.
location_id (string) The identifier of the location for which this is the postal address.
attention (string) The person or entity for whose attention mail should be marked.
address_1 (string) The first line of the address.
address_2 (string) The second line of the address.
address_3 (string) The third line of the address.
address_4 (string) The fourth line of the address.
city (string) The city in which the address is located.
region (string) The region in which the address is located (optional).
state_province (string) The state or province in which the address is located.
postal_code (string) The postal code for the address.
country (string) The country in which the address is located.
Add Physical Adress /locations/{location_id}/physical-address/ POST
Path Parameters:
location_id: The unique location id.
Request Body:
id (string) Each postal address must have a unique identifier.
location_id (string) The identifier of the location for which this is the postal address.
attention (string) The person or entity for whose attention mail should be marked.
address_1 (string) The first line of the address.
address_2 (string) The second line of the address.
address_3 (string) The third line of the address.
address_4 (string) The fourth line of the address.
city (string) The city in which the address is located.
region (string) The region in which the address is located (optional).
state_province (string) The state or province in which the address is located.
postal_code (string) The postal code for the address.
country (string) The country in which the address is located.
Reponse Body:
id (string) Each postal address must have a unique identifier.
location_id (string) The identifier of the location for which this is the postal address.
attention (string) The person or entity for whose attention mail should be marked.
address_1 (string) The first line of the address.
address_2 (string) The second line of the address.
address_3 (string) The third line of the address.
address_4 (string) The fourth line of the address.
city (string) The city in which the address is located.
region (string) The region in which the address is located (optional).
state_province (string) The state or province in which the address is located.
postal_code (string) The postal code for the address.
country (string) The country in which the address is located.
Get Physical Address /locations/{location_id}/physical-address/{postal_address_id}/ GET
Path Parameters:
location_id: The unique location id.
postal_address_id: The unique postal address id.
Reponse Body:
id (string) Each postal address must have a unique identifier.
location_id (string) The identifier of the location for which this is the postal address.
attention (string) The person or entity for whose attention mail should be marked.
address_1 (string) The first line of the address.
address_2 (string) The second line of the address.
address_3 (string) The third line of the address.
address_4 (string) The fourth line of the address.
city (string) The city in which the address is located.
region (string) The region in which the address is located (optional).
state_province (string) The state or province in which the address is located.
postal_code (string) The postal code for the address.
country (string) The country in which the address is located.
Update Physical Address /locations/{location_id}/physical-address/{postal_address_id}/ PUT
Path Parameters:
location_id: The unique location id.
postal_address_id: The unique postal address id.
Request Body:
id (string) Each postal address must have a unique identifier.
location_id (string) The identifier of the location for which this is the postal address.
attention (string) The person or entity for whose attention mail should be marked.
address_1 (string) The first line of the address.
address_2 (string) The second line of the address.
address_3 (string) The third line of the address.
address_4 (string) The fourth line of the address.
city (string) The city in which the address is located.
region (string) The region in which the address is located (optional).
state_province (string) The state or province in which the address is located.
postal_code (string) The postal code for the address.
country (string) The country in which the address is located.
Reponse Body:
id (string) Each postal address must have a unique identifier.
location_id (string) The identifier of the location for which this is the postal address.
attention (string) The person or entity for whose attention mail should be marked.
address_1 (string) The first line of the address.
address_2 (string) The second line of the address.
address_3 (string) The third line of the address.
address_4 (string) The fourth line of the address.
city (string) The city in which the address is located.
region (string) The region in which the address is located (optional).
state_province (string) The state or province in which the address is located.
postal_code (string) The postal code for the address.
country (string) The country in which the address is located.
Delete Physical Address /locations/{location_id}/physical-address/{postal_address_id}/ DELETE
Path Parameters:
location_id: The unique location id.
postal_address_id: The unique postal address id.
Reponse Body:
id (string) Each postal address must have a unique identifier.
location_id (string) The identifier of the location for which this is the postal address.
attention (string) The person or entity for whose attention mail should be marked.
address_1 (string) The first line of the address.
address_2 (string) The second line of the address.
address_3 (string) The third line of the address.
address_4 (string) The fourth line of the address.
city (string) The city in which the address is located.
region (string) The region in which the address is located (optional).
state_province (string) The state or province in which the address is located.
postal_code (string) The postal code for the address.
country (string) The country in which the address is located.
Get Phones /locations/{location_id}/phones/ GET
Path Parameters:
location_id: The unique location id.
Reponse Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location where this phone number is located.
service_id (string) The identifier of the service for which this is the phone number.
organization_id (string) The identifier of the organisation for which this is the phone number.
contact_id (string) The identifier of the contact for which this is the phone number.
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.
number (string) The phone number.
extension (numbernull) The extension of the phone number.
type (string) Whether the phone number relates to a fixed or cellular phone.
department (string) The department for which this is the phone number.
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.
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.
Add Phone /locations/{location_id}/phones/ POST
Path Parameters:
location_id: The unique location id.
Request Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location where this phone number is located.
service_id (string) The identifier of the service for which this is the phone number.
organization_id (string) The identifier of the organisation for which this is the phone number.
contact_id (string) The identifier of the contact for which this is the phone number.
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.
number (string) The phone number.
extension (numbernull) The extension of the phone number.
type (string) Whether the phone number relates to a fixed or cellular phone.
department (string) The department for which this is the phone number.
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.
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.
Reponse Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location where this phone number is located.
service_id (string) The identifier of the service for which this is the phone number.
organization_id (string) The identifier of the organisation for which this is the phone number.
contact_id (string) The identifier of the contact for which this is the phone number.
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.
number (string) The phone number.
extension (numbernull) The extension of the phone number.
type (string) Whether the phone number relates to a fixed or cellular phone.
department (string) The department for which this is the phone number.
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.
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.
Get Phone /locations/{location_id}/phones/{phone_id}/ GET
Path Parameters:
location_id: The unique location id.
phone_id: The unique phone id.
Reponse Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location where this phone number is located.
service_id (string) The identifier of the service for which this is the phone number.
organization_id (string) The identifier of the organisation for which this is the phone number.
contact_id (string) The identifier of the contact for which this is the phone number.
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.
number (string) The phone number.
extension (numbernull) The extension of the phone number.
type (string) Whether the phone number relates to a fixed or cellular phone.
department (string) The department for which this is the phone number.
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.
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.
Update Phone /locations/{location_id}/phones/{phone_id}/ PUT
Path Parameters:
location_id: The unique location id.
phone_id: The unique phone id.
Request Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location where this phone number is located.
service_id (string) The identifier of the service for which this is the phone number.
organization_id (string) The identifier of the organisation for which this is the phone number.
contact_id (string) The identifier of the contact for which this is the phone number.
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.
number (string) The phone number.
extension (numbernull) The extension of the phone number.
type (string) Whether the phone number relates to a fixed or cellular phone.
department (string) The department for which this is the phone number.
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.
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.
Reponse Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location where this phone number is located.
service_id (string) The identifier of the service for which this is the phone number.
organization_id (string) The identifier of the organisation for which this is the phone number.
contact_id (string) The identifier of the contact for which this is the phone number.
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.
number (string) The phone number.
extension (numbernull) The extension of the phone number.
type (string) Whether the phone number relates to a fixed or cellular phone.
department (string) The department for which this is the phone number.
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.
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.
Delete Phone /locations/{location_id}/phones/{phone_id}/ DELETE
Path Parameters:
location_id: The unique location id.
phone_id: The unique phone id.
Reponse Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location where this phone number is located.
service_id (string) The identifier of the service for which this is the phone number.
organization_id (string) The identifier of the organisation for which this is the phone number.
contact_id (string) The identifier of the contact for which this is the phone number.
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.
number (string) The phone number.
extension (numbernull) The extension of the phone number.
type (string) Whether the phone number relates to a fixed or cellular phone.
department (string) The department for which this is the phone number.
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.
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.
Get Regular Schedules /locations/{location_id}/regular-schedule/ GET
Path Parameters:
location_id: The unique location id.
Reponse Body:
id (string) Each entry must have a unique identifier.
service_id (string) The identifier of the service for which this is the regular schedule.
location_id (string) The identifier of the location for which this is the regular schedule.
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.
weekday (integer) The day of the week that this entry relates to.
opens_at (string) 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.
closes_at (string) 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.
Add Regular Schedule /locations/{location_id}/regular-schedule/ POST
Path Parameters:
location_id: The unique location id.
Request Body:
id (string) Each entry must have a unique identifier.
service_id (string) The identifier of the service for which this is the regular schedule.
location_id (string) The identifier of the location for which this is the regular schedule.
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.
weekday (integer) The day of the week that this entry relates to.
opens_at (string) 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.
closes_at (string) 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.
Reponse Body:
id (string) Each entry must have a unique identifier.
service_id (string) The identifier of the service for which this is the regular schedule.
location_id (string) The identifier of the location for which this is the regular schedule.
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.
weekday (integer) The day of the week that this entry relates to.
opens_at (string) 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.
closes_at (string) 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.
Get Regular Schedule /locations/{location_id}/regular-schedule/{regular_schedule_id}/ GET
Path Parameters:
location_id: The unique location id.
regular_schedule_id: The unique regular schedule id.
Reponse Body:
id (string) Each entry must have a unique identifier.
service_id (string) The identifier of the service for which this is the regular schedule.
location_id (string) The identifier of the location for which this is the regular schedule.
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.
weekday (integer) The day of the week that this entry relates to.
opens_at (string) 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.
closes_at (string) 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.
Update Regular Schedule /locations/{location_id}/regular-schedule/{regular_schedule_id}/ PUT
Path Parameters:
location_id: The unique location id.
regular_schedule_id: The unique regular schedule id.
Request Body:
id (string) Each entry must have a unique identifier.
service_id (string) The identifier of the service for which this is the regular schedule.
location_id (string) The identifier of the location for which this is the regular schedule.
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.
weekday (integer) The day of the week that this entry relates to.
opens_at (string) 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.
closes_at (string) 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.
Reponse Body:
id (string) Each entry must have a unique identifier.
service_id (string) The identifier of the service for which this is the regular schedule.
location_id (string) The identifier of the location for which this is the regular schedule.
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.
weekday (integer) The day of the week that this entry relates to.
opens_at (string) 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.
closes_at (string) 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.
Delete Regular Schedule /locations/{location_id}/regular-schedule/{regular_schedule_id}/ DELETE
Path Parameters:
location_id: The unique location id.
regular_schedule_id: The unique regular schedule id.
Reponse Body:
id (string) Each entry must have a unique identifier.
service_id (string) The identifier of the service for which this is the regular schedule.
location_id (string) The identifier of the location for which this is the regular schedule.
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.
weekday (integer) The day of the week that this entry relates to.
opens_at (string) 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.
closes_at (string) 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.
Get Services /locations/{location_id}/services/ GET
Path Parameters:
location_id: The unique location id.
Reponse Body:
id (string) Each service must have a unique identifier.
organization_id (string) The identifier of the organization that provides this service.
program_id (string) The identifier of the program this service is delivered under.
name (string) The official or public name of the service.
alternate_name (string) Alternative or commonly used name for a service.
description (string) A description of the service.
url (string) URL of the service.
email (string) Email address for the service.
status (string) The current status of the service.
interpretation_services (string) A description of any interpretation services available for accessing this service.
application_process (string) The steps needed to access the service.
wait_time (string) Time a client may expect to wait before receiving a service.
fees (string) Details of any charges for service users to access this service.
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.
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.
Add Service /locations/{location_id}/services/ POST
Path Parameters:
location_id: The unique location id.
Request Body:
id (string) Each service must have a unique identifier.
organization_id (string) The identifier of the organization that provides this service.
program_id (string) The identifier of the program this service is delivered under.
name (string) The official or public name of the service.
alternate_name (string) Alternative or commonly used name for a service.
description (string) A description of the service.
url (string) URL of the service.
email (string) Email address for the service.
status (string) The current status of the service.
interpretation_services (string) A description of any interpretation services available for accessing this service.
application_process (string) The steps needed to access the service.
wait_time (string) Time a client may expect to wait before receiving a service.
fees (string) Details of any charges for service users to access this service.
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.
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.
Reponse Body:
id (string) Each service must have a unique identifier.
organization_id (string) The identifier of the organization that provides this service.
program_id (string) The identifier of the program this service is delivered under.
name (string) The official or public name of the service.
alternate_name (string) Alternative or commonly used name for a service.
description (string) A description of the service.
url (string) URL of the service.
email (string) Email address for the service.
status (string) The current status of the service.
interpretation_services (string) A description of any interpretation services available for accessing this service.
application_process (string) The steps needed to access the service.
wait_time (string) Time a client may expect to wait before receiving a service.
fees (string) Details of any charges for service users to access this service.
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.
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.
Get Service /locations/{location_id}/services/{service_id}/ GET
Path Parameters:
location_id: The unique location id.
service_id: The unique service id.
Reponse Body:
id (string) Each service must have a unique identifier.
organization_id (string) The identifier of the organization that provides this service.
program_id (string) The identifier of the program this service is delivered under.
name (string) The official or public name of the service.
alternate_name (string) Alternative or commonly used name for a service.
description (string) A description of the service.
url (string) URL of the service.
email (string) Email address for the service.
status (string) The current status of the service.
interpretation_services (string) A description of any interpretation services available for accessing this service.
application_process (string) The steps needed to access the service.
wait_time (string) Time a client may expect to wait before receiving a service.
fees (string) Details of any charges for service users to access this service.
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.
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.
Update Service /locations/{location_id}/services/{service_id}/ PUT
Path Parameters:
location_id: The unique location id.
service_id: The unique service id.
Request Body:
id (string) Each service must have a unique identifier.
organization_id (string) The identifier of the organization that provides this service.
program_id (string) The identifier of the program this service is delivered under.
name (string) The official or public name of the service.
alternate_name (string) Alternative or commonly used name for a service.
description (string) A description of the service.
url (string) URL of the service.
email (string) Email address for the service.
status (string) The current status of the service.
interpretation_services (string) A description of any interpretation services available for accessing this service.
application_process (string) The steps needed to access the service.
wait_time (string) Time a client may expect to wait before receiving a service.
fees (string) Details of any charges for service users to access this service.
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.
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.
Reponse Body:
id (string) Each service must have a unique identifier.
organization_id (string) The identifier of the organization that provides this service.
program_id (string) The identifier of the program this service is delivered under.
name (string) The official or public name of the service.
alternate_name (string) Alternative or commonly used name for a service.
description (string) A description of the service.
url (string) URL of the service.
email (string) Email address for the service.
status (string) The current status of the service.
interpretation_services (string) A description of any interpretation services available for accessing this service.
application_process (string) The steps needed to access the service.
wait_time (string) Time a client may expect to wait before receiving a service.
fees (string) Details of any charges for service users to access this service.
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.
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.
Delete Service /locations/{location_id}/services/{service_id}/ DELETE
Path Parameters:
location_id: The unique location id.
service_id: The unique service id.
Reponse Body:
id (string) Each service must have a unique identifier.
organization_id (string) The identifier of the organization that provides this service.
program_id (string) The identifier of the program this service is delivered under.
name (string) The official or public name of the service.
alternate_name (string) Alternative or commonly used name for a service.
description (string) A description of the service.
url (string) URL of the service.
email (string) Email address for the service.
status (string) The current status of the service.
interpretation_services (string) A description of any interpretation services available for accessing this service.
application_process (string) The steps needed to access the service.
wait_time (string) Time a client may expect to wait before receiving a service.
fees (string) Details of any charges for service users to access this service.
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.
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.
Get Accessibility For Disabilities /locations/{location_id}/accessibility/ GET
Path Parameters:
location_id: The unique location id.
Reponse Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location for which the entry describes the accessibility provision.
accessibility (string) Description of assistance or infrastructure that facilitate access to clients with disabilities.
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.
Add Accessibility For Disabilities /locations/{location_id}/accessibility/ POST
Path Parameters:
location_id: The unique location id.
Request Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location for which the entry describes the accessibility provision.
accessibility (string) Description of assistance or infrastructure that facilitate access to clients with disabilities.
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.
Reponse Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location for which the entry describes the accessibility provision.
accessibility (string) Description of assistance or infrastructure that facilitate access to clients with disabilities.
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.
Get Accessibility For Disabilities /locations/{location_id}/accessibility/{accessibility_id}/ GET
Path Parameters:
location_id: The unique location id.
accessibility_id: The unique accessibility for disabilities id.
Reponse Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location for which the entry describes the accessibility provision.
accessibility (string) Description of assistance or infrastructure that facilitate access to clients with disabilities.
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.
Update Accessibility For Disabilities /locations/{location_id}/accessibility/{accessibility_id}/ PUT
Path Parameters:
location_id: The unique location id.
accessibility_id: The unique accessibility for disabilities id.
Request Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location for which the entry describes the accessibility provision.
accessibility (string) Description of assistance or infrastructure that facilitate access to clients with disabilities.
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.
Reponse Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location for which the entry describes the accessibility provision.
accessibility (string) Description of assistance or infrastructure that facilitate access to clients with disabilities.
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.
Delete Accessibility For Disabilities /locations/{location_id}/accessibility/{accessibility_id}/ DELETE
Path Parameters:
location_id: The unique location id.
accessibility_id: The unique accessibility for disabilities id.
Reponse Body:
id (string) Each entry must have a unique identifier.
location_id (string) The identifier of the location for which the entry describes the accessibility provision.
accessibility (string) Description of assistance or infrastructure that facilitate access to clients with disabilities.
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.
Organizations
Get Organizations /organizations/ GET
Request Parameters:
query: A query to filter result by.
page: The particular page of results.
per_page: Amount of locations to return per page, up to 100.
Reponse Body:
id (string) Each organization must have a unique identifier.
name (string) The official or public name of the organization.
alternate_name (string) Alternative or commonly used name for the organization.
description (string) A brief summary about the organization. It can contain markup such as HTML or Markdown.
email (string) The contact e-mail address for the organization.
url (string) The URL (website address) of the organization.
tax_status (string) Government assigned tax designation for for tax-exempt organizations.
tax_id (string) A government issued identifier used for the purpose of tax administration.
year_incorporated (string) The year in which the organization was legally formed.
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.
Add organization /organizations/ POST
Request Body:
id (string) Each organization must have a unique identifier.
name (string) The official or public name of the organization.
alternate_name (string) Alternative or commonly used name for the organization.
description (string) A brief summary about the organization. It can contain markup such as HTML or Markdown.
email (string) The contact e-mail address for the organization.
url (string) The URL (website address) of the organization.
tax_status (string) Government assigned tax designation for for tax-exempt organizations.
tax_id (string) A government issued identifier used for the purpose of tax administration.
year_incorporated (string) The year in which the organization was legally formed.
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.
Reponse Body:
id (string) Each organization must have a unique identifier.
name (string) The official or public name of the organization.
alternate_name (string) Alternative or commonly used name for the organization.
description (string) A brief summary about the organization. It can contain markup such as HTML or Markdown.
email (string) The contact e-mail address for the organization.
url (string) The URL (website address) of the organization.
tax_status (string) Government assigned tax designation for for tax-exempt organizations.
tax_id (string) A government issued identifier used for the purpose of tax administration.
year_incorporated (string) The year in which the organization was legally formed.
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.
Get Organization /organizations/{organization_id}/ GET
Path Parameters:
organization_id: The organization id.
Reponse Body:
id (string) Each organization must have a unique identifier.
name (string) The official or public name of the organization.
alternate_name (string) Alternative or commonly used name for the organization.
description (string) A brief summary about the organization. It can contain markup such as HTML or Markdown.
email (string) The contact e-mail address for the organization.
url (string) The URL (website address) of the organization.
tax_status (string) Government assigned tax designation for for tax-exempt organizations.
tax_id (string) A government issued identifier used for the purpose of tax administration.
year_incorporated (string) The year in which the organization was legally formed.
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.
Update Organization /organizations/{organization_id}/ PUT
Path Parameters:
organization_id: The unique organization id.
Request Body:
id (string) Each organization must have a unique identifier.
name (string) The official or public name of the organization.
alternate_name (string) Alternative or commonly used name for the organization.
description (string) A brief summary about the organization. It can contain markup such as HTML or Markdown.
email (string) The contact e-mail address for the organization.
url (string) The URL (website address) of the organization.
tax_status (string) Government assigned tax designation for for tax-exempt organizations.
tax_id (string) A government issued identifier used for the purpose of tax administration.
year_incorporated (string) The year in which the organization was legally formed.
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.
Reponse Body:
id (string) Each organization must have a unique identifier.
name (string) The official or public name of the organization.
alternate_name (string) Alternative or commonly used name for the organization.
description (string) A brief summary about the organization. It can contain markup such as HTML or Markdown.
email (string) The contact e-mail address for the organization.
url (string) The URL (website address) of the organization.
tax_status (string) Government assigned tax designation for for tax-exempt organizations.
tax_id (string) A government issued identifier used for the purpose of tax administration.
year_incorporated (string) The year in which the organization was legally formed.
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.
Delete Organization /organizations/{organization_id}/ DELETE
Path Parameters:
organization_id: The organization id.
Reponse Body:
id (string) Each organization must have a unique identifier.
name (string) The official or public name of the organization.
alternate_name (string) Alternative or commonly used name for the organization.
description (string) A brief summary about the organization. It can contain markup such as HTML or Markdown.
email (string) The contact e-mail address for the organization.
url (string) The URL (website address) of the organization.
tax_status (string) Government assigned tax designation for for tax-exempt organizations.
tax_id (string) A government issued identifier used for the purpose of tax administration.
year_incorporated (string) The year in which the organization was legally formed.
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.
Get Contacts /organizations/{organization_id}/contacts/ GET
Path Parameters:
organization_id: The unique organization id.
Reponse Body:
id (string) Each contact must have a unique identifier.
organization_id (string) The identifier of the organization for which this is a contact.
service_id (string) The identifier of the service for which this is a contact.
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.
name (string) The name of the person.
title (string) The job title of the person.
department (string) The department that the person is part of.
email (string) The email address of the person.
Add Contact /organizations/{organization_id}/contacts/ POST
Path Parameters:
organization_id: The unique organization id.
Request Body:
id (string) Each contact must have a unique identifier.
organization_id (string) The identifier of the organization for which this is a contact.
service_id (string) The identifier of the service for which this is a contact.
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.
name (string) The name of the person.
title (string) The job title of the person.
department (string) The department that the person is part of.
email (string) The email address of the person.
Reponse Body:
id (string) Each contact must have a unique identifier.
organization_id (string) The identifier of the organization for which this is a contact.
service_id (string) The identifier of the service for which this is a contact.
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.
name (string) The name of the person.
title (string) The job title of the person.
department (string) The department that the person is part of.
email (string) The email address of the person.
Get Contact /organizations/{organization_id}/contacts/{contact_id}/ GET
Path Parameters:
organization_id: The unique organization id.
contact_id: The unique contact id.
Reponse Body:
id (string) Each contact must have a unique identifier.
organization_id (string) The identifier of the organization for which this is a contact.
service_id (string) The identifier of the service for which this is a contact.