Shropshire API Documentation

Welcome to the Shropshire API. This API provides access to information about services, organizations, locations, and reviews in Shropshire.

Base URL

https://api.shropshire.dev.docandtee.com/api/v2

Rate Limiting

API requests are limited to 60 requests per minute.

Endpoints

Services

GET /services

List all services with optional filtering and pagination.

Query Parameters:

text string optional
Search text to filter services
page integer optional
Page number (default: 1)
per_page integer optional
Items per page (1-100, default: 12)
include[] array optional
Include related data. Valid values: contacts, cost_options, eligibilitys, fundings, holiday_schedules, languages, organization, regular_schedules, reviews, service_areas, service_at_locations, service_taxonomys, pc_targetAudience

Taxonomy Filters:

taxonomy_id[] array optional
Filter by taxonomy IDs
taxonomy_type[] array optional
Filter by taxonomy types
service_type[] array optional
Filter by service types
circumstance[] array optional
Filter by circumstance taxonomy IDs
need[] array optional
Filter by need taxonomy IDs
vocabulary[] array optional
Filter by taxonomy vocabulary
audience_type[] array optional
Filter by target audience types. Example values: adult, child, family, young_person, older_person, carer, parent, professional. Can be used multiple times for multiple audience types.

Age Filters:

minimum_age integer optional
Filter by minimum age (inclusive)
maximum_age integer optional
Filter by maximum age (inclusive)

Location Filters:

postcode string optional
Filter by UK postcode (e.g., BS2). Ignored when latitude and longitude are provided.
latitude float optional
Latitude coordinate for location-based search (must be used with longitude)
longitude float optional
Longitude coordinate for location-based search (must be used with latitude)
proximity numeric optional
Search radius in meters
coverage string optional
Filter by service area coverage ID
physical_addresses[] array optional
Filter by physical address components

Time Filters:

day[] array optional
Filter by days (MO, TU, WE, TH, FR, SA, SU)
start_time[] array optional
Filter by start times (24-hour format, e.g., 09:00)
end_time[] array optional
Filter by end times (24-hour format, e.g., 17:00)

Date Range Filters:

start_date date optional
Filter by start date (required with end_date)
end_date date optional
Filter by end date (must be after or equal to start_date)
assured_date date optional
Filter by assured date

Response Format:

{
    "content": [
        {
            "id": "uuid",
            "name": "Service Name",
            "description": "Service Description",
            "url": "https://example.com",
            "email": "contact@example.com",
            "status": "active",
            "fees": "Free",
            "accreditations": ["ISO 9001"],
            "assured_date": "2024-01-01T00:00:00Z",
            "contacts": [...],
            "organization": {...},
            "service_areas": [...],
            "service_at_locations": [...]
        }
    ],
    "empty": false,
    "first": true,
    "last": false,
    "number": 1,
    "numberOfElements": 50,
    "size": 50,
    "totalElements": 5020,
    "totalPages": 101,
    "pageable": {
        "offset": 0,
        "pageNumber": 1,
        "pageSize": 50,
        "paged": true,
        "unpaged": false
    },
    "sort": {
        "empty": false,
        "sorted": true,
        "unsorted": false
    }
}
GET /services/{id}

Get details of a specific service by ID.

Path Parameters:

id uuid required
The unique identifier of the service
GET /services/map-clusters

Get service clusters for map visualization.

GET /services/cluster/{geohash}

Get services within a specific map cluster.

Path Parameters:

geohash string required
The geohash of the cluster

Organizations

GET /organizations

List all organizations with optional filtering.

Query Parameters:

page integer optional
Page number (default: 1)
per_page integer optional
Items per page (default: 50)
scheme string optional
Filter by organization scheme
taxonomy string optional
Filter by taxonomy ID
full_service boolean optional
Include full service details in response (default: false)
GET /organizations/{id}

Get details of a specific organization by ID.

Path Parameters:

id uuid required
The unique identifier of the organization

Query Parameters:

full_service boolean optional
Include full service details in response (default: false)

Locations

GET /locations

List all locations with optional filtering.

Query Parameters:

page integer optional
Page number (default: 1)
per_page integer optional
Items per page (default: 50)
GET /locations/{id}

Get details of a specific location by ID.

Path Parameters:

id uuid required
The unique identifier of the location

Reviews

GET /reviews

List all reviews with optional filtering.

Query Parameters:

page integer optional
Page number (default: 1)
per_page integer optional
Items per page (default: 50)
GET /reviews/{id}

Get details of a specific review by ID.

Path Parameters:

id uuid required
The unique identifier of the review

Error Responses

Error responses include:

Support

For API support or questions, please contact the development team.