Lookup NHS Organization Details
This API for the NHS Organization dataset provides a simple way to extract the key details about an individual organization. The API accepts a single parameter, which is the unique identifier for the organization.
The response will include:
- Organization URI
- Organization Name
- Address
- Homepage (where available)
- Link to NHS Choices site (where available)
- Twitter account (where available)
- Facebook page (where available)
- Flickr account (where available)
- RSS feed (where available)
The response can be provided in a simple XML or JSON wrapper
Table of contents
Endpoint URL
Login to test this query using our experimental API explorer
Authentication
You will need your API key (on your dashboard) in order to authenticate to this API. You have two options for authentication:
- By URL Parameter -- add the
apikeyparameter to your request URL, with your key as the value - By Request Header -- add a custom HTTP header called
X_KASABI_APIKEYto your HTTP request, with your key as the value
For more information on Kasabi authentication options read the authentication documentation. Your API key will need to be authorized to use this service.
Parameters
This API supports the following request parameters:
| Parameter | Default | Required | Type | Base | Notes |
|---|---|---|---|---|---|
| code | Yes | http://data.kasabi.com/dataset/nhs-organization/def/odsCode | The unique ODS code for the organization, e.g. 5A4 |
HTTP Response Codes
Clients should be prepared to receive any valid HTTP response code. The following table lists the most frequently used codes
| Code | Meaning |
|---|---|
200 OK | Successful Request |
400 Bad Request | Missing or malformed SPARQL query |
401 Not Authorized | API key is not authorized to access the data |
Please also review our additional notes on response codes.
Response Formats
The following response formats are supported for this SPARQL endpoint. Formats can be selected using either the HTTP Accept header, or via the output parameter. As noted in the table below, the type of SPARQL query further limits the available range of output options Please also review our additional notes on content negotiation used in Kasabi APIs.
| Name | Media Type | Notes |
|---|---|---|
| json | application/json | Simple JSON output |
| xml | application/xml | Simple XML output |
