NSN API Documentation (v1.0)

The API is available at /

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

GET /v1/areas

Returns a list of the top level areas.

Paramaters

None

No parameters are required for this endpoint. It returns all the areas and is a good starting point for retrieveing an index or initial screen to be displayed to users

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 array An array of area objects containing the data for each area.
Data Objects

These values are available within each area object within the data field.

Name Type Sample Description
title string Work Human readable version of the name of the area, for displaying to users
slug string work Lower case, url-encoded version of the name of the area. This value is the same as the title, formatted differently.
id int 123 The unique ID of the area
category array An array of category objects that sit underneath this area.
Category Objects

These values are available within each category object within the category field.

Name Type Sample Description
name string Animal welfare The human readable name of the category
description string Find support if you are worried about the welfare of an animal. A human readable description of the category.
id int 123 The unique ID of the category
href string (url) /category/10599 A relative path to the resource that contains more information about this category

Example

{
    "data": [
        {
            "category": [
                {
                    "name": "Find a job and career advice",
                    "description": "Find support to help you with your job hunt and career decisions.",
                    "id": 10628,
                    "href": "/category/10628"
                },
                {
                    "name": "Problems at work",
                    "description": "Find help and support to manage and overcome problems at work.",
                    "id": 10672,
                    "href": "/category/10672"
                }
            ],
            "slug": "work",
            "id": 14,
            "title": "Work"
        },
        {
            "category": [
                {
                    "name": "Animal welfare",
                    "description": "Find support if you are worried about the welfare of an animal.",
                    "id": 10599,
                    "href": "/category/10599"
                },
                {
                    "name": "Getting a pet",
                    "description": "Resources to help you select and find a healthy and suitable pet.",
                    "id": 10632,
                    "href": "/category/10632"
                }
            ],
            "slug": "pets",
            "id": 18,
            "title": "Pets"
        }
    ],
    "host": "https://api.nsn.org.uk",
    "version": "/v1"
}

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