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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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