UNICLASS API

The Uniclass API allows you to access Uniclass in your own platform, making it even easier to apply to your day to day processes.

Uniclass API

The Uniclass API allows software developers to develop applications that utilise the Uniclass classifications. It is a REST API that enables navigation and classification retrieval across all of the Uniclass tables.

Complete the form on the right to register your interest in using the Uniclass API and one of our support team will reach out to discuss further.

Uniclass API Documentation

A sample website demonstrating API features can be found here.

Functions

1. GET definitions/uniclass2015/{notation}/{depth}

Get Uniclass 2015 classification tree from a specified starting notation.

Request information

Parameters

Name	Description	Additional Information
notation	The root Uniclass notation	Define this parameter in the request URI
depth	The level of depth at which to return child classifications	Define this parameter in the request URI

Define this parameter in the request URI.

Response

Response body formats

application/json, text/json, application/xml, text/xml

Sample

notation 'Ro', depth 1 gives:

    {
      "Notation": "Ro",
      "Title": "Roles",
      "Children": [
          {
              "Notation": "Ro_10",
              "Title": "Management roles",
              "Children": null
          },
          {
              "Notation": "Ro_30",
              "Title": "Delivery roles",
              "Children": null
          },
          {
              "Notation": "Ro_50",
              "Title": "Design roles",
              "Children": null
          },
          {
              "Notation": "Ro_70",
              "Title": "Site roles",
              "Children": null
          }
      ]
    }

2. GET definitions/uniclass2015/ancestors/{notation}

Get the ancestors of a given Uniclass notation, e.g. for providing a breadcrumb trail.

Request information

Parameters

Name	Description	Additional Information
notation	The Uniclass notation	Define this parameter in the request URI

Define this parameter in the request URI.

Response

Response body formats

application/json, text/json, application/xml, text/xml

Sample

notation 'Pr_40_30_22_80' gives:

    [
        {
            "Notation": "Pr",
            "Title": "Products",
            "Children": null
        },
        {
            "Notation": "Pr_40",
            "Title": "Signage, sanitary fittings and fittings, furnishing and equipment (FF&E) products",
            "Children": null
        },
        {
            "Notation": "Pr_40_30",
            "Title": "Fittings",
            "Children": null
        },
        {
            "Notation": "Pr_40_30_22",
            "Title": "Deterrents and traps",
            "Children": null
        }
    ]

Export

Platform

Resources

Support

About

Platform

Resources

Support

About

UNICLASS API

The Uniclass API allows you to access Uniclass in your own platform, making it even easier to apply to your day to day processes.

Uniclass API

Uniclass API Documentation

Functions

1. GET definitions/uniclass2015/{notation}/{depth}

2. GET definitions/uniclass2015/ancestors/{notation}

Request information

Platform

Resources

Support

About

Platform

Resources

Support

About

UNICLASS API

The Uniclass API allows you to access Uniclass in your own platform, making it even easier to apply to your day to day processes.

Uniclass API

Uniclass API Documentation

Functions

1. GET definitions/uniclass2015/{notation}/{depth}

2. GET definitions/uniclass2015/ancestors/{notation}

Request information

Welcome to the NBS