The API is available at https://api.nsn.org.uk/v1/
Documentation homepage https://docs.api.nsn.org.uk/
Returns category results for a search term.
| Name | Type | Sample | Example | Description |
|---|---|---|---|---|
| query | string | dentist | /v1/search/category/dentist | The term to search for |
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 |
These values are within the data object.
| Name | Type | Sample | Description |
|---|---|---|---|
| image | string (url) | http://mypickle.org/wp-content/uploads/2020/09/Work-and-StudyArtboard-1.png | Fully qualified path to an image to be used to illustrate this category. |
| name | string | Find a job and career advice | Human readable name of the category for displaying to users. |
| slug | string | find-a-job-and-career-advice | Lower case, url-encoded version of the name of the category. This value is the same as the name, formatted differently. |
| id | int | 123 | The unique ID of the category |
| description | string | Find support to help you with your job hunt and career decisions. | A human readable description of the category with more information for displaying to users. |
| href | string (url) | /category/11227 | A relative URL to the category endpoint. |
{
"data": [
{
"slug": "backache-in-pregnancy",
"description": "",
"id": 11896,
"image": "",
"name": "Backache in pregnancy",
"href": "/category/11896"
},
{
"slug": "other-wrist-hand-and-finger-problems",
"description": "",
"id": 11848,
"image": "",
"name": "Other wrist, hand and finger problems",
"href": "/category/11848"
}],
"host": "https://api.nsn.org.uk",
"version": "/v1"
} Documentation homepage https://docs.api.nsn.org.uk/