LMIforAll LFS

{
  "apiVersion": "1.0.0",
  "swaggerVersion": "1.2",
  "resourcePath": "/lfs",
  "produces": [
    "application/json"
  ],
  "consumes": [
    "application/json"
  ],
  "protocols": [
    "http"
  ],
  "apis": [
    {
      "path": "/lfs/filters",
      "operations": [
        {
          "method": "GET",
          "summary": "Get a list of all available filter names.",
          "position": 0,
          "notes": "",
          "deprecated": false,
          "nickname": "getFilterNames",
          "parameters": [
            
          ],
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    {
      "path": "/lfs/filters/all",
      "operations": [
        {
          "method": "GET",
          "summary": "Get a list of all available filters and their codings.",
          "position": 0,
          "notes": "This list is rather large, so we recommend caching it just once at the start of your application.",
          "deprecated": false,
          "nickname": "getAllFiltersInfo",
          "parameters": [
            
          ],
          "type": "array",
          "items": {
            "$ref": "LFSFilterInfo"
          }
        }
      ]
    },
    {
      "path": "/lfs/filters/info/{name}",
      "operations": [
        {
          "method": "GET",
          "summary": "Get more information about a certain filter.",
          "position": 0,
          "notes": "",
          "deprecated": false,
          "nickname": "getFilterInfo",
          "parameters": [
            {
              "name": "name",
              "description": "The name of the filter.",
              "required": true,
              "paramType": "path",
              "type": "string",
              "enum": [
                "nqf5",
                "nqf8",
                "industry",
                "ageband",
                "region",
                "gender"
              ]
            }
          ],
          "type": "LFSFilterInfo"
        }
      ]
    },
    {
      "path": "/lfs/unemployment",
      "operations": [
        {
          "method": "GET",
          "summary": "Get the unemployment rate in percent for a certain SOC code, optionally filtered by a set of characteristics.",
          "position": 0,
          "notes": "Obtain the filtering characteristics from a call to the /filters endpoints. Note that unemployment rates are provided at the 3-digit SOC level, so they include similar jobs to the one queried.",
          "deprecated": false,
          "nickname": "getWeeklyPay",
          "parameters": [
            {
              "name": "soc",
              "description": "SOC code of the job.",
              "required": true,
              "paramType": "query",
              "type": "integer",
              "format": "int32"
            },
            {
              "name": "minYear",
              "description": "Only include results from this year and beyond.",
              "required": false,
              "paramType": "query",
              "type": "integer",
              "format": "int32"
            },
            {
              "name": "maxYear",
              "description": "Only include results up to and from this year.",
              "required": false,
              "paramType": "query",
              "type": "integer",
              "format": "int32"
            },
            {
              "name": "filterBy",
              "description": "A list of sets of filter names and codes to apply. Example: 'gender:1|ageband:2,3'",
              "required": false,
              "paramType": "query",
              "type": "string"
            }
          ],
          "type": "LFSPayResult"
        }
      ]
    }
  ],
  "models": {
    "LFSYear": {
      "id": "LFSYear",
      "name": "LFSYear",
      "qualifiedType": "org.careersdata.lmiforall.api.LFSYear",
      "required": [
        "year",
        "unemprate"
      ],
      "properties": {
        "year": {
          "position": 0,
          "type": "integer",
          "format": "int32"
        },
        "unemprate": {
          "position": 1,
          "type": "number",
          "format": "double"
        }
      }
    },
    "LFSFilterInfo": {
      "id": "LFSFilterInfo",
      "name": "LFSFilterInfo",
      "qualifiedType": "org.careersdata.lmiforall.api.LFSFilterInfo",
      "required": [
        "name",
        "description",
        "coding"
      ],
      "properties": {
        "name": {
          "position": 0,
          "type": "string"
        },
        "description": {
          "position": 1,
          "type": "string"
        },
        "coding": {
          "position": 2,
          "type": "array",
          "items": {
            "$ref": "LFSCoding"
          }
        }
      }
    },
    "LFSPayResult": {
      "id": "LFSPayResult",
      "name": "LFSPayResult",
      "qualifiedType": "org.careersdata.lmiforall.api.LFSPayResult",
      "required": [
        "soc",
        "years"
      ],
      "properties": {
        "soc": {
          "position": 0,
          "type": "integer",
          "format": "int32"
        },
        "excisions": {
          "position": 0,
          "type": "string"
        },
        "reliability": {
          "position": 0,
          "type": "string"
        },
        "years": {
          "position": 1,
          "type": "array",
          "items": {
            "$ref": "LFSYear"
          }
        }
      }
    },
    "LFSCoding": {
      "id": "LFSCoding",
      "name": "LFSCoding",
      "qualifiedType": "org.careersdata.lmiforall.api.LFSCoding",
      "required": [
        "code",
        "description"
      ],
      "properties": {
        "code": {
          "position": 0,
          "type": "integer",
          "format": "int32"
        },
        "description": {
          "position": 1,
          "type": "string"
        }
      }
    }
  },
  "basePath": "http://api.lmiforall.org.uk/api/v1"
}