Introduction
Welcome to the ALISS API docs! You can use our API to search for health and wellbeing services in Scotland.
Both these docs and ALISS are open source. If you'd like to improve this documentation or ALISS itself please add an issue or submit a pull request.
aliss.js
A beta version of aliss.js, our javascript plugin is now available for download. The plugin makes use of the API to embed ALISS search functionality.
Attribution and licensing
ALISS allows the use of data under a Creative Commons (CC BY 4.0) licence. For more information see ALISS Terms and Conditions.
ALISS, contains data from a variety of sources, including:
- National Statistics data © Crown copyright and database right 2018 (Open Government Licence v3.0)
- The Scottish Charity Register (Office of the Scottish Charity Register) shared under the Open Government Licence (v2.0)
- Scottish Postcode Directory (National Records of Scotland) shared under the Open Government Licence (v3.0)
- Contributions by ALISS users
API Version 4.1
Service search
curl "https://www.aliss.org/api/v4/services/?postcode=G2 4AA"
The above command returns JSON structured like this:
{
meta: {
licence: "https://creativecommons.org/licenses/by/4.0/",
attribution: [
{
text: "Contains National Statistics data © Crown copyright and database right 2018",
url: "http://geoportal.statistics.gov.uk/datasets/local-authority-districts-december-2016-generalised-clipped-boundaries-in-the-uk/"
},
{
text: "Contains information from the Scottish Charity Register supplied by the Office of the Scottish Charity Regulator and licensed under the Open Government Licence v2.0",
url: "https://www.oscr.org.uk/about-charities/search-the-register/charity-register-download"
},
{
text: "Contains National Records of Scotland data licensed under the Open Government Licence v3.0",
url: "https://www.nrscotland.gov.uk/statistics-and-data/geography/nrs-postcode-extract"
},
{
text: "Contains contributions from ALISS users",
url: "https://www.aliss.org/terms-and-conditions"
}
]
},
count: 5179,
next: "https://www.aliss.org/api/v4/import/?format=json&page=2",
previous: null,
data: [
{
id: "374ca73b-eea4-45ea-9694-70866b419107",
name: "Hill Walking Group",
description: "Walks are generally every Saturday starting at 9:00 am unless otherwise indicated. New members will be welcomed. Walkers should be suitably attired for the intended walk and the likely weather. They must bring refreshments for short breaks and lunch e.g. sandwiches, fruit, tea, coffee, water, etc. The destinations/routes/start-point/time may be changed at short notice to suit the weather conditions or other factors. ‘A’ walks will generally include off-road, sometimes boggy ground and may entail serious hill climbing. Appropriate footwear is essential and the use of poles is recommended. Where possible a less strenuous 'B' option will be available.",
url: "http://oirlargs.org.uk/groups/hill-walking",
phone: "",
email: "",
categories: [
{
name: "Outdoor Pursuits",
slug: "outdoor-pursuits"
},
{
name: "Social Group",
slug: "social-group"
}
],
service_areas: [ ],
organisation: {
id: "c9332c5d-7201-4f59-9565-3136a25b1f9e",
name: "Opportunities In Retirement - Largs (OIR Largs)",
aliss_url: "https://www.aliss.org/organisations/opportunities-in-retirement-largs-oir-largs-0/",
permalink: "https://www.aliss.org/organisations/c9332c5d-7201-4f59-9565-3136a25b1f9e",
is_claimed: false,
slug: "opportunities-in-retirement-largs-oir-largs-0"
},
slug: "hill-walking-group-0",
aliss_url: "https://www.aliss.org/services/hill-walking-group-0/",
permalink: "https://www.aliss.org/services/374ca73b-eea4-45ea-9694-70866b419107",
last_updated: "2018-09-17T16:22:54.422356+00:00",
locations: [
{
id: "5cefe814-bd7c-447f-a026-2c599b41e701",
formatted_address: "(Meeting Point) Vikingar Car Park, 40 Greenock Road, Largs, KA30 8QL",
name: "(Meeting Point) Vikingar Car Park",
description: "",
street_address: "40 Greenock Road",
locality: "Largs",
region: "",
state: "",
postal_code: "KA30 8QL",
country: "GB",
latitude: 55.8000707,
longitude: -4.870146
}
]
},
{
id: "fabd1211-133a-4872-b0c7-27dd20899274",
name: "LGBT Basketball Group",
description: "LGBT Basketball Group is a friendly and informal weekly group for LGBTQI beginners and regular players alike. We welcome the entire diversity of the LGBTQI community and any supporters they wish to bring. You must be 16+ to come along. The sessions entail: · A short warm up with the basketballs upon arrival · A short introductory session with players sharing their names and pronouns · Upon request, a few drills of dribbling and shooting · As many short games of basketball with interval rest as we can manage! What we provide: - Bottled water - First aid kit - Basketball balls - Bibs The sessions are open to all levels of fitness and are fun, competitive but relaxed. We encourage a ‘have a go’ atmosphere for beginners or new players whilst allowing for skill and confidence development for regulars.",
url: "https://www.facebook.com/groups/lgbtbasketball/about/",
phone: "",
email: "LGBTbasketballedinburgh@gmail.com",
categories: [
{
name: "Sports & Games",
slug: "sports-games"
},
{
name: "Physical Activity",
slug: "physical-activity"
}
],
service_areas: [ ],
organisation: {
id: "5c3d474a-15f1-424a-957b-cc3447e934a9",
name: "LGBT Basketball Edinburgh",
aliss_url: "https://www.aliss.org/organisations/lgbt-basketball-edinburgh-0/",
permalink: "https://www.aliss.org/organisations/5c3d474a-15f1-424a-957b-cc3447e934a9",
is_claimed: false,
slug: "lgbt-basketball-edinburgh-0"
},
slug: "lgbt-basketball-group-0",
aliss_url: "https://www.aliss.org/services/lgbt-basketball-group-0/",
permalink: "https://www.aliss.org/services/fabd1211-133a-4872-b0c7-27dd20899274",
last_updated: "2018-09-17T16:22:55.077560+00:00",
locations: [
{
id: "d531e2b0-98b0-471b-907a-91438dab9351",
formatted_address: "Leith Community Education Centre, 12A New Kirkgate, Edinburgh, EH6 6AD",
name: "Leith Community Education Centre",
description: "",
street_address: "12A New Kirkgate",
locality: "Edinburgh",
region: "",
state: "",
postal_code: "EH6 6AD",
country: "GB",
latitude: 55.9715666,
longitude: -3.1713024
}
]
},
{
id: "0a33875c-4558-4ba3-9b2f-bbff748f8ad4",
name: "Group Dog Walks",
description: "This group is for their owners looking to socialise their pooch on friendly & fun group walks. Walks are in dog friendly environments where you and your dog gets time to socialise (off the lead) with other dog owners and other dogs in different and fun places. Long and short walks in various places, making new friends who understand commitments of owning a dog and still getting some social time out! All members must have a dog to join this group [Please be aware, due to running costs a yearly donation (£5) would be very much appreciated, but not before you have come along to at least a couple of walks to make sure this is the group for you and get an appreciation of what is on offer. Any excess funds will be donated to dog charities]",
url: "https://www.meetup.com/Edinburgh-Puppy-Dog-Group/",
phone: "",
email: "",
categories: [
{
name: "Outdoor Pursuits",
slug: "outdoor-pursuits"
},
{
name: "Social Group",
slug: "social-group"
}
],
service_areas: [
{
code: "S12000036",
type: "Local Authority",
name: "City of Edinburgh"
}
],
organisation: {
id: "17cb7df7-b87d-44bc-a823-f688d3f78f7d",
name: "The Edinburgh Puppy & Dog Meetup Group",
aliss_url: "https://www.aliss.org/organisations/the-edinburgh-puppy-dog-meetup-group-0/",
permalink: "https://www.aliss.org/organisations/17cb7df7-b87d-44bc-a823-f688d3f78f7d",
is_claimed: false,
slug: "the-edinburgh-puppy-dog-meetup-group-0"
},
slug: "group-dog-walks-0",
aliss_url: "https://www.aliss.org/services/group-dog-walks-0/",
permalink: "https://www.aliss.org/services/0a33875c-4558-4ba3-9b2f-bbff748f8ad4",
last_updated: "2018-09-17T16:22:55.132779+00:00",
locations: [ ]
},
{
id: "293724cf-3d8c-4d19-928c-7a76ebc58897",
name: "Group Support",
description: "Drumchapel Women’s Aid provides confidential, non-judgmental support to those who are experiencing domestic abuse including group peer support to help break isolation; build social networks and provide support clients regain control of their lives.",
url: "https://drumchapelwomensaid.com/womens-aid-can-help/",
phone: "0141 944 0201",
email: "drumwomen@btconnect.com",
categories: [
{
name: "Peer Support",
slug: "peer-support"
},
{
name: "Support Group",
slug: "support-group"
}
],
service_areas: [ ],
organisation: {
id: "91529328-ce27-4827-bcb0-c3d5a2ced7f2",
name: "Drumchapel Women's Aid",
aliss_url: "https://www.aliss.org/organisations/drumchapel-womens-aid-0/",
permalink: "https://www.aliss.org/organisations/91529328-ce27-4827-bcb0-c3d5a2ced7f2",
is_claimed: false,
slug: "drumchapel-womens-aid-0"
},
slug: "group-support-1",
aliss_url: "https://www.aliss.org/services/group-support-1/",
permalink: "https://www.aliss.org/services/293724cf-3d8c-4d19-928c-7a76ebc58897",
last_updated: "2018-09-17T16:22:56.020996+00:00",
locations: [
{
id: "7043e55a-9724-40ab-8139-3688e349e87a",
formatted_address: "8 Essenside Avenue, Glasgow, G15 6DX",
name: "",
description: "",
street_address: "8 Essenside Avenue",
locality: "Glasgow",
region: "",
state: "",
postal_code: "G15 6DX",
country: "GB",
latitude: 55.9068055,
longitude: -4.3515146
}
]
},
{
id: "d48c6a07-aa83-46f4-b35b-5adfa7ce9856",
name: "Trans Masculine Support Group",
description: "Trans Masculine Scotland is a support group run by and for the trans masculine community. We welcome all trans masculine (including non binary) folks aged 16+ who were assigned female at birth or socialised as female. Our monthly meetings currently alternate between Edinburgh and Glasgow but we also participate in events and discussions throughout the country.",
url: "https://www.facebook.com/transmasculinescotland/",
phone: "",
email: "transmasculinescotland@gmail.com",
categories: [
{
name: "LGBT Health",
slug: "lgbt-health"
},
{
name: "Support Network",
slug: "support-network"
},
{
name: "Support Group",
slug: "support-group"
}
],
service_areas: [
{
code: "S12000036",
type: "Local Authority",
name: "City of Edinburgh"
},
{
code: "S12000046",
type: "Local Authority",
name: "Glasgow City"
}
],
organisation: {
id: "40c6bfea-e67e-49a3-98b4-e3d8f2217ba4",
name: "Trans Masculine Scotland",
aliss_url: "https://www.aliss.org/organisations/trans-masculine-scotland-0/",
permalink: "https://www.aliss.org/organisations/40c6bfea-e67e-49a3-98b4-e3d8f2217ba4",
is_claimed: false,
slug: "trans-masculine-scotland-0"
},
slug: "trans-masculine-support-group-0",
aliss_url: "https://www.aliss.org/services/trans-masculine-support-group-0/",
permalink: "https://www.aliss.org/services/d48c6a07-aa83-46f4-b35b-5adfa7ce9856",
last_updated: "2018-09-17T16:22:56.075262+00:00",
locations: [ ]
},
{
id: "f8c19282-9c99-4597-bc1d-f4dbb2a8d95d",
name: "Swimming Pool",
description: "20m x 4 lane pool. Public Swimming, Adult Lessons, Pre-school lessons available. Timetable can be viewed on our website.",
url: "https://www.livelifeaberdeenshire.org.uk/sport-and-physical-activity/timetables/banchory-swimming-pool-and-sports-centre/",
phone: "01330 700363",
email: "banchory.sportscentre@aberdeenshire.gov.uk",
categories: [
{
name: "Sports & Games",
slug: "sports-games"
},
{
name: "Exercise & Get Fit",
slug: "exercise-get-fit"
}
],
service_areas: [ ],
organisation: {
id: "afb6f92a-5e0a-4bce-8d25-2e9649848da6",
name: "Banchory Sports Centre and Swimming Pool",
aliss_url: "https://www.aliss.org/organisations/banchory-sports-centre-and-swimming-pool-0/",
permalink: "https://www.aliss.org/organisations/afb6f92a-5e0a-4bce-8d25-2e9649848da6",
is_claimed: false,
slug: "banchory-sports-centre-and-swimming-pool-0"
},
slug: "swimming-pool-41",
aliss_url: "https://www.aliss.org/services/swimming-pool-41/",
permalink: "https://www.aliss.org/services/f8c19282-9c99-4597-bc1d-f4dbb2a8d95d",
last_updated: "2019-06-03T09:04:24.534171+00:00",
locations: [
{
id: "e02723f8-5011-41ef-a040-eefbbe0c6777",
formatted_address: "Banchory Sports Centre and Swimming Pool, Raemoir Road, Banchory, AB31 5XP",
name: "Banchory Sports Centre and Swimming Pool",
description: "",
street_address: "Raemoir Road",
locality: "Banchory",
region: "",
state: "",
postal_code: "AB31 5XP",
country: "GB",
latitude: 57.0590924,
longitude: -2.4928641
}
]
}
The service search feature is the core of ALISS. Search returns services on ALISS filtered by geography, and optionally by keywords or categories.
Services can be delivered at a specific location, or they can be delivered across a whole area or areas. Locations are specific to the organisations that run the services, whereas areas of delivery are selected from a pre-defined list. You can request the list of possible areas from the service-areas endpoint.
HTTP Request
GET https://www.aliss.org/api/v4/services/
You can request an HTML formatted version of the result with your browser: https://www.aliss.org/api/v4/services/?postcode=G2 4AA
Query parameters
| Parameter | Required | Default | Description |
|---|---|---|---|
| postcode | True | None | The postcode that you wish to find services relevant to |
| q | False | None | This is the keywords with which to do a full text search of the services |
| category | False | None | The category slugs that you wish to filter the search by |
| location_type | False | None | The location type of the resource, either 'local' or 'national', default searches everything |
| radius | False | 5000 | The radius from the postcode that you wish the search to cover, in meters |
| page_size | False | 10 | The number of results in a page (max. 100) |
Filter by categories
GET https://www.aliss.org/api/v4/services/?category=money-advice&postcode=G2 4AA
You can filter by category by using the category query parameter and passing in a category slug.
Filter by location type
GET https://www.aliss.org/api/v4/services/?location_type=local&postcode=G2 4AA
You can filter by location type by using the location type query parameter and passing in either 'local' or 'national'.
Response structure
| Key | Description |
|---|---|
| meta | metadata associated with the result |
| count | number of results returned in all pages of the request |
| next | url to next page |
| previous | url to previous page |
| data | collection of service objects (see below) |
Service object
| Key | Description |
|---|---|
| id | UUID for the service |
| name | name of the service |
| organisation.id | object with details of the organisation that runs the service |
| organisation.name | name of the organisation |
| organisation.permalink | url to the organisation entry on aliss.org |
| organisation.aliss_url | human friendly url to the organisation entry on aliss.org |
| organisation.is_claimed | whether a representative of the organisation has claimed editorial privelege over the entry |
| description | free text description of the service |
| url | url to a site describing the service |
| phone | contact telephone number for the service |
| contact email address for the service | |
| categories | collection of category objects associated with the service including a human readable name and slug |
| locations | collection of location objects associated with the service |
| service_areas | collection of service area objects associated with the service, a full list of possible areas can be requested from the service areas endpoint |
| permalink | url to the service entry on aliss.org |
| aliss_url | human friendly url to the service entry on aliss.org |
| last_updated | timestamp (ISO 8601) of when the service entry was last edited |
Service
Retrieve a single service
curl "https://www.aliss.org/api/v4/services/<service_id_or_slug>"
The above command returns JSON structured like this:
{
"meta": {
"licence": "https://creativecommons.org/licenses/by/4.0/",
"attribution": [
{
"text": "Contains National Statistics data © Crown copyright and database right 2018",
"url": "http://geoportal.statistics.gov.uk/datasets/local-authority-districts-december-2016-generalised-clipped-boundaries-in-the-uk/"
},
{
"text": "Contains information from the Scottish Charity Register supplied by the Office of the Scottish Charity Regulator and licensed under the Open Government Licence v2.0",
"url": "https://www.oscr.org.uk/about-charities/search-the-register/charity-register-download"
},
{
"text": "Contains National Records of Scotland data licensed under the Open Government Licence v3.0",
"url": "https://www.nrscotland.gov.uk/statistics-and-data/geography/nrs-postcode-extract"
},
{
"text": "Contains contributions from ALISS users",
"url": "https://www.aliss.org/terms-and-conditions"
}
]
},
"data": {
"id": "4b5eaf69-b5dc-4aea-9970-42fa3b590b91",
"name": "Leitholm Soup Social",
"description": "Leitholm Soup Social offers a healthy soup and sandwich, companionship and endless cups of teas/coffees. Pay as much as you feel!\r\nEvery Thursday from 12-2pm. (From the first week of October to the last week of April)",
"url": "",
"phone": "01835825080",
"email": "communitycapacity@scotborders.gov.uk",
"categories": [
{
"name": "Social Group",
"slug": "social-group"
},
{
"name": "Lunch Club",
"slug": "lunch-club"
}
],
"service_areas": [],
"organisation": {
"id": "24e42647-da5f-46ec-b0c6-458465d2467d",
"name": "SBC Community Capacity Building",
"aliss_url": "https://www.aliss.org/organisations/sbc-community-capacity-building-0/",
"permalink": "https://www.aliss.org/organisations/24e42647-da5f-46ec-b0c6-458465d2467d",
"is_claimed": false,
"slug": "sbc-community-capacity-building-0"
},
"slug": "leitholm-soup-social-1",
"aliss_url": "https://www.aliss.org/services/leitholm-soup-social-1/",
"permalink": "https://www.aliss.org/services/4b5eaf69-b5dc-4aea-9970-42fa3b590b91",
"last_updated": "2018-12-20T14:45:51.344207Z",
"locations": [
{
"id": "8ff3c1ea-ee06-4c2a-a7f1-a8b8bf9169b5",
"formatted_address": "the Plough Inn, Main Street, Leitholm, TD12 4JN",
"name": "the Plough Inn",
"description": "",
"street_address": "Main Street",
"locality": "Leitholm",
"region": "",
"state": "",
"postal_code": "TD12 4JN",
"country": "GB",
"latitude": 55.6907691,
"longitude": -2.3346439
}
]
}
}
This endpoint retrieves a single service resource.
HTTP Request
GET https://www.aliss.org/api/v4/services/<service_id_or_slug>
You can view an HTML formatted version of the result if you view the endpoint in your browser eg: https://www.aliss.org/api/v4/services/4b5eaf69-b5dc-4aea-9970-42fa3b590b91
Response structure
See service object.
Organisation
Retrieve a single organisation
curl "https://www.aliss.org/api/v4/organisations/<organisation_id_or_slug>"
The above command returns JSON structured like this:
{
"meta": {
"licence": "https://creativecommons.org/licenses/by/4.0/",
"attribution": [
{
"text": "Contains National Statistics data © Crown copyright and database right 2018",
"url": "http://geoportal.statistics.gov.uk/datasets/local-authority-districts-december-2016-generalised-clipped-boundaries-in-the-uk/"
},
{
"text": "Contains information from the Scottish Charity Register supplied by the Office of the Scottish Charity Regulator and licensed under the Open Government Licence v2.0",
"url": "https://www.oscr.org.uk/about-charities/search-the-register/charity-register-download"
},
{
"text": "Contains National Records of Scotland data licensed under the Open Government Licence v3.0",
"url": "https://www.nrscotland.gov.uk/statistics-and-data/geography/nrs-postcode-extract"
},
{
"text": "Contains contributions from ALISS users",
"url": "https://www.aliss.org/terms-and-conditions"
}
]
},
"data": {
"id": "24e42647-da5f-46ec-b0c6-458465d2467d",
"name": "SBC Community Capacity Building",
"aliss_url": "https://www.aliss.org/organisations/sbc-community-capacity-building-0/",
"permalink": "https://www.aliss.org/organisations/24e42647-da5f-46ec-b0c6-458465d2467d",
"is_claimed": false,
"slug": "sbc-community-capacity-building-0",
"description": "The aim of the Community Capacity Building team is to actively\r\nfoster and encourage the development of resilience within\r\ncommunities to allow them to become stronger and more\r\nself-reliant through offering the right support at the right time",
"facebook": "https://www.facebook.com/SBC-Community-Capacity-Building-379248189076883/",
"twitter": "",
"url": "",
"phone": "01835825080",
"email": "communitycapacity@scotborders.gov.uk",
"last_edited": "2018-11-23T09:28:38.946621Z",
"services": [
{
"id": "9fd62ed3-b6a3-46dd-8712-8727f7ff9012",
"name": "Community Capacity Building Link Worker Service",
"description": "The CCB Link Worker Service offers one to one enablement support for older people or adults with long-term conditions - this service is available in Berwickshire.",
"url": "",
"phone": "07917 277 139",
"email": "juliana.amaral@scotborder.gov.uk",
"categories": [
{
"name": "Food & Nutrition",
"slug": "food-nutrition"
},
{
"name": "Conditions",
"slug": "conditions"
},
{
"name": "Health & Social Care Services",
"slug": "health-social-care-services"
},
{
"name": "Activity",
"slug": "activity"
}
],
"service_areas": [
{
"code": "S37000025",
"type": "4",
"name": "Scottish Borders"
}
]
},
{
"id": "46237477-2831-4d8a-a78b-0069efbbb316",
"name": "Writing for Wellbeing",
"description": "A great way to use writing for self-expression in a creative way. The group meets every first Monday of the month from 2-4:30pm, £2 per person which includes tea/coffee and biscuits.",
"url": "",
"phone": "",
"email": "",
"categories": [
{
"name": "Literature",
"slug": "literature"
},
{
"name": "Social Group",
"slug": "social-group"
}
],
"service_areas": []
},
{
"id": "b32712a9-844c-4354-809c-ad3ad1c9d30e",
"name": "Duns Tea Dance",
"description": "A Tea Dance is an afternoon social dance with music, tea and cake. It is a great way to move, meet people and have fun! Every second Wednesday of every month from 2-4pm, £3/ person includes refreshments and cake/scones. Everyone welcome.",
"url": "",
"phone": "",
"email": "",
"categories": [
{
"name": "Social Group",
"slug": "social-group"
}
],
"service_areas": []
}
]
}
}
This endpoint retrieves a single organisation resource.
HTTP Request
GET https://www.aliss.org/api/v4/organisations/<organisation_id_or_slug>
You can view an HTML formatted version of the result if you view the endpoint in your browser eg: https://www.aliss.org/api/v4/organisations/24e42647-da5f-46ec-b0c6-458465d2467d
Categories
List all Categories
curl "https://www.aliss.org/api/v4/categories/"
The above command returns JSON structured like this:
{
"meta": {
"attribution": [],
"licence": "https://creativecommons.org/licenses/by/4.0/"
},
"data": [
{
"name": "Housing and Homelessness",
"slug": "housing-and-homelessness",
"sub_categories": [
{
"name": "Social Housing",
"slug": "social-housing",
"sub_categories": []
},
{
"name": "Sheltered Housing",
"slug": "sheltered-housing",
"sub_categories": []
},
{
"name": "Housing Advice",
"slug": "housing-advice",
"sub_categories": []
},
{
"name": "Housing Support",
"slug": "housing-support",
"sub_categories": []
},
{
"name": "Housing Adaptations",
"slug": "housing-adaptations",
"sub_categories": []
}
]
},
{
"name": "Food & Nutrition",
"slug": "food-nutrition",
"sub_categories": [
{
"name": "Community Garden",
"slug": "community-garden",
"sub_categories": []
},
{
"name": "Food Delivery",
"slug": "food-delivery",
"sub_categories": []
},
{
"name": "Foodbank",
"slug": "foodbank",
"sub_categories": []
},
{
"name": "Free Meals",
"slug": "free-meals",
"sub_categories": []
},
{
"name": "Community Cafe",
"slug": "community-cafe",
"sub_categories": []
}
]
},
{
"name": "Money",
"slug": "money",
"sub_categories": [
{
"name": "Money Advice",
"slug": "money-advice",
"sub_categories": []
},
{
"name": "Energy Advice",
"slug": "energy-advice",
"sub_categories": []
}
]
}
]
}
This endpoint retrieves all categories.
HTTP Request
GET https://www.aliss.org/api/v4/categories/
You can view an HTML formatted version of the result with your browser: https://www.aliss.org/api/v4/categories/
Service areas
List all Service areas
curl "https://www.aliss.org/api/v4/service-areas/"
The above command returns JSON structured like this:
{
"meta": {
"attribution": [
{
"text": "Contains National Statistics data © Crown copyright and database right 2018",
"url": "http://geoportal.statistics.gov.uk/datasets/local-authority-districts-december-2016-generalised-clipped-boundaries-in-the-uk/"
},
{
"text": "Contains information from the Scottish Charity Register supplied by the Office of the Scottish Charity Regulator and licensed under the Open Government Licence v2.0",
"url": "https://www.oscr.org.uk/about-charities/search-the-register/charity-register-download"
}
],
"licence": "https://creativecommons.org/licenses/by/4.0/"
},
"data": [
{
"code": "S12000005",
"type": "Local Authority",
"name": "Clackmannanshire"
},
{
"code": "S12000006",
"type": "Local Authority",
"name": "Dumfries and Galloway"
},
{
"code": "S12000008",
"type": "Local Authority",
"name": "East Ayrshire"
},
{
"code": "S12000010",
"type": "Local Authority",
"name": "East Lothian"
},
{
"code": "S12000011",
"type": "Local Authority",
"name": "East Renfrewshire"
},
{
"code": "S12000013",
"type": "Local Authority",
"name": "Na h-Eileanan Siar"
},
{
"code": "S12000014",
"type": "Local Authority",
"name": "Falkirk"
},
{
"code": "S12000015",
"type": "Local Authority",
"name": "Fife"
}
]
}
This endpoint retrieves all service areas. An HTML formatted version of the result is available here: http://www.aliss.org/api/v4/service-areas/
HTTP Request
GET https://www.aliss.org/api/v4/service-areas/
You can view an HTML formatted version of the result with your browser: https://www.aliss.org/api/v4/service-areas/
Changes since v4
The main difference between v4 and v4.1 is that the API is the same as the search API, there is a new api endpoint that takes no parameters (postcode) and returns all records
HTTP Import
GET https://www.aliss.org/api/v4/import/
This is endpoint returns all services in json format.
API Version 4
Service search
curl "https://www.aliss.org/api/v4/services/?postcode=G2 4AA"
The above command returns JSON structured like this:
{
"meta": {
"licence": "https://creativecommons.org/licenses/by/4.0/",
"attribution": [
{
"text": "Contains National Statistics data © Crown copyright and database right 2018",
"url": "http://geoportal.statistics.gov.uk/datasets/local-authority-districts-december-2016-generalised-clipped-boundaries-in-the-uk/"
},
{
"text": "Contains information from the Scottish Charity Register supplied by the Office of the Scottish Charity Regulator and licensed under the Open Government Licence v2.0",
"url": "https://www.oscr.org.uk/about-charities/search-the-register/charity-register-download"
},
{
"text": "Contains National Records of Scotland data licensed under the Open Government Licence v3.0",
"url": "https://www.nrscotland.gov.uk/statistics-and-data/geography/nrs-postcode-extract"
},
{
"text": "Contains contributions from ALISS users",
"url": "https://www.aliss.org/terms-and-conditions"
}
]
},
"count": 534,
"next": "https://www.aliss.org/api/v4/services/?page=2&postcode=G2+4AA",
"previous": null,
"data": [
{
"id": "3da126c1-44b4-4095-a1d1-db21787d0b6a",
"organisation": {
"id": "abd47d4d-1ece-4c38-981e-4ccba17013cf",
"name": "Loaves and Fishes",
"aliss_url": "https://www.aliss.org/organisations/loaves-and-fishes-0/",
"permalink": "https://www.aliss.org/organisations/abd47d4d-1ece-4c38-981e-4ccba17013cf",
"is_claimed": false,
"slug": "loaves-and-fishes-0"
},
"name": "Food Parcels",
"description": "Every Thursday night we distribute food parcels to the people who come to our meal. We also distribute the food parcels directly to the people in need that we hear about through our various contacts. We distribute food parcels through social work departments who rely on us to support the people they help.",
"slug": "food-parcels-1",
"url": "http://www.loavesandfishes.org.uk/contact.htm",
"phone": "01355 224 375",
"email": "enquiries@loavesandfishes.org.uk",
"categories": [
{
"name": "Food & Nutrition",
"slug": "food-nutrition"
},
{
"name": "Foodbank",
"slug": "foodbank"
}
],
"locations": [
{
"id": "c8b7db71-f879-47f9-b4e0-ce593d839628",
"formatted_address": "Renfield St Stephens Centre, 260 Bath Street, Glasgow, G2 4JP",
"name": "Renfield St Stephens Centre",
"description": "",
"street_address": "260 Bath Street",
"locality": "Glasgow",
"region": "",
"state": "",
"postal_code": "G2 4JP",
"country": "GB",
"latitude": 55.8652885,
"longitude": -4.2672764
}
],
"service_areas": [],
"aliss_url": "https://www.aliss.org/services/food-parcels-1/",
"permalink": "https://www.aliss.org/services/3da126c1-44b4-4095-a1d1-db21787d0b6a",
"last_updated": "2018-09-17T16:22:50.910751+00:00"
},
{
"id": "68c6347c-e069-4c7e-b762-a41126280faf",
"organisation": {
"id": "abd47d4d-1ece-4c38-981e-4ccba17013cf",
"name": "Loaves and Fishes",
"aliss_url": "https://www.aliss.org/organisations/loaves-and-fishes-0/",
"permalink": "https://www.aliss.org/organisations/abd47d4d-1ece-4c38-981e-4ccba17013cf",
"is_claimed": false,
"slug": "loaves-and-fishes-0"
},
"name": "Providing Meals",
"description": "Each Monday and Thursday evening we provide a sit down, hot meal for around 40 men and women at the Oasis café in Renfield St Stephen’s Church Centre. It may be the only proper meal some of them get. We’ve been providing a sit down meals service for almost ten years and we truly believe that this is a far more beneficial service as it provides a safe, relaxing environment to enjoy the food and the company of others.",
"slug": "providing-meals-0",
"url": "http://www.loavesandfishes.org.uk/providing-meals.htm",
"phone": "01355 224 375",
"email": "enquiries@loavesandfishes.org.uk",
"categories": [
{
"name": "Food & Nutrition",
"slug": "food-nutrition"
},
{
"name": "Free Meals",
"slug": "free-meals"
}
],
"locations": [
{
"id": "c8b7db71-f879-47f9-b4e0-ce593d839628",
"formatted_address": "Renfield St Stephens Centre, 260 Bath Street, Glasgow, G2 4JP",
"name": "Renfield St Stephens Centre",
"description": "",
"street_address": "260 Bath Street",
"locality": "Glasgow",
"region": "",
"state": "",
"postal_code": "G2 4JP",
"country": "GB",
"latitude": 55.8652885,
"longitude": -4.2672764
}
],
"service_areas": [],
"aliss_url": "https://www.aliss.org/services/providing-meals-0/",
"permalink": "https://www.aliss.org/services/68c6347c-e069-4c7e-b762-a41126280faf",
"last_updated": "2018-09-17T16:22:50.582230+00:00"
},
{
"id": "fed34ae8-cf8b-4d6d-9250-6a7d56809d8d",
"organisation": {
"id": "0e5d57d2-2e3d-4538-9c4f-d72770d608a7",
"name": "CrossReach",
"aliss_url": "https://www.aliss.org/organisations/crossreach-0/",
"permalink": "https://www.aliss.org/organisations/0e5d57d2-2e3d-4538-9c4f-d72770d608a7",
"is_claimed": false,
"slug": "crossreach-0"
},
"name": "One-to-one counselling",
"description": "Sometimes we experience difficulties and may or may not know why we feel uneasy, anxious or depressed. Counselling provides the chance to explore feelings and experiences in a safe and confidential environment with someone who is trained to help you.\r\n\r\nThe counsellor won’t give you advice or tell you what to do. They will give you time, space and their particular skills to help you work toward a more satisfactory life.",
"slug": "one-to-one-counselling-2",
"url": "http://www.crossreach.org.uk/one-one-counselling",
"phone": "0141 221 1535",
"email": "tomallan@crossreach.org.uk",
"categories": [
{
"name": "Mental Health Issues",
"slug": "mental-health"
},
{
"name": "Counselling",
"slug": "counselling"
}
],
"locations": [
{
"id": "619d32db-e780-44ab-8ed2-5180c56fc1c3",
"formatted_address": "Tom Allan Centre, 23 Elmbank Street, Glasgow, G2 4PB",
"name": "Tom Allan Centre",
"description": "",
"street_address": "23 Elmbank Street",
"locality": "Glasgow",
"region": "",
"state": "",
"postal_code": "G2 4PB",
"country": "GB",
"latitude": 55.8639028,
"longitude": -4.2685076
}
],
"service_areas": [
{
"code": "S12000046",
"type": "Local Authority",
"name": "Glasgow City"
}
],
"aliss_url": "https://www.aliss.org/services/one-to-one-counselling-2/",
"permalink": "https://www.aliss.org/services/fed34ae8-cf8b-4d6d-9250-6a7d56809d8d",
"last_updated": "2018-09-17T16:22:47.106955+00:00"
},
{
"id": "1615ffd3-2fa4-4b5f-90bc-3586cb99a552",
"organisation": {
"id": "0e5d57d2-2e3d-4538-9c4f-d72770d608a7",
"name": "CrossReach",
"aliss_url": "https://www.aliss.org/organisations/crossreach-0/",
"permalink": "https://www.aliss.org/organisations/0e5d57d2-2e3d-4538-9c4f-d72770d608a7",
"is_claimed": false,
"slug": "crossreach-0"
},
"name": "Bluebell-PND- Counselling Service",
"description": "Bluebell Perinatal Depression Counselling Service is a specialist Postnatal Depression Service for depression which begins in pregnancy or shortly after birth.",
"slug": "bluebell-pnd-counselling-service-0",
"url": "https://www.crossreach.org.uk/our-locations/crossreach-bluebell-perinatal-service",
"phone": "0141 221 3003",
"email": "bluebell@crossreach.org.uk",
"categories": [
{
"name": "Counselling",
"slug": "counselling"
},
{
"name": "Depression",
"slug": "depression"
},
{
"name": "Parent & Family Support",
"slug": "parent-family-support"
}
],
"locations": [
{
"id": "619d32db-e780-44ab-8ed2-5180c56fc1c3",
"formatted_address": "Tom Allan Centre, 23 Elmbank Street, Glasgow, G2 4PB",
"name": "Tom Allan Centre",
"description": "",
"street_address": "23 Elmbank Street",
"locality": "Glasgow",
"region": "",
"state": "",
"postal_code": "G2 4PB",
"country": "GB",
"latitude": 55.8639028,
"longitude": -4.2685076
}
],
"service_areas": [],
"aliss_url": "https://www.aliss.org/services/bluebell-pnd-counselling-service-0/",
"permalink": "https://www.aliss.org/services/1615ffd3-2fa4-4b5f-90bc-3586cb99a552",
"last_updated": "2018-10-25T08:27:31.354698+00:00"
}
]
}
The service search feature is the core of ALISS. Search returns services on ALISS filtered by geography, and optionally by keywords or categories.
Services can be delivered at a specific location, or they can be delivered across a whole area or areas. Locations are specific to the organisations that run the services, whereas areas of delivery are selected from a pre-defined list. You can request the list of possible areas from the service-areas endpoint.
HTTP Request
GET https://www.aliss.org/api/v4/services/
You can request an HTML formatted version of the result with your browser: https://www.aliss.org/api/v4/services/?postcode=G2 4AA
Query parameters
| Parameter | Required | Default | Description |
|---|---|---|---|
| postcode | True | None | The postcode that you wish to find services relevant to |
| q | False | None | This is the keywords with which to do a full text search of the services |
| category | False | None | The category slugs that you wish to filter the search by |
| location_type | False | None | The location type of the resource, either 'local' or 'national', default searches everything |
| radius | False | 5000 | The radius from the postcode that you wish the search to cover, in meters |
| page_size | False | 10 | The number of results in a page (max. 100) |
Filter by categories
GET https://www.aliss.org/api/v4/services/?category=money-advice&postcode=G2 4AA
You can filter by category by using the category query parameter and passing in a category slug.
Filter by location type
GET https://www.aliss.org/api/v4/services/?location_type=local&postcode=G2 4AA
You can filter by location type by using the location type query parameter and passing in either 'local' or 'national'.
Response structure
| Key | Description |
|---|---|
| meta | metadata associated with the result |
| count | number of results returned in all pages of the request |
| next | url to next page |
| previous | url to previous page |
| data | collection of service objects (see below) |
Service object
| Key | Description |
|---|---|
| id | UUID for the service |
| name | name of the service |
| organisation.id | object with details of the organisation that runs the service |
| organisation.name | name of the organisation |
| organisation.permalink | url to the organisation entry on aliss.org |
| organisation.aliss_url | human friendly url to the organisation entry on aliss.org |
| organisation.is_claimed | whether a representative of the organisation has claimed editorial privelege over the entry |
| description | free text description of the service |
| url | url to a site describing the service |
| phone | contact telephone number for the service |
| contact email address for the service | |
| categories | collection of category objects associated with the service including a human readable name and slug |
| locations | collection of location objects associated with the service |
| service_areas | collection of service area objects associated with the service, a full list of possible areas can be requested from the service areas endpoint |
| permalink | url to the service entry on aliss.org |
| aliss_url | human friendly url to the service entry on aliss.org |
| last_updated | timestamp (ISO 8601) of when the service entry was last edited |
Service
Retrieve a single service
curl "https://www.aliss.org/api/v4/services/<service_id_or_slug>"
The above command returns JSON structured like this:
{
"meta": {
"licence": "https://creativecommons.org/licenses/by/4.0/",
"attribution": [
{
"text": "Contains National Statistics data © Crown copyright and database right 2018",
"url": "http://geoportal.statistics.gov.uk/datasets/local-authority-districts-december-2016-generalised-clipped-boundaries-in-the-uk/"
},
{
"text": "Contains information from the Scottish Charity Register supplied by the Office of the Scottish Charity Regulator and licensed under the Open Government Licence v2.0",
"url": "https://www.oscr.org.uk/about-charities/search-the-register/charity-register-download"
},
{
"text": "Contains National Records of Scotland data licensed under the Open Government Licence v3.0",
"url": "https://www.nrscotland.gov.uk/statistics-and-data/geography/nrs-postcode-extract"
},
{
"text": "Contains contributions from ALISS users",
"url": "https://www.aliss.org/terms-and-conditions"
}
]
},
"data": {
"id": "4b5eaf69-b5dc-4aea-9970-42fa3b590b91",
"name": "Leitholm Soup Social",
"description": "Leitholm Soup Social offers a healthy soup and sandwich, companionship and endless cups of teas/coffees. Pay as much as you feel!\r\nEvery Thursday from 12-2pm. (From the first week of October to the last week of April)",
"url": "",
"phone": "01835825080",
"email": "communitycapacity@scotborders.gov.uk",
"categories": [
{
"name": "Social Group",
"slug": "social-group"
},
{
"name": "Lunch Club",
"slug": "lunch-club"
}
],
"service_areas": [],
"organisation": {
"id": "24e42647-da5f-46ec-b0c6-458465d2467d",
"name": "SBC Community Capacity Building",
"aliss_url": "https://www.aliss.org/organisations/sbc-community-capacity-building-0/",
"permalink": "https://www.aliss.org/organisations/24e42647-da5f-46ec-b0c6-458465d2467d",
"is_claimed": false,
"slug": "sbc-community-capacity-building-0"
},
"slug": "leitholm-soup-social-1",
"aliss_url": "https://www.aliss.org/services/leitholm-soup-social-1/",
"permalink": "https://www.aliss.org/services/4b5eaf69-b5dc-4aea-9970-42fa3b590b91",
"last_updated": "2018-12-20T14:45:51.344207Z"
}
}
This endpoint retrieves a single service resource.
HTTP Request
GET https://www.aliss.org/api/v4/services/<service_id_or_slug>
You can view an HTML formatted version of the result if you view the endpoint in your browser eg: https://www.aliss.org/api/v4/services/4b5eaf69-b5dc-4aea-9970-42fa3b590b91
Response structure
See service object.
Organisation
Retrieve a single organisation
curl "https://www.aliss.org/api/v4/organisations/<organisation_id_or_slug>"
The above command returns JSON structured like this:
{
"meta": {
"licence": "https://creativecommons.org/licenses/by/4.0/",
"attribution": [
{
"text": "Contains National Statistics data © Crown copyright and database right 2018",
"url": "http://geoportal.statistics.gov.uk/datasets/local-authority-districts-december-2016-generalised-clipped-boundaries-in-the-uk/"
},
{
"text": "Contains information from the Scottish Charity Register supplied by the Office of the Scottish Charity Regulator and licensed under the Open Government Licence v2.0",
"url": "https://www.oscr.org.uk/about-charities/search-the-register/charity-register-download"
},
{
"text": "Contains National Records of Scotland data licensed under the Open Government Licence v3.0",
"url": "https://www.nrscotland.gov.uk/statistics-and-data/geography/nrs-postcode-extract"
},
{
"text": "Contains contributions from ALISS users",
"url": "https://www.aliss.org/terms-and-conditions"
}
]
},
"data": {
"id": "24e42647-da5f-46ec-b0c6-458465d2467d",
"name": "SBC Community Capacity Building",
"aliss_url": "https://www.aliss.org/organisations/sbc-community-capacity-building-0/",
"permalink": "https://www.aliss.org/organisations/24e42647-da5f-46ec-b0c6-458465d2467d",
"is_claimed": false,
"slug": "sbc-community-capacity-building-0",
"description": "The aim of the Community Capacity Building team is to actively\r\nfoster and encourage the development of resilience within\r\ncommunities to allow them to become stronger and more\r\nself-reliant through offering the right support at the right time",
"facebook": "https://www.facebook.com/SBC-Community-Capacity-Building-379248189076883/",
"twitter": "",
"url": "",
"phone": "01835825080",
"email": "communitycapacity@scotborders.gov.uk",
"last_edited": "2018-11-23T09:28:38.946621Z",
"services": [
{
"id": "9fd62ed3-b6a3-46dd-8712-8727f7ff9012",
"name": "Community Capacity Building Link Worker Service",
"description": "The CCB Link Worker Service offers one to one enablement support for older people or adults with long-term conditions - this service is available in Berwickshire.",
"url": "",
"phone": "07917 277 139",
"email": "juliana.amaral@scotborder.gov.uk",
"categories": [
{
"name": "Food & Nutrition",
"slug": "food-nutrition"
},
{
"name": "Conditions",
"slug": "conditions"
},
{
"name": "Health & Social Care Services",
"slug": "health-social-care-services"
},
{
"name": "Activity",
"slug": "activity"
}
],
"service_areas": [
{
"code": "S37000025",
"type": "4",
"name": "Scottish Borders"
}
]
},
{
"id": "46237477-2831-4d8a-a78b-0069efbbb316",
"name": "Writing for Wellbeing",
"description": "A great way to use writing for self-expression in a creative way. The group meets every first Monday of the month from 2-4:30pm, £2 per person which includes tea/coffee and biscuits.",
"url": "",
"phone": "",
"email": "",
"categories": [
{
"name": "Literature",
"slug": "literature"
},
{
"name": "Social Group",
"slug": "social-group"
}
],
"service_areas": []
},
{
"id": "b32712a9-844c-4354-809c-ad3ad1c9d30e",
"name": "Duns Tea Dance",
"description": "A Tea Dance is an afternoon social dance with music, tea and cake. It is a great way to move, meet people and have fun! Every second Wednesday of every month from 2-4pm, £3/ person includes refreshments and cake/scones. Everyone welcome.",
"url": "",
"phone": "",
"email": "",
"categories": [
{
"name": "Social Group",
"slug": "social-group"
}
],
"service_areas": []
}
]
}
}
This endpoint retrieves a single organisation resource.
HTTP Request
GET https://www.aliss.org/api/v4/organisations/<organisation_id_or_slug>
You can view an HTML formatted version of the result if you view the endpoint in your browser eg: https://www.aliss.org/api/v4/organisations/24e42647-da5f-46ec-b0c6-458465d2467d
Categories
List all Categories
curl "https://www.aliss.org/api/v4/categories/"
The above command returns JSON structured like this:
{
"meta": {
"attribution": [],
"licence": "https://creativecommons.org/licenses/by/4.0/"
},
"data": [
{
"name": "Housing and Homelessness",
"slug": "housing-and-homelessness",
"sub_categories": [
{
"name": "Social Housing",
"slug": "social-housing",
"sub_categories": []
},
{
"name": "Sheltered Housing",
"slug": "sheltered-housing",
"sub_categories": []
},
{
"name": "Housing Advice",
"slug": "housing-advice",
"sub_categories": []
},
{
"name": "Housing Support",
"slug": "housing-support",
"sub_categories": []
},
{
"name": "Housing Adaptations",
"slug": "housing-adaptations",
"sub_categories": []
}
]
},
{
"name": "Food & Nutrition",
"slug": "food-nutrition",
"sub_categories": [
{
"name": "Community Garden",
"slug": "community-garden",
"sub_categories": []
},
{
"name": "Food Delivery",
"slug": "food-delivery",
"sub_categories": []
},
{
"name": "Foodbank",
"slug": "foodbank",
"sub_categories": []
},
{
"name": "Free Meals",
"slug": "free-meals",
"sub_categories": []
},
{
"name": "Community Cafe",
"slug": "community-cafe",
"sub_categories": []
}
]
},
{
"name": "Money",
"slug": "money",
"sub_categories": [
{
"name": "Money Advice",
"slug": "money-advice",
"sub_categories": []
},
{
"name": "Energy Advice",
"slug": "energy-advice",
"sub_categories": []
}
]
}
]
}
This endpoint retrieves all categories.
HTTP Request
GET https://www.aliss.org/api/v4/categories/
You can view an HTML formatted version of the result with your browser: https://www.aliss.org/api/v4/categories/
Service areas
List all Service areas
curl "https://www.aliss.org/api/v4/service-areas/"
The above command returns JSON structured like this:
{
"meta": {
"attribution": [
{
"text": "Contains National Statistics data © Crown copyright and database right 2018",
"url": "http://geoportal.statistics.gov.uk/datasets/local-authority-districts-december-2016-generalised-clipped-boundaries-in-the-uk/"
},
{
"text": "Contains information from the Scottish Charity Register supplied by the Office of the Scottish Charity Regulator and licensed under the Open Government Licence v2.0",
"url": "https://www.oscr.org.uk/about-charities/search-the-register/charity-register-download"
}
],
"licence": "https://creativecommons.org/licenses/by/4.0/"
},
"data": [
{
"code": "S12000005",
"type": "Local Authority",
"name": "Clackmannanshire"
},
{
"code": "S12000006",
"type": "Local Authority",
"name": "Dumfries and Galloway"
},
{
"code": "S12000008",
"type": "Local Authority",
"name": "East Ayrshire"
},
{
"code": "S12000010",
"type": "Local Authority",
"name": "East Lothian"
},
{
"code": "S12000011",
"type": "Local Authority",
"name": "East Renfrewshire"
},
{
"code": "S12000013",
"type": "Local Authority",
"name": "Na h-Eileanan Siar"
},
{
"code": "S12000014",
"type": "Local Authority",
"name": "Falkirk"
},
{
"code": "S12000015",
"type": "Local Authority",
"name": "Fife"
}
]
}
This endpoint retrieves all service areas. An HTML formatted version of the result is available here: http://www.aliss.org/api/v4/service-areas/
HTTP Request
GET https://www.aliss.org/api/v4/service-areas/
You can view an HTML formatted version of the result with your browser: https://www.aliss.org/api/v4/service-areas/
Changes since v3
The main difference between v4 and v3 is the structure of the JSON that is returned. All endpoints return an object rather than collections. This change facilitated the addition of metadata and other fields to the responses. The categories endpoint returns a significantly different result, as the response objects are structured to reflect the hierarchy of parent and sub-categories, rather than being flattened.
Other notable changes:
- Service endpoint has taken a more RESTful style (
/servicesrather than/search) - Service objects include a
last_updatedfield - Service and organisation objects include
aliss_urlfields - Service organisation object includes a
is_claimedfield - Service area
typefield shows a human friendly boundary name
API Version 3
Search
Thes service search feature is the core of ALISS. Search returns services on ALISS filtered by geography, and optionally by keywords or categories.
Services can be delivered at a specific location, or they can be delivered across a whole area or areas. Locations are specific to the organisations that run the services, whereas areas of delivery are selected from a pre-defined list. You can request the list of possible areas from the service-areas endpoint.
curl "https://www.aliss.org/api/v3/search/?postcode=G2 4AA"
The above command returns JSON structured like this:
{
"count": 159,
"next": "https://www.aliss.org/api/v3/search/?page=2&postcode=G2+4AA",
"previous": null,
"results": [
{
"id": "417f8631-f38e-46ef-9cf3-ea9e3fc6f47c",
"organisation": {
"id": "c823d858-d417-487d-a09d-11720e801519",
"name": "Possobilities"
},
"name": "Cook and Care",
"description": "For almost 12 years, our social enterprise, Cook and Care has been providing a first-class meals delivery service for vulnerable, elderly and disabled people in their own homes. Cook and Care widens our message of supporting independent living because we are able to help people stay in their own homes for longer.\r\n\r\nWe serve the whole of North Glasgow and pride ourselves on the quality of our meals and the efficiency and friendliness of our volunteer care staff.\r\n\r\nOur homemade meals are cooked from scratch every day and delivered hot and ready to eat, rather than overpriced frozen meals\r\nOur menus are varied, working on a 3 weekly menu cycle and are always healthy and nutritious. In addition, they’re really delicious!\r\nOur local volunteers are very flexible we can deliver on one or two days only, or every day, as required, hence a meal delivery tailored to suit you!\r\nOur service is open to anyone who needs it. Some of our customers have a disability, others use Cook and Care simply for convenience or due to temporary illness. It might even save you cooking!\r\n\r\nWe are always happy to discuss your requirements and can also take away a lot of the anxiety and stress of caring for a friend or relative at meal times.\r\n\r\nMeals are currently £4.00 for a 3 course meal, fantastic value for money and you can order online!",
"url": "http://possobilities.org.uk/cook-n-care-meal-delivery/",
"phone": "0141 336 3562",
"email": "",
"categories": [
{
"name": "Food",
"slug": "food"
}
],
"locations": [],
"service_areas": [
{
"code": "S12000046",
"type": "Local Authority",
"name": "Glasgow City"
}
]
},
{
"id": "79e5b5d9-91b8-4bd1-9117-d4cdd2f717cc",
"organisation": {
"id": "fbbb0dee-94e4-4806-b517-3934fb21a49d",
"name": "Glasgow Central Citizens Advice Bureau"
},
"name": "Debt Advice",
"description": "Are you finding it difficult to manage your debts?\r\n\r\nGlasgow Central CAB have advisers who can assist you to look at the options available to help.\r\n\r\nGlasgow Central CAB will only see people who live or work in the Glasgow City Council Tax area.\r\n\r\nThe bureau does not run an appointment system. We only operate a drop-in service where clients are seen in turn.",
"url": "http://www.glasgowcentralcab.org.uk/debt.html",
"phone": "0141 552 5556",
"email": "",
"categories": [
{
"name": "Money Advice",
"slug": "money-advice"
}
],
"locations": [
{
"id": "e5431115-a06f-4ca9-ad4d-9d158a492adf",
"formatted_address": "The Mitchell Library, 201 North St, Glasgow, G3 7DN",
"name": "The Mitchell Library",
"description": "",
"street_address": "201 North St",
"locality": "Glasgow",
"region": "Glasgow City",
"state": "",
"postal_code": "G3 7DN",
"country": "GB",
"latitude": 55.8651895,
"longitude": -4.2724227
}
],
"service_areas": []
}
]
}
HTTP Request
GET https://www.aliss.org/api/v3/search/
Query parameters
| Parameter | Required | Default | Description |
|---|---|---|---|
| postcode | True | None | The postcode that you wish to find services relevant to |
| q | False | None | This is the keywords with which to do a full text search of the services |
| category | False | None | The category slugs that you wish to filter the search by |
| location_type | False | None | The location type of the resource, either 'local' or 'national', default searches everything |
| radius | False | 5000 | The radius from the postcode that you wish the search to cover, in meters |
Filter by categories
GET https://www.aliss.org/api/v3/search/?category=money-advice&postcode=G2 4AA
You can filter by category by using the category query parameter and passing in a category slug.
Filter by location type
GET https://www.aliss.org/api/v3/search/?location_type=local&postcode=G2 4AA
You can filter by location type by using the location type query parameter and passing in either 'local' or 'national'.
Response structure
| Key | Description |
|---|---|
| count | number of results returned in all pages of the request |
| next | url to next page |
| previous | url to previous page |
| results | collection of service objects (see below) |
Service object
| Key | Description |
|---|---|
| id | UUID for the service |
| organisation | object with details of the organisation that runs the service |
| name | name of the service |
| description | free text description of the service |
| url | url to a site describing the service |
| phone | contact telephone number for the service |
| contact email address for the service | |
| categories | collection of category objects associated with the service including a human readable name and slug |
| locations | collection of location objects associated with the service |
| service_areas | collection of service area objects associated with the service, a full list of possible areas can be requested from the service areas endpoint |
Categories
List all Categories
curl "https://www.aliss.org/api/v3/categories/"
The above command returns JSON structured like this:
[
{
"id": 2,
"name": "Housing and Homelessness",
"slug": "housing-and-homelessness",
"parent": null
},
{
"id": 5,
"name": "Depression",
"slug": "depression",
"parent": 3
},
{
"id": 6,
"name": "Suicide",
"slug": "suicide",
"parent": 3
},
{
"id": 7,
"name": "Anxiety",
"slug": "anxiety",
"parent": 3
}
]
This endpoint retrieves all categories.
HTTP Request
GET https://www.aliss.org/api/v3/categories/
Service areas
List all service areas
curl "https://www.aliss.org/api/v3/service-areas/"
The above command returns JSON structured like this:
[
{
"code": "S37000025",
"type": "4",
"name": "Scottish Borders"
},
{
"code": "S37000026",
"type": "4",
"name": "Shetland Islands"
},
{
"code": "S37000027",
"type": "4",
"name": "South Ayrshire"
},
{
"code": "S37000028",
"type": "4",
"name": "South Lanarkshire"
},
{
"code": "S37000029",
"type": "4",
"name": "West Dunbartonshire"
},
{
"code": "S37000030",
"type": "4",
"name": "West Lothian"
},
{
"code": "S37000031",
"type": "4",
"name": "Western Isles"
},
{
"code": "XB",
"type": "0",
"name": "United Kingdom"
},
{
"code": "XS",
"type": "0",
"name": "Scotland"
}
]
This endpoint retrieves all service areas.
HTTP Request
GET https://www.aliss.org/api/v3/service-areas/