Schema Reference

Objects and fields

attribute

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier of the attribute entry. Each attribute entry should have a unique identifier.

link_id

string

uuid

Link Identifier

The identifier of the entity to which this taxonomy term applies.

taxonomy_term_id

string

uuid

Taxonomy Term Identifier

The identifier of this taxonomy term from the taxonomy table.

link_type

string

Link Type

A code taken from an enumerated open codelist to indicate what the taxonomy term describes, e.g. the service eligibility or intended audience.

taxonomy_term

object

Taxonomy Term

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

See taxonomy_term.json

accessibility

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier for this accessibility information. Each entry must have a unique identifier.

location_id

string

uuid

Location Identifier

The identifier for the location of the accessibility provision.

description

string

Description

A free text description of the assistance or infrastructure that facilitates access to clients with disabilities.

details

string

Details

Any further details relating to the relevant accessibility arrangements at this location.

url

string

uri

URL

The URL of a page giving more information about the accessibility of the location.

attributes

array[object]

Attributes

A link between a service and one or more classifications that describe the nature of the service provided.

See attribute.json

accessibility

string

Accessibility

Description of assistance or infrastructure that facilitate access to clients with disabilities.

schedule

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier for the schedule. Each entry must have a unique identifier.

service_id

string

uuid

Service Identifier

The identifier of the service for which this is the regular schedule

service_at_location_id

string

uuid

Service At Location Identifier

The identifier of the ‘service at location’ table entry, when this schedule is specific to a service in a particular location.

valid_from

string

Valid From

The date from which the schedule information is valid. It must be in the ISO 8601 format of YYYY-MM-DD,

valid_to

string

Valid To

The last date on which the schedule information is valid. It must be in the ISO 8601 format of YYYY-MM-DD.

dtstart

string

Date Start

iCal - The date of the first event is the schedule. Necessary when using the ‘interval’ feature, optional otherwise.

freq

string

Frequency

iCal - How often the frequency repeats.

interval

number

Interval

iCal - How often the frequency repeats. For example, and Interval of 2 for a WEEKLY Frequency would represent fortnightly.

byday

string

By Day

iCal - Comma separated days of the week. Where freq is MONTHLY each part can be preceded by a positive or negative integer to represent which occurrence in a month; e.g. 2MO is the second Monday in a month. -1FR is the last Friday

bymonthday

string

By Month Day

iCal - Comma separated numeric days of the month, where frequency is MONTHLY. Can be negative to represent days before the end of the month; e.g. -5 is the 5th to last day in a month.

description

string

Description

A free text description of the availability of the service.

opens_at

string

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 EST.)

closes_at

string

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 EST.).

schedule_link

string

uri

Schedule Link

URL of a link for the schedule which may show each individual session and may provide a booking facility.

attending_type

string

Attending Type

A free text description of how to attend this service.

notes

string

Notes

Free text notes on the schedule.

funding

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier for the funding. Each entry must have a unique identifier.

service_id

string

uuid

Service Identifier

The identifier of the service in receipt of this funding.

source

string

Source

A free text description of the source of funds for this organization or service.

service_at_location

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier of the service at location entry. Each entry must have a unique identifier.

service_id

string

uuid

Service Identifier

The identifier of the service at a given location.

location_id

string

uuid

Location Identifier

The identifier of the location where this service operates.

location

object

Location

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

See location.json

location

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier of the location. Each location must have a unique identifier.

name

string

Name

The name of the location.

description

string

Description

A free text description of the location.

latitude

number

Latitude

The latitude of the location expressed in decimal degrees in WGS84 datum.

longitude

number

Longitude

The longitude of the location expressed in decimal degrees in WGS84 datum.

external_identifier

string

External Identifier

A third party identifier for the location, which can be drawn from other services e.g. UK UPRN.

external_identifier_type

string

External Identifier Type

The scheme used for the location’s external_identifier e.g. UK UPRN.

addresses

array[object]

Addresses

The addresses of locations where organizations operate.

See address.json

accessibility

array[object]

Accessibility

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

See accessibility.json

attributes

array[object]

Attributes

A link between a service and one or more classifications that describe the nature of the service provided.

See attribute.json

service

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier for the service. Each service must have a unique identifier.

organization_id

string

uuid

Organization Identifier

The identifier of the organization that provides this service.

name

string

Required

Name

The official or public name of the service.

description

string

Description

A free text description of the service.

url

string

uri

URL

URL of the service

email

string

email

Email

An email address which can be used to contact the service provider.

status

string

Required

Status

The current status of the service which can be active, inactive, defunct, or temporarily closed.

fees

string

Fees

DEPRECATED: Details of any charges for service users to access this service.

accreditations

string

Accreditations

A free text description of any accreditations. Accreditation is the formal evaluation of an organization or program against best practice standards set by an accrediting organization.

minimum_age

number

Minimum Age

The minimum age of a person required to meet this eligibility requirement.

maximum_age

number

Maximum Age

The maximum age of a person required to meet this eligibility requirement.

assured_date

string

Assured Date

The date that the information about the service was last checked.

assurer_email

string

email

Assurer Email

The contact e-mail address for the person or organization which last assured the service.

alert

string

Alert

A description of any short term alerts concerning the service.

last_modified

string

date-time

Last Modified

The datetime when the service, or any related information about the service, has changed. Should have millisecond accuracy.

schedules

array[object]

Schedules

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

See schedule.json

service_areas

array[object]

Service Areas

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

See service_area.json

service_at_locations

array[object]

Service At Locations

A link between a service and a specific location.

See service_at_location.json

languages

array[object]

Languages

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

See language.json

organization

object

Organization

The details about each organization delivering services. Each service should be linked to the organization responsible for its delivery. One organization may deliver many services.

See organization.json

funding

array[object]

Funding

The sources of funding for a service or organization.

See funding.json

cost_options

array[object]

Cost Options

The costs of a service at certain points in time. This is an LGA Extension table. This table provides a structured version of the text information contained in the ‘fees’ field of the ‘service’ table.

See cost_option.json

contacts

array[object]

Contacts

The details of the named contacts for services and organizations.

See contact.json

attributes

array[object]

Attributes

A link between a service and one or more classifications that describe the nature of the service provided.

See attribute.json

service_area

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier for the service area. Each service area must have a unique identifier.

service_id

string

uuid

Service Identifier

The identifier of the service for which this entry describes the service area

name

string

Name

A free text geographic area where a service is available.

extent

string

Extent

A definition of the polygon defining the area.

extent_type

string

Extent Type

The format of the extent field populated from an enum of “geojson”, “topojson”, “kml”,and (for legacy systems or early state during transformation) “text”.

uri

string

URI

A URI which acts as a persistent identifier to identify an area.

service_area

string

Service Area

A free text geographic area where a service is available.

taxonomy

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier of the taxonomy. Each entry must have a unique identifier

name

string

Required

Name

The name of the taxonomy from which terms are sourced.

description

string

Required

Description

A free text description of the taxonomy.

uri

string

uri

URI

The URI of the taxonomy.

version

string

Version

The version of the taxonomy.

taxonomy_terms

array[object]

Taxonomy Terms

A link between a taxonomy and one or more taxonomy terms.

See taxonomy_term.json

contact

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier for the contact. Each contact must have a unique identifier.

service_id

string

uuid

Service Identifier

The identifier of the service for which this is a contact.

name

string

Name

The name of the contact.

title

string

Title

The job title of the contact.

attributes

array[object]

Attributes

A link between a service and one or more classifications that describe the nature of the service provided.

See attribute.json

cost_option

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier for the cost option. Each entry must have a unique identifier

service_id

string

uuid

Service Identifier

The identifier of the services for which the entry describes the cost.

valid_from

string

Valid From

The date when this price is valid from.

valid_to

string

Valid To

The date when this price is valid to.

option

string

Option

Conditions associated with the cost option.

amount

number

Amount

The cost of the option, expressed as an amount.

amount_description

string

Amount Description

Specific details qualifying the cost amount.

taxonomy_term

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier for this taxonomy term. Each taxonomy term must have a unique identifier, within the scope of the dataset.

parent_id

string

uuid

Parent Identifier

If this is a child term in a hierarchical taxonomy, give the identifier of the parent category. For top-level categories, this is not required.

taxonomy

string

Taxonomy

If this is an established taxonomy, a free text description of which taxonomy is in use. If possible, provide a URI.

taxonomy_id

string

uuid

Taxonomy Identifier

The identifier of the taxonomy containing the term.

term_uri

string

uri

Term URI

URI of the term.

term

string

Term

The taxonomy term itself.

address

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier of the postal address. Each postal address must have a unique identifier.

location_id

string

uuid

Location Identifier

The identifier of the location for this postal address.

attention

string

Attention

The name of the person or entity whose attention should be sought at the location. These are often included as a “care of” component of an address.

address_1

string

Required

Address line 1

The first line(s) of the address, including office, building number and street.

city

string

Required

City

The city in which the address is located.

region

string

Region

The region in which the address is located (optional).

state_province

string

Required

State Or Province

The state or province in which the address is located.

postal_code

string

Required

Postal Code

The postal code for the address.

country

string

Required

Country

The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation).

address_type

string

Required

Address Type

The type of address which may be physical, postal, or virtual.

attributes

array[object]

Attributes

A link between a service and one or more classifications that describe the nature of the service provided.

See attribute.json

organization

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier for the organization. Each organization must have a unique identifier.

name

string

Required

Name

The official or public name of the organization.

description

string

Required

Description

A free text description containing a brief summary about the organization. It can contain markup such as HTML or Markdown.

email

string

email

Email

The contact e-mail address for the organization.

website

string

uri

Website

The URL (website address) of the organization.

string

Logo

A URL to an image associated with the organization which can be presented alongside its name.

uri

string

uri

URI

A persistent identifier to uniquely identify the organization such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the website field of the Organization.

parent_organization_id

string

uuid

Parent Organization Identifier

The identifier of the organization’s parent organization.

organization_identifiers

array[object]

Organization Identifiers

The details of the third party identifiers for organizations, such as: company registration number, charity number, tax registration number.

See organization_identifier.json

attributes

array[object]

Attributes

A link between a service and one or more classifications that describe the nature of the service provided.

See attribute.json

organization_identifier

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier for this organization identifier entry. Each entry must have a unique identifier.

organization_id

string

uuid

Organization Identifier

The identifier of the organization. This should match the uuid of an organization object.

identifier_scheme

string

Identifier Scheme

The scheme of the third party identifier, according to http://org-id.guide/.

identifier_type

string

Required

Identifier Type

A human-readable equivalent of the identifier_scheme. This may be used in cases where org-id.guide does not list an appropriate identifier scheme.

identifier

string

Required

Third Party Identifier

The third-party identifier value.

attributes

array[object]

Attributes

A link between a service and one or more classifications that describe the nature of the service provided.

See attribute.json

language

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier for the language. Each entry must have a unique identifier.

service_id

string

uuid

Service Identifier

The identifier of the service for which the entry describes the languages in which services are delivered.

phone_id

string

uuid

Phone Identifier

The identifier of the phone for which the entry describes the languages in which services delivered.

phone

Title

Description

Type

Format

Required

id

string

uuid

Required

Identifier

The identifier for the phone number. Each entry must have a unique identifier.

contact_id

string

uuid

Contact Identifier

The identifier of the contact for which this is the phone number.

number

string

Required

Number

The phone number.

description

string

Description

A free text description providing extra information about the phone service

languages

array[object]

Languages

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

See language.json