HSDA Bulk

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

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

You can also explore this using our OpenAPI viewer.

Warning

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

POST /contacts/

Submit Bulk Contact

Submit Bulk Contact

Status Codes

200 Response Body:

Description

Type

Required

id

Each contact must have a unique identifier.

string

True

organization_id

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

string

False

service_id

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

string

False

service_at_location_id

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

string

False

name

The name of the person.

string

False

title

The job title of the person.

string

False

department

The department that the person is part of.

string

False

email

The email address of the person.

string

False

phones/0/id

Each entry must have a unique identifier.

string

True

phones/0/location_id

The identifier of the location where this phone number is located.

string

False

phones/0/service_id

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

string

False

phones/0/organization_id

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

string

False

phones/0/contact_id

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

string

False

phones/0/service_at_location_id

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

string

False

phones/0/number

The phone number.

string

True

phones/0/extension

The extension of the phone number.

string

False

phones/0/type

Whether the phone number relates to a fixed or cellular phone.

string

False

phones/0/department

The department for which this is the phone number.

string

False

phones/0/language

A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.

string

False

phones/0/description

A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.

string

False

POST /locations/

Submit Bulk Location

Submit Bulk Location

Status Codes
  • 200 OK – Location Response

200 Response Body:

Description

Type

Required

id

Each location must have a unique identifier.

string

True

organization_id

Each location must belong to a single organization. The identifier of the organization should be given here.

string

False

name

The name of the location.

string

False

alternate_name

An alternative name for the location.

string

False

description

A description of this location.

string

False

transportation

A description of the access to public or private transportation to and from the location.

string

False

latitude

Y coordinate of location expressed in decimal degrees in WGS84 datum.

string

False

longitude

X coordinate of location expressed in decimal degrees in WGS84 datum.

string

False

regular_schedule/0/id

Each entry must have a unique identifier.

string

True

regular_schedule/0/service_id

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

string

False

regular_schedule/0/location_id

The identifier of the location for which this is the regular schedule.

string

False

regular_schedule/0/service_at_location_id

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

string

False

regular_schedule/0/weekday

The day of the week that this entry relates to.

string

True

regular_schedule/0/opens_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

regular_schedule/0/closes_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

holiday_schedule/0/id

Each entry must have a unique identifier.

string

True

holiday_schedule/0/service_id

The identifier of the service for which this is the holiday schedule.

string

False

holiday_schedule/0/location_id

The identifier of the location for which this is the holiday schedule.

string

False

holiday_schedule/0/service_at_location_id

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

string

False

holiday_schedule/0/closed

Indicates if a service or location is closed during a public holiday.

boolean

True

holiday_schedule/0/opens_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

holiday_schedule/0/closes_at

The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

holiday_schedule/0/start_date

The first day that a service or location is closed during a public or private holiday.

string

True

holiday_schedule/0/end_date

The last day that a service or location is closed during a public or private holiday.

string

True

languages/0/id

Each language must have a unique identifier.

string

True

languages/0/service_id

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

string

False

languages/0/location_id

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

string

False

languages/0/language

Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..

string

False

postal_address/0/id

Each postal address must have a unique identifier.

string

True

postal_address/0/location_id

The identifier of the location for which this is the postal address.

string

False

postal_address/0/attention

The person or entity for whose attention mail should be marked.

string

False

postal_address/0/address_1

The first line of the address.

string

False

postal_address/0/address_2

The second line of the address.

string

False

postal_address/0/address_3

The third line of the address.

string

False

postal_address/0/address_4

The fourth line of the address.

string

False

postal_address/0/city

The city in which the address is located.

string

False

postal_address/0/region

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

string

False

postal_address/0/state_province

The state or province in which the address is located.

string

False

postal_address/0/postal_code

The postal code for the address.

string

False

postal_address/0/country

The country in which the address is located.

string

False

physical_address/0/id

Each physical address must have a unique identifier.

string

True

physical_address/0/location_id

The identifier of the location for which this is the address.

string

False

physical_address/0/attention

The person or entity whose attention should be sought at the location.

string

False

physical_address/0/address_1

The first line of the address.

string

True

physical_address/0/address_2

The second line of the address.

string

False

physical_address/0/address_3

The third line of the address.

string

False

physical_address/0/address_4

The fourth line of the address.

string

False

physical_address/0/city

The city in which the address is located.

string

True

physical_address/0/region

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

string

False

physical_address/0/state_province

The state or province in which the address is located.

string

True

physical_address/0/postal_code

The postal code for the address.

string

True

physical_address/0/country

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

string

True

phones/0/id

Each entry must have a unique identifier.

string

True

phones/0/location_id

The identifier of the location where this phone number is located.

string

False

phones/0/service_id

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

string

False

phones/0/organization_id

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

string

False

phones/0/contact_id

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

string

False

phones/0/service_at_location_id

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

string

False

phones/0/number

The phone number.

string

True

phones/0/extension

The extension of the phone number.

string

False

phones/0/type

Whether the phone number relates to a fixed or cellular phone.

string

False

phones/0/department

The department for which this is the phone number.

string

False

phones/0/language

A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.

string

False

phones/0/description

A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.

string

False

service/0/id

Each service must have a unique identifier.

string

True

service/0/organization_id

The identifier of the organization that provides this service.

string

True

service/0/program_id

The identifier of the program this service is delivered under.

string

False

service/0/location_id

The identifier of the location where this service is delivered.

string

False

service/0/name

The official or public name of the service.

string

True

service/0/alternate_name

Alternative or commonly used name for a service.

string

False

service/0/description

A description of the service.

string

False

service/0/url

URL of the service.

string

False

service/0/email

Email address for the service.

string

False

service/0/status

The current status of the service.

string

True

service/0/interpretation_services

A description of any interpretation services available for accessing this service.

string

False

service/0/application_process

The steps needed to access the service.

string

False

service/0/wait_time

Time a client may expect to wait before receiving a service.

string

False

service/0/accreditations

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

string

False

service/0/licenses

An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.

string

False

service/0/contacts/0/id

Each contact must have a unique identifier.

string

True

service/0/contacts/0/organization_id

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

string

False

service/0/contacts/0/service_id

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

string

False

service/0/contacts/0/service_at_location_id

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

string

False

service/0/contacts/0/name

The name of the person.

string

False

service/0/contacts/0/title

The job title of the person.

string

False

service/0/contacts/0/department

The department that the person is part of.

string

False

service/0/contacts/0/email

The email address of the person.

string

False

service/0/contacts/0/phones/0/id

Each entry must have a unique identifier.

string

True

service/0/contacts/0/phones/0/location_id

The identifier of the location where this phone number is located.

string

False

service/0/contacts/0/phones/0/service_id

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

string

False

service/0/contacts/0/phones/0/organization_id

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

string

False

service/0/contacts/0/phones/0/contact_id

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

string

False

service/0/contacts/0/phones/0/service_at_location_id

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

string

False

service/0/contacts/0/phones/0/number

The phone number.

string

True

service/0/contacts/0/phones/0/extension

The extension of the phone number.

string

False

service/0/contacts/0/phones/0/type

Whether the phone number relates to a fixed or cellular phone.

string

False

service/0/contacts/0/phones/0/department

The department for which this is the phone number.

string

False

service/0/contacts/0/phones/0/language

A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.

string

False

service/0/contacts/0/phones/0/description

A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.

string

False

service/0/eligibility/0/id

Each entry must have a unique identifier.

string

True

service/0/eligibility/0/service_id

The identifier of the service for which this entry describes the eligibility criteria.

string

False

service/0/eligibility/0/eligibility

The rules or guidelines that determine who can receive the service.

string

False

service/0/fees/0/id

Each entry must have a unique identifier.

string

True

service/0/fees/0/service_id

The identifier of the service for which this entry describes the costs of service.

string

False

service/0/fees/0/fee

A listing of the costs of services, including free ones.

string

False

service/0/funding/0/id

Each entry must have a unique identifier.

string

True

service/0/funding/0/organization_id

The identifier of the organization for which this entry describes the source of funding.

string

False

service/0/funding/0/service_id

The identifier of the service for which this entry describes the source of funding.

string

False

service/0/funding/0/source

Source of funds for organization or service.

string

False

service/0/regular_schedule/0/id

Each entry must have a unique identifier.

string

True

service/0/regular_schedule/0/service_id

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

string

False

service/0/regular_schedule/0/location_id

The identifier of the location for which this is the regular schedule.

string

False

service/0/regular_schedule/0/service_at_location_id

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

string

False

service/0/regular_schedule/0/weekday

The day of the week that this entry relates to.

string

True

service/0/regular_schedule/0/opens_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

service/0/regular_schedule/0/closes_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

service/0/holiday_schedule/0/id

Each entry must have a unique identifier.

string

True

service/0/holiday_schedule/0/service_id

The identifier of the service for which this is the holiday schedule.

string

False

service/0/holiday_schedule/0/location_id

The identifier of the location for which this is the holiday schedule.

string

False

service/0/holiday_schedule/0/service_at_location_id

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

string

False

service/0/holiday_schedule/0/closed

Indicates if a service or location is closed during a public holiday.

boolean

True

service/0/holiday_schedule/0/opens_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

service/0/holiday_schedule/0/closes_at

The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

service/0/holiday_schedule/0/start_date

The first day that a service or location is closed during a public or private holiday.

string

True

service/0/holiday_schedule/0/end_date

The last day that a service or location is closed during a public or private holiday.

string

True

service/0/languages/0/id

Each language must have a unique identifier.

string

True

service/0/languages/0/service_id

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

string

False

service/0/languages/0/location_id

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

string

False

service/0/languages/0/language

Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..

string

False

service/0/payment_accepted/0/id

Each entry must have a unique identifier.

string

True

service/0/payment_accepted/0/service_id

The identifier of the services for which the entry describes the accepted payment methods.

string

False

service/0/payment_accepted/0/payment

The methods of payment accepted for the service.

string

False

service/0/phones/0/id

Each entry must have a unique identifier.

string

True

service/0/phones/0/location_id

The identifier of the location where this phone number is located.

string

False

service/0/phones/0/service_id

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

string

False

service/0/phones/0/organization_id

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

string

False

service/0/phones/0/contact_id

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

string

False

service/0/phones/0/service_at_location_id

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

string

False

service/0/phones/0/number

The phone number.

string

True

service/0/phones/0/extension

The extension of the phone number.

string

False

service/0/phones/0/type

Whether the phone number relates to a fixed or cellular phone.

string

False

service/0/phones/0/department

The department for which this is the phone number.

string

False

service/0/phones/0/language

A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.

string

False

service/0/phones/0/description

A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.

string

False

service/0/required_documents/0/id

Each document must have a unique identifier.

string

True

service/0/required_documents/0/service_id

The identifier of the service for which this entry describes the required document.

string

False

service/0/required_documents/0/document

The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.

string

False

service/0/service_area/0/id

Each service area must have a unique identifier.

string

True

service/0/service_area/0/service_id

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

string

False

service/0/service_area/0/service_area

The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.

string

False

service/0/service_area/0/description

A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.

string

False

accessibility_for_disabilities/0/id

Each entry must have a unique identifier.

string

True

accessibility_for_disabilities/0/location_id

The identifier of the location for which the entry describes the accessibility provision.

string

False

accessibility_for_disabilities/0/accessibility

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

string

False

accessibility_for_disabilities/0/details

Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.

string

False

POST /organizations/

Submit Bulk Organizations

Submit Bulk Organizations

Status Codes
  • 200 OK – Organization Response

200 Response Body:

Description

Type

Required

id

Each organization must have a unique identifier.

string

True

name

The official or public name of the organization.

string

False

alternate_name

Alternative or commonly used name for the organization.

string

False

description

A brief summary about the organization. It can contain markup such as HTML or Markdow.

string

True

email

The contact e-mail address for the organization.

string

False

url

The URL (website address) of the organization.

string

False

tax_status

Government assigned tax designation for for tax-exempt organizations.

string

False

tax_id

A government issued identifier used for the purpose of tax administration.

string

False

year_incorporated

The year in which the organization was legally formed.

string

False

legal_status

The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.

string

False

contacts/0/id

Each contact must have a unique identifier.

string

True

contacts/0/organization_id

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

string

False

contacts/0/service_id

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

string

False

contacts/0/service_at_location_id

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

string

False

contacts/0/name

The name of the person.

string

False

contacts/0/title

The job title of the person.

string

False

contacts/0/department

The department that the person is part of.

string

False

contacts/0/email

The email address of the person.

string

False

contacts/0/phones/0/id

Each entry must have a unique identifier.

string

True

contacts/0/phones/0/location_id

The identifier of the location where this phone number is located.

string

False

contacts/0/phones/0/service_id

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

string

False

contacts/0/phones/0/organization_id

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

string

False

contacts/0/phones/0/contact_id

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

string

False

contacts/0/phones/0/service_at_location_id

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

string

False

contacts/0/phones/0/number

The phone number.

string

True

contacts/0/phones/0/extension

The extension of the phone number.

string

False

contacts/0/phones/0/type

Whether the phone number relates to a fixed or cellular phone.

string

False

contacts/0/phones/0/department

The department for which this is the phone number.

string

False

contacts/0/phones/0/language

A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.

string

False

contacts/0/phones/0/description

A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.

string

False

funding/0/id

Each entry must have a unique identifier.

string

True

funding/0/organization_id

The identifier of the organization for which this entry describes the source of funding.

string

False

funding/0/service_id

The identifier of the service for which this entry describes the source of funding.

string

False

funding/0/source

Source of funds for organization or service.

string

False

locations/0/id

Each location must have a unique identifier.

string

True

locations/0/organization_id

Each location must belong to a single organization. The identifier of the organization should be given here.

string

False

locations/0/name

The name of the location.

string

False

locations/0/alternate_name

An alternative name for the location.

string

False

locations/0/description

A description of this location.

string

False

locations/0/transportation

A description of the access to public or private transportation to and from the location.

string

False

locations/0/latitude

Y coordinate of location expressed in decimal degrees in WGS84 datum.

string

False

locations/0/longitude

X coordinate of location expressed in decimal degrees in WGS84 datum.

string

False

locations/0/regular_schedule/0/id

Each entry must have a unique identifier.

string

True

locations/0/regular_schedule/0/service_id

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

string

False

locations/0/regular_schedule/0/location_id

The identifier of the location for which this is the regular schedule.

string

False

locations/0/regular_schedule/0/service_at_location_id

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

string

False

locations/0/regular_schedule/0/weekday

The day of the week that this entry relates to.

string

True

locations/0/regular_schedule/0/opens_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

locations/0/regular_schedule/0/closes_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

locations/0/holiday_schedule/0/id

Each entry must have a unique identifier.

string

True

locations/0/holiday_schedule/0/service_id

The identifier of the service for which this is the holiday schedule.

string

False

locations/0/holiday_schedule/0/location_id

The identifier of the location for which this is the holiday schedule.

string

False

locations/0/holiday_schedule/0/service_at_location_id

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

string

False

locations/0/holiday_schedule/0/closed

Indicates if a service or location is closed during a public holiday.

boolean

True

locations/0/holiday_schedule/0/opens_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

locations/0/holiday_schedule/0/closes_at

The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

locations/0/holiday_schedule/0/start_date

The first day that a service or location is closed during a public or private holiday.

string

True

locations/0/holiday_schedule/0/end_date

The last day that a service or location is closed during a public or private holiday.

string

True

locations/0/languages/0/id

Each language must have a unique identifier.

string

True

locations/0/languages/0/service_id

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

string

False

locations/0/languages/0/location_id

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

string

False

locations/0/languages/0/language

Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..

string

False

locations/0/postal_address/0/id

Each postal address must have a unique identifier.

string

True

locations/0/postal_address/0/location_id

The identifier of the location for which this is the postal address.

string

False

locations/0/postal_address/0/attention

The person or entity for whose attention mail should be marked.

string

False

locations/0/postal_address/0/address_1

The first line of the address.

string

False

locations/0/postal_address/0/address_2

The second line of the address.

string

False

locations/0/postal_address/0/address_3

The third line of the address.

string

False

locations/0/postal_address/0/address_4

The fourth line of the address.

string

False

locations/0/postal_address/0/city

The city in which the address is located.

string

False

locations/0/postal_address/0/region

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

string

False

locations/0/postal_address/0/state_province

The state or province in which the address is located.

string

False

locations/0/postal_address/0/postal_code

The postal code for the address.

string

False

locations/0/postal_address/0/country

The country in which the address is located.

string

False

locations/0/physical_address/0/id

Each physical address must have a unique identifier.

string

True

locations/0/physical_address/0/location_id

The identifier of the location for which this is the address.

string

False

locations/0/physical_address/0/attention

The person or entity whose attention should be sought at the location.

string

False

locations/0/physical_address/0/address_1

The first line of the address.

string

True

locations/0/physical_address/0/address_2

The second line of the address.

string

False

locations/0/physical_address/0/address_3

The third line of the address.

string

False

locations/0/physical_address/0/address_4

The fourth line of the address.

string

False

locations/0/physical_address/0/city

The city in which the address is located.

string

True

locations/0/physical_address/0/region

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

string

False

locations/0/physical_address/0/state_province

The state or province in which the address is located.

string

True

locations/0/physical_address/0/postal_code

The postal code for the address.

string

True

locations/0/physical_address/0/country

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

string

True

locations/0/phones/0/id

Each entry must have a unique identifier.

string

True

locations/0/phones/0/location_id

The identifier of the location where this phone number is located.

string

False

locations/0/phones/0/service_id

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

string

False

locations/0/phones/0/organization_id

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

string

False

locations/0/phones/0/contact_id

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

string

False

locations/0/phones/0/service_at_location_id

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

string

False

locations/0/phones/0/number

The phone number.

string

True

locations/0/phones/0/extension

The extension of the phone number.

string

False

locations/0/phones/0/type

Whether the phone number relates to a fixed or cellular phone.

string

False

locations/0/phones/0/department

The department for which this is the phone number.

string

False

locations/0/phones/0/language

A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.

string

False

locations/0/phones/0/description

A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.

string

False

locations/0/service/0/id

Each service must have a unique identifier.

string

True

locations/0/service/0/organization_id

The identifier of the organization that provides this service.

string

True

locations/0/service/0/program_id

The identifier of the program this service is delivered under.

string

False

locations/0/service/0/location_id

The identifier of the location where this service is delivered.

string

False

locations/0/service/0/name

The official or public name of the service.

string

True

locations/0/service/0/alternate_name

Alternative or commonly used name for a service.

string

False

locations/0/service/0/description

A description of the service.

string

False

locations/0/service/0/url

URL of the service.

string

False

locations/0/service/0/email

Email address for the service.

string

False

locations/0/service/0/status

The current status of the service.

string

True

locations/0/service/0/interpretation_services

A description of any interpretation services available for accessing this service.

string

False

locations/0/service/0/application_process

The steps needed to access the service.

string

False

locations/0/service/0/wait_time

Time a client may expect to wait before receiving a service.

string

False

locations/0/service/0/accreditations

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

string

False

locations/0/service/0/licenses

An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.

string

False

locations/0/service/0/contacts/0/id

Each contact must have a unique identifier.

string

True

locations/0/service/0/contacts/0/organization_id

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

string

False

locations/0/service/0/contacts/0/service_id

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

string

False

locations/0/service/0/contacts/0/service_at_location_id

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

string

False

locations/0/service/0/contacts/0/name

The name of the person.

string

False

locations/0/service/0/contacts/0/title

The job title of the person.

string

False

locations/0/service/0/contacts/0/department

The department that the person is part of.

string

False

locations/0/service/0/contacts/0/email

The email address of the person.

string

False

locations/0/service/0/contacts/0/phones/0/id

Each entry must have a unique identifier.

string

True

locations/0/service/0/contacts/0/phones/0/location_id

The identifier of the location where this phone number is located.

string

False

locations/0/service/0/contacts/0/phones/0/service_id

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

string

False

locations/0/service/0/contacts/0/phones/0/organization_id

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

string

False

locations/0/service/0/contacts/0/phones/0/contact_id

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

string

False

locations/0/service/0/contacts/0/phones/0/service_at_location_id

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

string

False

locations/0/service/0/contacts/0/phones/0/number

The phone number.

string

True

locations/0/service/0/contacts/0/phones/0/extension

The extension of the phone number.

string

False

locations/0/service/0/contacts/0/phones/0/type

Whether the phone number relates to a fixed or cellular phone.

string

False

locations/0/service/0/contacts/0/phones/0/department

The department for which this is the phone number.

string

False

locations/0/service/0/contacts/0/phones/0/language

A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.

string

False

locations/0/service/0/contacts/0/phones/0/description

A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.

string

False

locations/0/service/0/eligibility/0/id

Each entry must have a unique identifier.

string

True

locations/0/service/0/eligibility/0/service_id

The identifier of the service for which this entry describes the eligibility criteria.

string

False

locations/0/service/0/eligibility/0/eligibility

The rules or guidelines that determine who can receive the service.

string

False

locations/0/service/0/fees/0/id

Each entry must have a unique identifier.

string

True

locations/0/service/0/fees/0/service_id

The identifier of the service for which this entry describes the costs of service.

string

False

locations/0/service/0/fees/0/fee

A listing of the costs of services, including free ones.

string

False

locations/0/service/0/funding/0/id

Each entry must have a unique identifier.

string

True

locations/0/service/0/funding/0/organization_id

The identifier of the organization for which this entry describes the source of funding.

string

False

locations/0/service/0/funding/0/service_id

The identifier of the service for which this entry describes the source of funding.

string

False

locations/0/service/0/funding/0/source

Source of funds for organization or service.

string

False

locations/0/service/0/regular_schedule/0/id

Each entry must have a unique identifier.

string

True

locations/0/service/0/regular_schedule/0/service_id

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

string

False

locations/0/service/0/regular_schedule/0/location_id

The identifier of the location for which this is the regular schedule.

string

False

locations/0/service/0/regular_schedule/0/service_at_location_id

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

string

False

locations/0/service/0/regular_schedule/0/weekday

The day of the week that this entry relates to.

string

True

locations/0/service/0/regular_schedule/0/opens_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

locations/0/service/0/regular_schedule/0/closes_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

locations/0/service/0/holiday_schedule/0/id

Each entry must have a unique identifier.

string

True

locations/0/service/0/holiday_schedule/0/service_id

The identifier of the service for which this is the holiday schedule.

string

False

locations/0/service/0/holiday_schedule/0/location_id

The identifier of the location for which this is the holiday schedule.

string

False

locations/0/service/0/holiday_schedule/0/service_at_location_id

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

string

False

locations/0/service/0/holiday_schedule/0/closed

Indicates if a service or location is closed during a public holiday.

boolean

True

locations/0/service/0/holiday_schedule/0/opens_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

locations/0/service/0/holiday_schedule/0/closes_at

The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

locations/0/service/0/holiday_schedule/0/start_date

The first day that a service or location is closed during a public or private holiday.

string

True

locations/0/service/0/holiday_schedule/0/end_date

The last day that a service or location is closed during a public or private holiday.

string

True

locations/0/service/0/languages/0/id

Each language must have a unique identifier.

string

True

locations/0/service/0/languages/0/service_id

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

string

False

locations/0/service/0/languages/0/location_id

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

string

False

locations/0/service/0/languages/0/language

Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..

string

False

locations/0/service/0/payment_accepted/0/id

Each entry must have a unique identifier.

string

True

locations/0/service/0/payment_accepted/0/service_id

The identifier of the services for which the entry describes the accepted payment methods.

string

False

locations/0/service/0/payment_accepted/0/payment

The methods of payment accepted for the service.

string

False

locations/0/service/0/phones/0/id

Each entry must have a unique identifier.

string

True

locations/0/service/0/phones/0/location_id

The identifier of the location where this phone number is located.

string

False

locations/0/service/0/phones/0/service_id

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

string

False

locations/0/service/0/phones/0/organization_id

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

string

False

locations/0/service/0/phones/0/contact_id

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

string

False

locations/0/service/0/phones/0/service_at_location_id

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

string

False

locations/0/service/0/phones/0/number

The phone number.

string

True

locations/0/service/0/phones/0/extension

The extension of the phone number.

string

False

locations/0/service/0/phones/0/type

Whether the phone number relates to a fixed or cellular phone.

string

False

locations/0/service/0/phones/0/department

The department for which this is the phone number.

string

False

locations/0/service/0/phones/0/language

A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.

string

False

locations/0/service/0/phones/0/description

A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.

string

False

locations/0/service/0/required_documents/0/id

Each document must have a unique identifier.

string

True

locations/0/service/0/required_documents/0/service_id

The identifier of the service for which this entry describes the required document.

string

False

locations/0/service/0/required_documents/0/document

The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.

string

False

locations/0/service/0/service_area/0/id

Each service area must have a unique identifier.

string

True

locations/0/service/0/service_area/0/service_id

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

string

False

locations/0/service/0/service_area/0/service_area

The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.

string

False

locations/0/service/0/service_area/0/description

A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.

string

False

locations/0/accessibility_for_disabilities/0/id

Each entry must have a unique identifier.

string

True

locations/0/accessibility_for_disabilities/0/location_id

The identifier of the location for which the entry describes the accessibility provision.

string

False

locations/0/accessibility_for_disabilities/0/accessibility

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

string

False

locations/0/accessibility_for_disabilities/0/details

Any further details relating to the relevant accessibility arrangements at this location. E.g. whether advance notice is required to use an accessibility facility.

string

False

programs/0/id

Each program must have a unique identifier.

string

True

programs/0/organization_id

Each program must belong to a single organization. The identifier of the organization should be given here.

string

True

programs/0/name

The name of the program.

string

True

programs/0/alternate_name

NeAn alternative name for the program.

string

False

services/0/id

Each service must have a unique identifier.

string

True

services/0/organization_id

The identifier of the organization that provides this service.

string

True

services/0/program_id

The identifier of the program this service is delivered under.

string

False

services/0/location_id

The identifier of the location where this service is delivered.

string

False

services/0/name

The official or public name of the service.

string

True

services/0/alternate_name

Alternative or commonly used name for a service.

string

False

services/0/description

A description of the service.

string

False

services/0/url

URL of the service.

string

False

services/0/email

Email address for the service.

string

False

services/0/status

The current status of the service.

string

True

services/0/interpretation_services

A description of any interpretation services available for accessing this service.

string

False

services/0/application_process

The steps needed to access the service.

string

False

services/0/wait_time

Time a client may expect to wait before receiving a service.

string

False

services/0/accreditations

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

string

False

services/0/licenses

An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.

string

False

services/0/contacts/0/id

Each contact must have a unique identifier.

string

True

services/0/contacts/0/organization_id

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

string

False

services/0/contacts/0/service_id

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

string

False

services/0/contacts/0/service_at_location_id

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

string

False

services/0/contacts/0/name

The name of the person.

string

False

services/0/contacts/0/title

The job title of the person.

string

False

services/0/contacts/0/department

The department that the person is part of.

string

False

services/0/contacts/0/email

The email address of the person.

string

False

services/0/contacts/0/phones/0/id

Each entry must have a unique identifier.

string

True

services/0/contacts/0/phones/0/location_id

The identifier of the location where this phone number is located.

string

False

services/0/contacts/0/phones/0/service_id

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

string

False

services/0/contacts/0/phones/0/organization_id

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

string

False

services/0/contacts/0/phones/0/contact_id

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

string

False

services/0/contacts/0/phones/0/service_at_location_id

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

string

False

services/0/contacts/0/phones/0/number

The phone number.

string

True

services/0/contacts/0/phones/0/extension

The extension of the phone number.

string

False

services/0/contacts/0/phones/0/type

Whether the phone number relates to a fixed or cellular phone.

string

False

services/0/contacts/0/phones/0/department

The department for which this is the phone number.

string

False

services/0/contacts/0/phones/0/language

A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.

string

False

services/0/contacts/0/phones/0/description

A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.

string

False

services/0/eligibility/0/id

Each entry must have a unique identifier.

string

True

services/0/eligibility/0/service_id

The identifier of the service for which this entry describes the eligibility criteria.

string

False

services/0/eligibility/0/eligibility

The rules or guidelines that determine who can receive the service.

string

False

services/0/fees/0/id

Each entry must have a unique identifier.

string

True

services/0/fees/0/service_id

The identifier of the service for which this entry describes the costs of service.

string

False

services/0/fees/0/fee

A listing of the costs of services, including free ones.

string

False

services/0/funding/0/id

Each entry must have a unique identifier.

string

True

services/0/funding/0/organization_id

The identifier of the organization for which this entry describes the source of funding.

string

False

services/0/funding/0/service_id

The identifier of the service for which this entry describes the source of funding.

string

False

services/0/funding/0/source

Source of funds for organization or service.

string

False

services/0/regular_schedule/0/id

Each entry must have a unique identifier.

string

True

services/0/regular_schedule/0/service_id

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

string

False

services/0/regular_schedule/0/location_id

The identifier of the location for which this is the regular schedule.

string

False

services/0/regular_schedule/0/service_at_location_id

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

string

False

services/0/regular_schedule/0/weekday

The day of the week that this entry relates to.

string

True

services/0/regular_schedule/0/opens_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

services/0/regular_schedule/0/closes_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

services/0/holiday_schedule/0/id

Each entry must have a unique identifier.

string

True

services/0/holiday_schedule/0/service_id

The identifier of the service for which this is the holiday schedule.

string

False

services/0/holiday_schedule/0/location_id

The identifier of the location for which this is the holiday schedule.

string

False

services/0/holiday_schedule/0/service_at_location_id

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

string

False

services/0/holiday_schedule/0/closed

Indicates if a service or location is closed during a public holiday.

boolean

True

services/0/holiday_schedule/0/opens_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

services/0/holiday_schedule/0/closes_at

The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

services/0/holiday_schedule/0/start_date

The first day that a service or location is closed during a public or private holiday.

string

True

services/0/holiday_schedule/0/end_date

The last day that a service or location is closed during a public or private holiday.

string

True

services/0/languages/0/id

Each language must have a unique identifier.

string

True

services/0/languages/0/service_id

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

string

False

services/0/languages/0/location_id

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

string

False

services/0/languages/0/language

Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..

string

False

services/0/payment_accepted/0/id

Each entry must have a unique identifier.

string

True

services/0/payment_accepted/0/service_id

The identifier of the services for which the entry describes the accepted payment methods.

string

False

services/0/payment_accepted/0/payment

The methods of payment accepted for the service.

string

False

services/0/phones/0/id

Each entry must have a unique identifier.

string

True

services/0/phones/0/location_id

The identifier of the location where this phone number is located.

string

False

services/0/phones/0/service_id

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

string

False

services/0/phones/0/organization_id

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

string

False

services/0/phones/0/contact_id

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

string

False

services/0/phones/0/service_at_location_id

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

string

False

services/0/phones/0/number

The phone number.

string

True

services/0/phones/0/extension

The extension of the phone number.

string

False

services/0/phones/0/type

Whether the phone number relates to a fixed or cellular phone.

string

False

services/0/phones/0/department

The department for which this is the phone number.

string

False

services/0/phones/0/language

A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.

string

False

services/0/phones/0/description

A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.

string

False

services/0/required_documents/0/id

Each document must have a unique identifier.

string

True

services/0/required_documents/0/service_id

The identifier of the service for which this entry describes the required document.

string

False

services/0/required_documents/0/document

The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.

string

False

services/0/service_area/0/id

Each service area must have a unique identifier.

string

True

services/0/service_area/0/service_id

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

string

False

services/0/service_area/0/service_area

The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.

string

False

services/0/service_area/0/description

A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.

string

False

POST /services/

Submit Bulk Service

Submit Bulk Service

Status Codes

200 Response Body:

Description

Type

Required

id

Each service must have a unique identifier.

string

True

organization_id

The identifier of the organization that provides this service.

string

True

program_id

The identifier of the program this service is delivered under.

string

False

location_id

The identifier of the location where this service is delivered.

string

False

name

The official or public name of the service.

string

True

alternate_name

Alternative or commonly used name for a service.

string

False

description

A description of the service.

string

False

url

URL of the service.

string

False

email

Email address for the service.

string

False

status

The current status of the service.

string

True

interpretation_services

A description of any interpretation services available for accessing this service.

string

False

application_process

The steps needed to access the service.

string

False

wait_time

Time a client may expect to wait before receiving a service.

string

False

accreditations

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

string

False

licenses

An organization may have a license issued by a government entity to operate legally. A list of any such licenses can be provided here.

string

False

contacts/0/id

Each contact must have a unique identifier.

string

True

contacts/0/organization_id

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

string

False

contacts/0/service_id

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

string

False

contacts/0/service_at_location_id

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

string

False

contacts/0/name

The name of the person.

string

False

contacts/0/title

The job title of the person.

string

False

contacts/0/department

The department that the person is part of.

string

False

contacts/0/email

The email address of the person.

string

False

contacts/0/phones/0/id

Each entry must have a unique identifier.

string

True

contacts/0/phones/0/location_id

The identifier of the location where this phone number is located.

string

False

contacts/0/phones/0/service_id

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

string

False

contacts/0/phones/0/organization_id

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

string

False

contacts/0/phones/0/contact_id

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

string

False

contacts/0/phones/0/service_at_location_id

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

string

False

contacts/0/phones/0/number

The phone number.

string

True

contacts/0/phones/0/extension

The extension of the phone number.

string

False

contacts/0/phones/0/type

Whether the phone number relates to a fixed or cellular phone.

string

False

contacts/0/phones/0/department

The department for which this is the phone number.

string

False

contacts/0/phones/0/language

A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.

string

False

contacts/0/phones/0/description

A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.

string

False

eligibility/0/id

Each entry must have a unique identifier.

string

True

eligibility/0/service_id

The identifier of the service for which this entry describes the eligibility criteria.

string

False

eligibility/0/eligibility

The rules or guidelines that determine who can receive the service.

string

False

fees/0/id

Each entry must have a unique identifier.

string

True

fees/0/service_id

The identifier of the service for which this entry describes the costs of service.

string

False

fees/0/fee

A listing of the costs of services, including free ones.

string

False

funding/0/id

Each entry must have a unique identifier.

string

True

funding/0/organization_id

The identifier of the organization for which this entry describes the source of funding.

string

False

funding/0/service_id

The identifier of the service for which this entry describes the source of funding.

string

False

funding/0/source

Source of funds for organization or service.

string

False

regular_schedule/0/id

Each entry must have a unique identifier.

string

True

regular_schedule/0/service_id

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

string

False

regular_schedule/0/location_id

The identifier of the location for which this is the regular schedule.

string

False

regular_schedule/0/service_at_location_id

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

string

False

regular_schedule/0/weekday

The day of the week that this entry relates to.

string

True

regular_schedule/0/opens_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

regular_schedule/0/closes_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

holiday_schedule/0/id

Each entry must have a unique identifier.

string

True

holiday_schedule/0/service_id

The identifier of the service for which this is the holiday schedule.

string

False

holiday_schedule/0/location_id

The identifier of the location for which this is the holiday schedule.

string

False

holiday_schedule/0/service_at_location_id

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

string

False

holiday_schedule/0/closed

Indicates if a service or location is closed during a public holiday.

boolean

True

holiday_schedule/0/opens_at

The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

holiday_schedule/0/closes_at

The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.

string

False

holiday_schedule/0/start_date

The first day that a service or location is closed during a public or private holiday.

string

True

holiday_schedule/0/end_date

The last day that a service or location is closed during a public or private holiday.

string

True

languages/0/id

Each language must have a unique identifier.

string

True

languages/0/service_id

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

string

False

languages/0/location_id

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

string

False

languages/0/language

Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..

string

False

payment_accepted/0/id

Each entry must have a unique identifier.

string

True

payment_accepted/0/service_id

The identifier of the services for which the entry describes the accepted payment methods.

string

False

payment_accepted/0/payment

The methods of payment accepted for the service.

string

False

phones/0/id

Each entry must have a unique identifier.

string

True

phones/0/location_id

The identifier of the location where this phone number is located.

string

False

phones/0/service_id

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

string

False

phones/0/organization_id

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

string

False

phones/0/contact_id

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

string

False

phones/0/service_at_location_id

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

string

False

phones/0/number

The phone number.

string

True

phones/0/extension

The extension of the phone number.

string

False

phones/0/type

Whether the phone number relates to a fixed or cellular phone.

string

False

phones/0/department

The department for which this is the phone number.

string

False

phones/0/language

A comma separated list of ISO 639-1, or ISO 639-2 language codes to represent the languages available from this phone service. The three-letter codes from ISO 639-2 provide greater accuracy when describing variants of languages, which may be relevant to particular communities.

string

False

phones/0/description

A description providing extra information about the phone service (e.g. any special arrangements for accessing, or details of availability at particular times.

string

False

required_documents/0/id

Each document must have a unique identifier.

string

True

required_documents/0/service_id

The identifier of the service for which this entry describes the required document.

string

False

required_documents/0/document

The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.

string

False

service_area/0/id

Each service area must have a unique identifier.

string

True

service_area/0/service_id

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

string

False

service_area/0/service_area

The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.

string

False

service_area/0/description

A more detailed description of this service area. Used to provide any additional information that cannot be communicated using the structured area and geometry fields.

string

False

GET /jobs/

Get Jobs

Get Jobs

Query Parameters
  • query (string) – A query to filter list by (up to provider to determine what to search)

  • queries (string) – A comma separate list of queries with specific fields.

  • page (number) – The particular page of results.

  • per_page (number) – Number of records to return per page, up to 100.

  • sort_by (string) – Which field to sort by.

  • order (string) – Which order to sort by (asc,desc).

Status Codes

200 Response Body:

Description

Type

Required

id

The unique id of the job

string

False

path

The path the job is being run against.

string

False

verb

The verb the job is being run against.

string

False

status

The status of the job.

string

False

complete

The date the job was completed.

date

False

GET /jobs/{job_id}/run/

Run Job

Run a specific job

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

Status Codes

200 Response Body:

Description

Type

Required

id

The unique id of the job

string

False

path

The path the job is being run against.

string

False

verb

The verb the job is being run against.

string

False

status

The status of the job.

string

False

complete

The date the job was completed.

date

False