Open Referral UK standard compliance report

Understanding The Results

To Pass validation, for V3 & V1 of the schema, no issues can be found with the API responses of the basic endpoints. The basic endpoints are those that are deemed vital for a feed to be useful.

The V3 basic endpoints are

GET /
GET /services
GET /services/{id}

The V1 basic endpoints

GET /services
GET /services/{id}

Errors, Warnings, & Failing Validation

Any issues found with a response from one of the basic endpoints will be labelled as an ERROR and the feed will fail validation.

Any issues found with any of the other endpoints will be marked as a WARNING. These may include issues which are the same as those labelled as errors but as the issue is not on one of the basic endpoints it is labelled with a lower severity.

Check again

Sample reports

For a quick preview of the results this tool reports, choose an example:

Pass
Pass (with warnings)
Fail

Open Referral UK standard compliance report

Understanding The Results

Errors, Warnings, & Failing Validation

Check again

Sample reports

Understanding The Results

Errors, Warnings, & Failing Validation

Check again

Sample reports

For the services at https://oruk-api-2a920f51d6bb.herokuapp.com/api/mock/fail

API path/

Does the base endpoint return meta information about the API, and does it adhere to the schema?

API path/services

Does the services list endpoint return a paginated list of services in the correct schema?

API path/services/{id}

Does the service by id endpoint return a fully nested service in the correct schema?

API path/taxonomies

Does the taxonomies list endpoint return a paginated list of taxonomies in the correct schema?

API path/taxonomies/{id}

Does the taxonomy by id endpoint return the full information of a taxonomy in the correct schema?

API path/taxonomy_terms

Does the taxonomy terms list endpoint return a paginated list of taxonomy terms in the correct schema?

API path/taxonomy_terms/{id}

Does the taxonomy term by id endpoint return the full information of a taxonomy term in the correct schema?

API path/service_at_locations

Does the service at location list endpoint return a paginated list of services at locations in the correct schema?

API path/service_at_locations/{id}

Does the service at location by id endpoint return the full information of a service at location in the correct schema?