Last active
May 14, 2016 14:13
-
-
Save joetm/77478af453e4a80f07016bcc6944d9b5 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "apiVersion": "1.0.0", | |
| "swaggerVersion": "1.2", | |
| "resourcePath": "/wf", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "protocols": [ | |
| "http" | |
| ], | |
| "apis": [ | |
| { | |
| "path": "/wf/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": "/wf/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": "/wf/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": [ | |
| "qualification", | |
| "industry", | |
| "status", | |
| "region", | |
| "gender" | |
| ] | |
| } | |
| ], | |
| "type": "LFSFilterInfo" | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/wf/predict", | |
| "operations": [ | |
| { | |
| "method": "GET", | |
| "summary": "Get a Working Futures prediction about a job: how many people will be employed in this job?", | |
| "position": 0, | |
| "notes": "", | |
| "deprecated": false, | |
| "nickname": "predictEmployment", | |
| "parameters": [ | |
| { | |
| "name": "soc", | |
| "description": "The job's SOC code.", | |
| "required": true, | |
| "paramType": "query", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "minYear", | |
| "description": "Minimum year to predict (2014-2022)", | |
| "required": false, | |
| "paramType": "query", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "maxYear", | |
| "description": "Maximum year to predict (2014-2022)", | |
| "required": false, | |
| "paramType": "query", | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "type": "WFPrediction" | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/wf/predict/breakdown/{filter}", | |
| "operations": [ | |
| { | |
| "method": "GET", | |
| "summary": "Get a Working Futures prediction about a job and break it down across a filter.", | |
| "position": 0, | |
| "notes": "", | |
| "deprecated": false, | |
| "nickname": "predictEmploymentBreakdown", | |
| "parameters": [ | |
| { | |
| "name": "soc", | |
| "description": "The job's SOC code.", | |
| "required": true, | |
| "paramType": "query", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "minYear", | |
| "description": "Minimum year to predict (2014-2022)", | |
| "required": false, | |
| "paramType": "query", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "maxYear", | |
| "description": "Maximum year to predict (2014-2022)", | |
| "required": false, | |
| "paramType": "query", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "filter", | |
| "description": "Break prediction down across one of the filters.", | |
| "required": true, | |
| "paramType": "path", | |
| "type": "string", | |
| "enum": [ | |
| "qualification", | |
| "industry", | |
| "status", | |
| "region", | |
| "gender" | |
| ] | |
| } | |
| ], | |
| "type": "WFBreakdownPrediction" | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/wf/replacement_demand", | |
| "operations": [ | |
| { | |
| "method": "GET", | |
| "summary": "Get replacement demand rates for a SOC 2-digit occupation.", | |
| "position": 0, | |
| "notes": "The Replacement Demand rate indicates the percentage of the workforce that has to be replaced each year within a certain timeframe due to mortality, retirement, career moves or other reasons.", | |
| "deprecated": false, | |
| "nickname": "getReplacementDemandRate", | |
| "parameters": [ | |
| { | |
| "name": "soc", | |
| "description": "SOC 2-digit code of the occupation. 4 digits will be truncated automatically.", | |
| "required": true, | |
| "paramType": "query", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "filters", | |
| "description": "You can filter this query by specifying one each of industry, region or gender. Example: 'region:4|gender:1'", | |
| "required": false, | |
| "paramType": "query", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "startYear", | |
| "description": "Start of replacement time period (default 2014).", | |
| "required": false, | |
| "paramType": "query", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "endYear", | |
| "description": "End of replacement time period (default 2022).", | |
| "required": false, | |
| "paramType": "query", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "accessKey", | |
| "description": "This query is under development; put in the access key to use it.", | |
| "required": true, | |
| "paramType": "query", | |
| "type": "string" | |
| } | |
| ], | |
| "type": "void" | |
| } | |
| ] | |
| } | |
| ], | |
| "models": { | |
| "WFBreakdownPrediction": { | |
| "id": "WFBreakdownPrediction", | |
| "name": "WFBreakdownPrediction", | |
| "qualifiedType": "org.careersdata.lmiforall.api.WFBreakdownPrediction", | |
| "required": [ | |
| "soc", | |
| "breakdown", | |
| "predictedEmployment" | |
| ], | |
| "properties": { | |
| "soc": { | |
| "position": 0, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "breakdown": { | |
| "position": 1, | |
| "type": "string" | |
| }, | |
| "predictedEmployment": { | |
| "position": 2, | |
| "type": "array", | |
| "items": { | |
| "$ref": "WFYearBreakdown" | |
| } | |
| } | |
| } | |
| }, | |
| "WFYearBreakdown": { | |
| "id": "WFYearBreakdown", | |
| "name": "WFYearBreakdown", | |
| "qualifiedType": "org.careersdata.lmiforall.api.WFYearBreakdown", | |
| "required": [ | |
| "year", | |
| "breakdown" | |
| ], | |
| "properties": { | |
| "year": { | |
| "position": 0, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "breakdown": { | |
| "position": 1, | |
| "type": "array", | |
| "items": { | |
| "$ref": "WFBreakdown" | |
| } | |
| } | |
| } | |
| }, | |
| "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" | |
| } | |
| } | |
| }, | |
| "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" | |
| } | |
| } | |
| } | |
| }, | |
| "WFYear": { | |
| "id": "WFYear", | |
| "name": "WFYear", | |
| "qualifiedType": "org.careersdata.lmiforall.api.WFYear", | |
| "required": [ | |
| "year", | |
| "employment" | |
| ], | |
| "properties": { | |
| "year": { | |
| "position": 0, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "employment": { | |
| "position": 1, | |
| "type": "number", | |
| "format": "float" | |
| } | |
| } | |
| }, | |
| "WFBreakdown": { | |
| "id": "WFBreakdown", | |
| "name": "WFBreakdown", | |
| "qualifiedType": "org.careersdata.lmiforall.api.WFBreakdown", | |
| "required": [ | |
| "code", | |
| "name", | |
| "employment" | |
| ], | |
| "properties": { | |
| "code": { | |
| "position": 0, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "position": 1, | |
| "type": "string" | |
| }, | |
| "employment": { | |
| "position": 2, | |
| "type": "number", | |
| "format": "float" | |
| } | |
| } | |
| }, | |
| "WFPrediction": { | |
| "id": "WFPrediction", | |
| "name": "WFPrediction", | |
| "qualifiedType": "org.careersdata.lmiforall.api.WFPrediction", | |
| "required": [ | |
| "soc", | |
| "predictedEmployment" | |
| ], | |
| "properties": { | |
| "soc": { | |
| "position": 0, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "predictedEmployment": { | |
| "position": 1, | |
| "type": "array", | |
| "items": { | |
| "$ref": "WFYear" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "basePath": "http://api.lmiforall.org.uk/api/v1" | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment