Skip to content

Commit fda706c

Browse files
authored
Spec updates (#41)
* Updated the service level to ‘bronze’ * Added an ‘Attribution’ section toi the spec * Removed the attribution PNG image
1 parent 74a3a63 commit fda706c

1 file changed

Lines changed: 25 additions & 2 deletions

File tree

specification/nhs-website-content-api.yaml

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,37 @@ info:
2222
* get Ratings and Reviews of NHS services.
2323
2424
## Who can use this API
25-
Anyone can use this API for any purpose, so long as they include an attribution as per our [terms and conditions](https://developer.api.nhs.uk/about/terms).
25+
Anyone can use this API for any purpose, so long as they include an [attribution](#overview--attribution) as outlined below.
26+
27+
## Attribution
28+
Any syndicated content must incorporate the following attribution (credit) to the NHS website:
29+
30+
<img src="https://www.nhs.uk/nhscwebservices/documents/logo1.jpg" alt="Content supplied by the NHS website" width="875" height="177" style="width: 250px; height: 49px;" />
31+
32+
The logo should be clearly visible and in line with the associated content on every web page that contains the syndicated content. You should also link this logo to the relevant page on the NHS website that the content has been supplied from. This URL is supplied as part of the feed under author:
33+
34+
```
35+
"author": {
36+
"url": "https://www.nhs.uk",
37+
"logo": "https://www.nhs.uk/nhscwebservices/documents/logo1.jpg",
38+
"email": "nhswebsite.servicedesk@nhs.net",
39+
"@type": "Organization",
40+
"name": "NHS website"
41+
}
42+
```
43+
44+
If you are displaying NHS syndicated content in a context where a functional link back to the article on the NHS website is not possible then you should use the following attribution (credit):
45+
46+
```
47+
<p>From <a href="https://www.nhs.uk/" target="_blank">www.nhs.uk<a/></p>
48+
```
2649
2750
## API status
2851
This API has moved from the [NHS website developer portal](https://developer.api.nhs.uk/).
2952
It is currently [in development](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses).
3053
3154
## Service level
32-
This API is a [gold service](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels), meaning that it is operational and supported 24 hours a day, 365 days a year.
55+
This API is a [bronze service](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels).
3356
3457
## Technology
3558
This API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest).

0 commit comments

Comments
 (0)