StatPro Revolution Web API


The Classifiers Resource


Overview

The Classifiers resource represents collection of classifiers available to the identified user. Classifiers in the collection can include those that are system classifiers, ones owned by the user, and those that are owned by other users and currently shared to the identified user.

Requests for the Classifiers resource currently always returns all classifiers accessible to the user. In future additional filtering, ordering and paging options will be available. Refer to the documentation for further details of the classifiers-query link relation.

The resource representation includes the name, unique identifier, code and type of each classifier. Additionally there is a flag indicating whether or not the classifier is a system or user owned one.


Media types

The Classifiers resource is exposed via XML and JSON representations, which have the following media type names:-

application/vnd.statpro.revolution.api.classifiers+json

application/vnd.statpro.revolution.api.classifiers+xml

When a response is received from the web service with status 200 (= OK), the fact that the response contains a Classifiers resource representation is indicated by the presence of one of these two response headers:-

Content-Type: application/vnd.statpro.revolution.api.classifiers+json; charset=utf-8

Content-Type: application/vnd.statpro.revolution.api.classifiers+xml; charset=utf-8


Related resources

The Classifiers resource links to the Service resource and itself. To do so, its resource representations use link relations:-

  • service
  • self

The service link relation identifies the Service resource link.

The self link relation identifies the Classifiers resource link, in which the representation is the same as the one that has been currently retrieved (so long as the underlying data on the server hasn't changed).

All related resources are accessed using the HTTP GET method.


Update history

  • Added the IsBalanced property - February 2016
  • Initial Version - November 2015

Annotated Representation (JSON)

Legend

{
  "classifiers": {
    "links": {
      "service": {
        "rel": "service",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.service+json"
      },
      "self": {
        "rel": "self",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.classifiers+json"
      }
    },
    "items": [
      {
        "id": "DF5E9AFB-7725-40A4-996B-3AA65655675E",
        "code": "GICSSector",
        "name": "GICS Sector",
        "type": "Basic",
        "IsSystem": true,
        "IsBalanced": false
      },
      {
        "id": "AE95E6A2-F403-4258-99EC-CF4C7E53FA55",
        "code": "CustomClass",
        "name": "Custom Classifications",
        "type": "DateStamped",
        "IsSystem": false,
        "IsBalanced": true
      }
    ]
  }
}


Annotated Representation (XML)

Legend

<?xml version="1.0" encoding="utf-8"?>
<classifiers xmlns="http://statpro.com/2012/Revolution">
  <link rel="service"
        href="..."
        type="application/vnd.statpro.revolution.api.service+xml" />
  <link rel="self"
        href="..."
        type="application/vnd.statpro.revolution.api.classifiers+xml" />
  <classifier>
    <id>DF5E9AFB-7725-40A4-996B-3AA65655675E</id>
    <code>GICSSector</code>
    <name>GICS Sector</name>
    <type>Basic</type>
    <IsSystem>true</IsSystem>
    <IsBalanced>false</IsBalanced>
  </classifier>
  <classifier>
    <id>AE95E6A2-F403-4258-99EC-CF4C7E53FA55</id>
    <code>CustomClass</code>
    <name>Custom Classifications</name>
    <type>DateStamped</type>
    <IsSystem>false</IsSystem>
    <IsBalanced>true</IsBalanced>
  </classifier>
</classifiers>


Last updated: February 2016


To Top