{"openapi":"3.0.3","info":{"title":"My Noticeboard: Open Referral UK feed","version":"3.0","description":"Community groups and services on the Jurassic Coast, published to the Open Referral UK 3.0 profile. For phones, contact emails and resources, use the HSDS 3.3 feed at /api/hsds. For incremental sync, use /api/changes?since=.","license":{"name":"Open Government Licence v3.0","url":"https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/"}},"servers":[{"url":"https://mynoticeboard.org.uk/api/oruk"}],"paths":{"/":{"get":{"summary":"API information","operationId":"getApiDetails","responses":{"200":{"description":"Version and profile.","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"},"profile":{"type":"string","format":"uri"},"openapi_url":{"type":"string","format":"uri"}}}}}}}}},"/services":{"get":{"summary":"List services","operationId":"getServices","parameters":[{"name":"search","in":"query","required":false,"description":"Full-text search.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number, from 1.","schema":{"type":"integer"}},{"name":"per_page","in":"query","required":false,"description":"Results per page (default 50, maximum 500).","schema":{"type":"integer"}},{"name":"taxonomy_term_id","in":"query","required":false,"description":"Only services with this taxonomy term.","schema":{"type":"string"}},{"name":"taxonomy_id","in":"query","required":false,"description":"Only services with any term from this taxonomy.","schema":{"type":"string"}},{"name":"organization_id","in":"query","required":false,"description":"Only services from this organisation.","schema":{"type":"string"}},{"name":"minimum_age","in":"query","required":false,"description":"Only services open to people of at least this age.","schema":{"type":"integer"}},{"name":"maximum_age","in":"query","required":false,"description":"Only services open to people of at most this age.","schema":{"type":"integer"}},{"name":"modified_after","in":"query","required":false,"description":"Only services modified on or after this date-time.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of services.","content":{"application/json":{"schema":{"type":"object","properties":{"total_items":{"type":"integer"},"total_pages":{"type":"integer"},"page_number":{"type":"integer"},"size":{"type":"integer"},"first_page":{"type":"boolean"},"last_page":{"type":"boolean"},"empty":{"type":"boolean"},"contents":{"type":"array","items":{"$ref":"https://raw.githubusercontent.com/openreferral/uk-profile/main/schema/compiled/service_list.json"}}}}}}}}}},"/services/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Identifier (UUID).","schema":{"type":"string","format":"uuid"}}],"get":{"summary":"A fully nested service","operationId":"getServiceById","responses":{"200":{"description":"The service.","content":{"application/json":{"schema":{"$ref":"https://raw.githubusercontent.com/openreferral/uk-profile/main/schema/compiled/service.json"}}}},"404":{"description":"Not found."}}}},"/taxonomies":{"get":{"summary":"List taxonomies","operationId":"getTaxonomies","parameters":[{"name":"page","in":"query","required":false,"description":"Page number, from 1.","schema":{"type":"integer"}},{"name":"per_page","in":"query","required":false,"description":"Results per page (default 50, maximum 500).","schema":{"type":"integer"}}],"responses":{"200":{"description":"A page of taxonomies.","content":{"application/json":{"schema":{"type":"object","properties":{"total_items":{"type":"integer"},"total_pages":{"type":"integer"},"page_number":{"type":"integer"},"size":{"type":"integer"},"first_page":{"type":"boolean"},"last_page":{"type":"boolean"},"empty":{"type":"boolean"},"contents":{"type":"array","items":{"$ref":"https://raw.githubusercontent.com/openreferral/uk-profile/main/schema/taxonomy.json"}}}}}}}}}},"/taxonomies/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Identifier (UUID).","schema":{"type":"string","format":"uuid"}}],"get":{"summary":"A taxonomy","operationId":"getTaxonomyById","responses":{"200":{"description":"The taxonomy.","content":{"application/json":{"schema":{"$ref":"https://raw.githubusercontent.com/openreferral/uk-profile/main/schema/taxonomy.json"}}}},"404":{"description":"Not found."}}}},"/taxonomy_terms":{"get":{"summary":"List taxonomy terms","operationId":"getTaxonomyTerms","parameters":[{"name":"page","in":"query","required":false,"description":"Page number, from 1.","schema":{"type":"integer"}},{"name":"per_page","in":"query","required":false,"description":"Results per page (default 50, maximum 500).","schema":{"type":"integer"}}],"responses":{"200":{"description":"A page of terms.","content":{"application/json":{"schema":{"type":"object","properties":{"total_items":{"type":"integer"},"total_pages":{"type":"integer"},"page_number":{"type":"integer"},"size":{"type":"integer"},"first_page":{"type":"boolean"},"last_page":{"type":"boolean"},"empty":{"type":"boolean"},"contents":{"type":"array","items":{"$ref":"https://raw.githubusercontent.com/openreferral/uk-profile/main/schema/taxonomy_term.json"}}}}}}}}}},"/taxonomy_terms/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Identifier (UUID).","schema":{"type":"string","format":"uuid"}}],"get":{"summary":"A taxonomy term","operationId":"getTaxonomyTermById","responses":{"200":{"description":"The term.","content":{"application/json":{"schema":{"$ref":"https://raw.githubusercontent.com/openreferral/uk-profile/main/schema/taxonomy_term.json"}}}},"404":{"description":"Not found."}}}},"/service_at_locations":{"get":{"summary":"List services at locations","operationId":"getServiceAtLocations","parameters":[{"name":"search","in":"query","required":false,"description":"Full-text search.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number, from 1.","schema":{"type":"integer"}},{"name":"per_page","in":"query","required":false,"description":"Results per page (default 50, maximum 500).","schema":{"type":"integer"}},{"name":"taxonomy_term_id","in":"query","required":false,"description":"Only services with this taxonomy term.","schema":{"type":"string"}},{"name":"taxonomy_id","in":"query","required":false,"description":"Only services with any term from this taxonomy.","schema":{"type":"string"}},{"name":"organization_id","in":"query","required":false,"description":"Only services from this organisation.","schema":{"type":"string"}},{"name":"minimum_age","in":"query","required":false,"description":"Only services open to people of at least this age.","schema":{"type":"integer"}},{"name":"maximum_age","in":"query","required":false,"description":"Only services open to people of at most this age.","schema":{"type":"integer"}},{"name":"modified_after","in":"query","required":false,"description":"Only services modified on or after this date-time.","schema":{"type":"string"}},{"name":"postcode","in":"query","required":false,"description":"Only services within proximity of this postcode.","schema":{"type":"string"}},{"name":"proximity","in":"query","required":false,"description":"Distance from the postcode, in metres.","schema":{"type":"integer"}}],"responses":{"200":{"description":"A page of services at locations.","content":{"application/json":{"schema":{"type":"object","properties":{"total_items":{"type":"integer"},"total_pages":{"type":"integer"},"page_number":{"type":"integer"},"size":{"type":"integer"},"first_page":{"type":"boolean"},"last_page":{"type":"boolean"},"empty":{"type":"boolean"},"contents":{"type":"array","items":{"$ref":"https://raw.githubusercontent.com/openreferral/uk-profile/main/schema/compiled/service_at_location_list.json"}}}}}}}}}},"/service_at_locations/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Identifier (UUID).","schema":{"type":"string","format":"uuid"}}],"get":{"summary":"A fully nested service at location","operationId":"getServiceAtLocationById","responses":{"200":{"description":"The service at location.","content":{"application/json":{"schema":{"$ref":"https://raw.githubusercontent.com/openreferral/uk-profile/main/schema/compiled/service.json"}}}},"404":{"description":"Not found."}}}}}}