Version 2 API: endpoints

Endpoints are the uris to which you issue requests. Each entity type available through the version 2 API has a separate endpoint.

Opinions

The set of opinions is available at

https://www.patientopinion.org.uk/api/v2/opinions

By default, opinions are ordered by date of publication, oldest first. Ordering can be reversed if required.

A single opinion is available at

https://www.patientopinion.org.uk/api/v2/opinions/id

The subcollections of entities related to a single opinion are available at

https://www.patientopinion.org.uk/api/v2/opinions/id/tags
https://www.patientopinion.org.uk/api/v2/opinions/id/responses
https://www.patientopinion.org.uk/api/v2/opinions/id/healthservices

Note that the tag subcollection of an opinion will also include the polarity (positive/negative) with which the tag was applied to the opinion.

Responses

The set of responses is available at

https://www.patientopinion.org.uk/api/v2/responses

By default, responses are ordered by date of publication, oldest first. Ordering can be reversed if required.

A single response is available at

https://www.patientopinion.org.uk/api/v2/responses/id

Healthservices

The set of healthservices is available at

https://www.patientopinion.org.uk/api/v2/healthservices

Healthservices are ordered by id (Nacs/ODS code or ONS code).

A single healthservice is available at

https://www.patientopinion.org.uk/api/v2/healthservices/id

Tags (enhanced level)

The set of tags is available at

https://www.patientopinion.org.uk/api/v2/tags

Tags are ordered by tag name.

A single tag is available at

https://www.patientopinion.org.uk/api/v2/tags/id

Treatment functions (enhanced level)

The set of treatment functions is available at

https://www.patientopinion.org.uk/api/v2/treatmentfunctions

Treatment functions are ordered by treatment function code.

A single treatment function is available at

https://www.patientopinion.org.uk/api/v2/treatmentfunctions/id