LMIforAll ESS

{
  "apiVersion": "1.0.0",
  "swaggerVersion": "1.2",
  "resourcePath": "/ess",
  "produces": [
    "application/json"
  ],
  "consumes": [
    "application/json"
  ],
  "protocols": [
    "http"
  ],
  "apis": [
    {
      "path": "/ess/region/{region}/{soc}",
      "operations": [
        {
          "method": "GET",
          "summary": "Get Hard-To-Fill and Skill Shortage Vacancy percentages for a given SOC code.",
          "position": 0,
          "notes": "Sometimes this data is unreliable (too few samples). The result includes a reliability indicator that goes from 0 to 3. If reliability is zero, the data point was probably redacted due to the small sample size.",
          "deprecated": false,
          "nickname": "getESSRegion",
          "parameters": [
            {
              "name": "year",
              "description": "Which year's data to use. Default (empty) is most recent.",
              "defaultValue": "2013",
              "required": false,
              "paramType": "query",
              "type": "integer",
              "format": "int32",
              "enum": [
                2013,
                2011
              ]
            },
            {
              "name": "coarse",
              "description": "Instead of a regular query at SOC 4-digit level, (which doesn't always find reliable results), perform a coarse query at 2-digit level. Coarse queries usually return reliable results, but the result data is less relevant since it includes other, similaroccupations.",
              "defaultValue": "false",
              "required": false,
              "paramType": "query",
              "type": "boolean"
            },
            {
              "name": "soc",
              "description": "SOC Code for the job.",
              "required": true,
              "paramType": "path",
              "type": "integer",
              "format": "int32"
            },
            {
              "name": "region",
              "description": "Region code. Get this from /regions.",
              "required": true,
              "paramType": "path",
              "type": "integer",
              "format": "int32"
            }
          ],
          "type": "void"
        }
      ]
    },
    {
      "path": "/ess/regions",
      "operations": [
        {
          "method": "GET",
          "summary": "Get a list of all available regions and their codes.",
          "position": 0,
          "notes": "",
          "deprecated": false,
          "nickname": "getRegions",
          "parameters": [
            
          ],
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    {
      "path": "/ess/regions/ranksocs/{regionid}",
      "operations": [
        {
          "method": "GET",
          "summary": "Get the top 30 hardest-to-fill jobs in a region, ranked by how hard to fill they are.",
          "position": 0,
          "notes": "This operation was added specifically for the hack day and may change or be removed in the future.",
          "deprecated": false,
          "nickname": "getSOCRanksUK",
          "parameters": [
            {
              "name": "regionid",
              "description": "Region ID.",
              "required": true,
              "paramType": "path",
              "type": "integer",
              "format": "int32"
            }
          ],
          "type": "void"
        }
      ]
    },
    {
      "path": "/ess/uk/{soc}",
      "operations": [
        {
          "method": "GET",
          "summary": "Get UK-wide Hard-To-Fill and Skill Shortage Vacancy percentages for a given SOC code.",
          "position": 0,
          "notes": "Sometimes this data is unreliable (too few samples). The result includes a reliability indicator that goes from 1 to 5. Results below a reliability of 1 will not be returned at all, and may produce a 404 response.",
          "deprecated": false,
          "nickname": "getESS",
          "parameters": [
            {
              "name": "year",
              "description": "Which year's data to use. Default (empty) is most recent.",
              "defaultValue": "2013",
              "required": false,
              "paramType": "query",
              "type": "integer",
              "format": "int32",
              "enum": [
                2013,
                2011
              ]
            },
            {
              "name": "coarse",
              "description": "Instead of a regular query at SOC 4-digit level, (which doesn't always find reliable results), perform a coarse query at 2-digit level. Coarse queries usually return reliable results, but the result data is less relevant since it includes other, similaroccupations.",
              "defaultValue": "false",
              "required": false,
              "paramType": "query",
              "type": "boolean"
            },
            {
              "name": "soc",
              "description": "SOC Code for the job.",
              "required": true,
              "paramType": "path",
              "type": "integer",
              "format": "int32"
            }
          ],
          "type": "void"
        }
      ]
    }
  ],
  "basePath": "http://api.lmiforall.org.uk/api/v1"
}