Last active
May 14, 2016 14:12
-
-
Save joetm/38aa990d734ef7a3e556946766e40e4d to your computer and use it in GitHub Desktop.
This file contains hidden or 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": "/vacancies", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "protocols": [ | |
| "http" | |
| ], | |
| "apis": [ | |
| { | |
| "path": "/vacancies/search", | |
| "operations": [ | |
| { | |
| "method": "GET", | |
| "summary": "Search for vacant positions in the Universal Jobmatch databases.", | |
| "position": 0, | |
| "notes": "The Universal Jobmatch databases are not part of the LMI For All project. The Department for Works and Pensions maintains this data.", | |
| "deprecated": false, | |
| "nickname": "search", | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "description": "Limit results to this many entries. Default and maximum is 50.", | |
| "required": false, | |
| "paramType": "query", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "radius", | |
| "description": "Search radius around postcode (default: 50).", | |
| "required": false, | |
| "paramType": "query", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "postcode", | |
| "description": "Post code. If given, restrict results to a radius around this postcode.", | |
| "required": false, | |
| "paramType": "query", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "keywords", | |
| "description": "Keywords to search for; may be combined with the special operators AND, OR and NEAR.", | |
| "required": true, | |
| "paramType": "query", | |
| "type": "string" | |
| } | |
| ], | |
| "type": "array", | |
| "items": { | |
| "$ref": "Vacancy" | |
| } | |
| } | |
| ] | |
| } | |
| ], | |
| "models": { | |
| "Vacancy": { | |
| "id": "Vacancy", | |
| "name": "Vacancy", | |
| "qualifiedType": "org.careersdata.lmiforall.api.Vacancy", | |
| "required": [ | |
| "id", | |
| "title", | |
| "summary", | |
| "company", | |
| "activedate", | |
| "location" | |
| ], | |
| "properties": { | |
| "id": { | |
| "position": 0, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "title": { | |
| "position": 1, | |
| "type": "string" | |
| }, | |
| "summary": { | |
| "position": 2, | |
| "type": "string" | |
| }, | |
| "company": { | |
| "position": 3, | |
| "type": "string" | |
| }, | |
| "activedate": { | |
| "position": 4, | |
| "$ref": "VacancyDateRange" | |
| }, | |
| "location": { | |
| "position": 5, | |
| "$ref": "VacancyLocationInfo" | |
| } | |
| } | |
| }, | |
| "VacancyLocationInfo": { | |
| "id": "VacancyLocationInfo", | |
| "name": "VacancyLocationInfo", | |
| "qualifiedType": "org.careersdata.lmiforall.api.VacancyLocationInfo", | |
| "required": [ | |
| "city", | |
| "area", | |
| "postcode", | |
| "country" | |
| ], | |
| "properties": { | |
| "city": { | |
| "position": 0, | |
| "type": "string" | |
| }, | |
| "area": { | |
| "position": 1, | |
| "type": "string" | |
| }, | |
| "postcode": { | |
| "position": 2, | |
| "type": "string" | |
| }, | |
| "country": { | |
| "position": 3, | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "VacancyDateRange": { | |
| "id": "VacancyDateRange", | |
| "name": "VacancyDateRange", | |
| "qualifiedType": "org.careersdata.lmiforall.api.VacancyDateRange", | |
| "required": [ | |
| ], | |
| "properties": { | |
| "start": { | |
| "position": 0, | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "end": { | |
| "position": 0, | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "updated": { | |
| "position": 0, | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| } | |
| }, | |
| "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