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/category/{id}

Returns details about a particular category.

Paramaters

Name Type Sample Example Description
id int 10632 /v1/category/10632 The ID of the category to get more details

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 object containing data about the category.
Data Object

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.
parentId int 1 Categories are nested within each other. This is the id of the parent category. If the category does not have a parent, this is 0.
parentName string Career advice Categories are nested within each other. This is the name of the parent category. If the category does not have a parent, this is "None".
categories array An optional array of category objects of the sub categories underneath this category.
resources array An optional array of resource objects of the resources within this category.
Category Objects

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

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. This may be an empty string.
name string Find a job and career advice Human readable name of the category for displaying to users.
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. This may be an empty string
href string (url) /category/10958 A relative path to the resource that contains more information about this category
Resource Objects

These values are available within each resource object within the resources field.

Name Type Sample Description
name string Free dry cleaning of interview clothes Human readable name of the resource for displaying to users.
id int 11290223 The unique ID of the resource
href string (url) /resource/12902 A relative path to the resource that contains more information about this resource

Example

{
    "data": {
        "resources": [
            {
                "name": "Free dry cleaning of interview clothes",
                "id": 12902,
                "href": "https://api.nsn.org.uk/v1/resource/12902"
            },
            {
                "name": "Guides to different career opportunities",
                "id": 12230,
                "href": "https://api.nsn.org.uk/v1/resource/12230"
            }
        ],
        "image": "http://mypickle.org/wp-content/uploads/2020/09/Work-and-StudyArtboard-1.png",
        "slug": "find-a-job-and-career-advice",
        "parentId": 0,
        "parentName": "None",
        "description": "Find support to help you with your job hunt and career decisions.",
        "id": 10628,
        "name": "Find a job and career advice",
        "categories": [
            {
                "name": "Career advice",
                "image": "",
                "description": "",
                "item": 10958,
                "id": 10958,
                "href": "https://api.nsn.org.uk/v1/10958"
            },
            {
                "name": "Career skills and training",
                "image": "",
                "description": "",
                "item": 10949,
                "id": 10949,
                "href": "https://api.nsn.org.uk/v1/10949"
            }
        ],
        "type": "cateory"
    },
    "host": "https://api.nsn.org.uk",
    "version": "/v1"
}

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