LMIforAll O-NET

{
  "apiVersion": "1.0.0",
  "swaggerVersion": "1.2",
  "resourcePath": "/o-net",
  "produces": [
    "application/json"
  ],
  "consumes": [
    "application/json"
  ],
  "protocols": [
    "http"
  ],
  "apis": [
    {
      "path": "/o-net/abilities/{onetcode}",
      "operations": [
        {
          "method": "GET",
          "summary": "Get O*NET Abilities data about an occupation.",
          "position": 0,
          "notes": "This dataset returns LV and IM scales.",
          "deprecated": false,
          "nickname": "getAbilities",
          "parameters": [
            {
              "name": "onetcode",
              "description": "O*NET occupation code. This is different from the UK SOC code!  See the /soc2onet endpoint to translate your SOC codes.",
              "required": true,
              "paramType": "path",
              "type": "string"
            }
          ],
          "type": "void"
        }
      ]
    },
    {
      "path": "/o-net/identifiers",
      "operations": [
        {
          "method": "GET",
          "summary": "Get a list of all O*NET skill, ability and interest identifier codes.",
          "position": 0,
          "notes": "",
          "deprecated": false,
          "nickname": "getIdentifiers",
          "parameters": [
            
          ],
          "type": "array",
          "items": {
            "$ref": "OnetCategory"
          }
        }
      ]
    },
    {
      "path": "/o-net/interests/{onetcode}",
      "operations": [
        {
          "method": "GET",
          "summary": "Get O*NET Interests data about an occupation.",
          "position": 0,
          "notes": "This dataset returns OI and IH scales.",
          "deprecated": false,
          "nickname": "getInterests",
          "parameters": [
            {
              "name": "onetcode",
              "description": "O*NET occupation code. This is different from the UK SOC code!  See the /soc2onet endpoint to translate your SOC codes.",
              "required": true,
              "paramType": "path",
              "type": "string"
            }
          ],
          "type": "void"
        }
      ]
    },
    {
      "path": "/o-net/knowledge/{onetcode}",
      "operations": [
        {
          "method": "GET",
          "summary": "Get O*NET knowledge data about an occupation.",
          "position": 0,
          "notes": "This dataset returns IM and LV scales.",
          "deprecated": false,
          "nickname": "getKnowledge",
          "parameters": [
            {
              "name": "onetcode",
              "description": "O*NET occupation code. This is different from the UK SOC code!  See the /soc2onet endpoint to translate your SOC codes.",
              "required": true,
              "paramType": "path",
              "type": "string"
            }
          ],
          "type": "void"
        }
      ]
    },
    {
      "path": "/o-net/reversematch",
      "operations": [
        {
          "method": "GET",
          "summary": "Perform a reverse O*NET match from skills, abilities and interests to occupations.",
          "position": 0,
          "notes": "This takes sets of O*NET skill, ability and interest codes and performs a reverse match, returning a list of O*NET occupations that match these skills (sorted by match strength). Matching is performed by importance of the skill. You can additionally provide weights to put heavier focus on one of the areas. NOTE: This returns O*NET occupations. O*NET occupations don't exactly match the SOC code occupations, and they don't share a common code.<br><br>Use the /o-net/identifiers endpoint to obtain a list of possible codes for matching.",
          "deprecated": false,
          "nickname": "reverseMatches",
          "parameters": [
            {
              "name": "accesskey",
              "description": "This call is under development and access restricted. Put in access key to test it.",
              "required": true,
              "paramType": "query",
              "type": "string"
            },
            {
              "name": "weights",
              "description": "Weights for skills, abilities, interests and knowledge, comma-separated. The normal value is 100. So '100,120,0,0' would slightly prefer abilities over skills and completely ignore interests and knowledge. If you leave this out, defaults to '100,100,100,100'.",
              "defaultValue": "100,100,100,100",
              "required": false,
              "paramType": "query",
              "type": "string"
            },
            {
              "name": "knowledge",
              "description": "A comma-separated list of O*NET KNOWLEDGE identifiers.",
              "required": false,
              "paramType": "query",
              "type": "string"
            },
            {
              "name": "interests",
              "description": "A comma-separated list of O*NET INTERESTS identifiers.",
              "required": false,
              "paramType": "query",
              "type": "string"
            },
            {
              "name": "abilities",
              "description": "A comma-separated list of O*NET ABILITIES identifiers.",
              "required": false,
              "paramType": "query",
              "type": "string"
            },
            {
              "name": "skills",
              "description": "A comma-separated list of O*NET SKILLS identifiers.",
              "required": false,
              "paramType": "query",
              "type": "string"
            }
          ],
          "type": "void"
        }
      ]
    },
    {
      "path": "/o-net/scales",
      "operations": [
        {
          "method": "GET",
          "summary": "Get an overview of the scales used in O*NET.",
          "position": 0,
          "notes": "O*NET data is rated along several scales. This endpoint gives you a data structure that explains the scales, and their minimum and maximum values. Not all scales are available in all datasets. We recommend caching this information once and then referring to it by the scale IDs that every data query returns to make sense of the returned values.",
          "deprecated": false,
          "nickname": "getScales",
          "parameters": [
            
          ],
          "type": "void"
        }
      ]
    },
    {
      "path": "/o-net/skills/{onetcode}",
      "operations": [
        {
          "method": "GET",
          "summary": "Get O*NET Skills data about an occupation.",
          "position": 0,
          "notes": "This dataset returns LV and IM scales.",
          "deprecated": false,
          "nickname": "getSkills",
          "parameters": [
            {
              "name": "onetcode",
              "description": "O*NET occupation code. This is different from the UK SOC code!  See the /soc2onet endpoint to translate your SOC codes.",
              "required": true,
              "paramType": "path",
              "type": "string"
            }
          ],
          "type": "void"
        }
      ]
    },
    {
      "path": "/o-net/soc2onet/{soc}",
      "operations": [
        {
          "method": "GET",
          "summary": "Translate your SOC Code to one or several O*NET occupations.",
          "position": 0,
          "notes": "Since O*NET is a US system, its classification codes differ from the UK ones. Before you start pulling O*NET data, you have to translate your SOC code to an O*NET code. These don't map exactly, so one UK SOC code may cover several O*NET occupations. We recommend having your user pick the best fit.",
          "deprecated": false,
          "nickname": "soc2onet",
          "parameters": [
            {
              "name": "soc",
              "description": "SOC code of the occupation.",
              "required": true,
              "paramType": "path",
              "type": "integer",
              "format": "int32"
            }
          ],
          "type": "SOC2OnetResponse"
        }
      ]
    }
  ],
  "models": {
    "SOC2OnetResponse": {
      "id": "SOC2OnetResponse",
      "name": "SOC2OnetResponse",
      "qualifiedType": "org.careersdata.lmiforall.api.SOC2OnetResponse",
      "required": [
        "soc",
        "onetCodes"
      ],
      "properties": {
        "soc": {
          "position": 0,
          "type": "integer",
          "format": "int32"
        },
        "onetCodes": {
          "position": 1,
          "type": "array",
          "items": {
            "$ref": "SOC2OnetCodeInfo"
          }
        }
      }
    },
    "OnetCategory": {
      "id": "OnetCategory",
      "name": "OnetCategory",
      "qualifiedType": "org.careersdata.lmiforall.api.OnetCategory",
      "required": [
        "category",
        "id",
        "name"
      ],
      "properties": {
        "category": {
          "position": 0,
          "type": "string"
        },
        "id": {
          "position": 1,
          "type": "string"
        },
        "name": {
          "position": 2,
          "type": "string"
        }
      }
    },
    "SOC2OnetCodeInfo": {
      "id": "SOC2OnetCodeInfo",
      "name": "SOC2OnetCodeInfo",
      "qualifiedType": "org.careersdata.lmiforall.api.SOC2OnetCodeInfo",
      "required": [
        "code",
        "title",
        "description",
        "occupations",
        "data_available"
      ],
      "properties": {
        "code": {
          "position": 0,
          "type": "string"
        },
        "title": {
          "position": 1,
          "type": "string"
        },
        "description": {
          "position": 2,
          "type": "string"
        },
        "occupations": {
          "position": 3,
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "data_available": {
          "position": 4,
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  },
  "basePath": "http://api.lmiforall.org.uk/api/v1"
}