NSN API Documentation (v1.0)

The API is available at https://api.nsn.org.uk/v1/

Documentation homepage https://docs.api.nsn.org.uk/

GET /v1/suggest/category/{query}

Returns a basic array of resource suggestions for a search term..

Paramaters

Name	Type	Sample	Example	Description
query	string	dentist	/v1/suggest/category/dentist	The term to search for

Response

These values are available at the top level of the API response

Name	Type	Sample	Description
host	string (url)	https://api.nsn.org.uk	The host name of the API you're currently calling.
version	string	/v1	The version of the API you're currently using, prefixed with a slash as it appears in the URL.
data	object		An array of all the categories

Data Object

These values are within the data object.

Name	Type	Sample	Description
name	string	Find a job and career advice	Human readable name of the category for displaying to users.
href	string (URL)	/category/11896.	A relative path to the resource that contains more information about this category

Example

{
    "data": [{
            "name": "Backache in pregnancy",
            "href": "/category/11896"
        },
        {
            "name": "Anaemia in pregnancy",
            "href": "/category/11895"
        }],
    "host": "https://api.nsn.org.uk",
    "version": "/v1"
}

Documentation homepage https://docs.api.nsn.org.uk/