LMIforAll Apprenticeships

{"apiVersion":"1.0.0","swaggerVersion":"1.2","resourcePath":"/apprenticeships","produces":["application/json"],"consumes":["application/json"],"protocols":["http"],"apis":[{"path":"/apprenticeships/find","operations":[{"method":"GET","summary":"Get apprenticeship programmes by either SOC code, programme code, or a text search.","position":0,"notes":"You must provide exactly one of the <code>soc</code>, <code>code</code> or <code>search</code> parameters.","deprecated":false,"nickname":"find","parameters":[{"name":"search","description":"Text search.","required":false,"paramType":"query","type":"string"},{"name":"code","description":"Apprenticeship programme code.","required":false,"paramType":"query","type":"string"},{"name":"soc","description":"SOC code.","required":false,"paramType":"query","type":"integer","format":"int32"},{"name":"accesskey","description":"This query is not public yet. Provide your access key.","required":true,"paramType":"query","type":"string"}],"type":"array","items":{"$ref":"ApprProgramme"}}]},{"path":"/apprenticeships/regions","operations":[{"method":"GET","summary":"Get a mapping of AvLive region codes.","position":0,"notes":"The returned JSON object contains 3 mappings: counties, local_authorities and regions.","deprecated":false,"nickname":"getRegions","parameters":[],"type":"void"}]},{"path":"/apprenticeships/vacancies","operations":[{"method":"GET","summary":"Get vacancies for an apprenticeship programme or SOC code from Av Live.","position":0,"notes":"You can search for vacancies either nationally (these are available all over the country) or regionally. To search regionally, you must give the name of a city, town or administrative region. City and town names are very specific; misspelling even slightly will lead to zero results. Be aware that the search takes a few seconds (sometimes up to 10), so it's best to display a loading indicator in your app.","deprecated":false,"nickname":"getVacancies","parameters":[{"name":"region","description":"A region code (from /regions), a numerical region code (e.g. from ASHE), or the name of a town. Leave empty for nationally available vacancies.","required":false,"paramType":"query","type":"string"},{"name":"programme","description":"Apprenticeship programme code (from /find).","required":false,"paramType":"query","type":"string"},{"name":"accesskey","description":"This query is not public yet. Provide your access key.","required":true,"paramType":"query","type":"string"}],"type":"void"}]}],"models":{"ApprProgramme":{"id":"ApprProgramme","name":"ApprProgramme","qualifiedType":"org.careersdata.lmiforall.api.ApprProgramme","required":["name","code","levels"],"properties":{"name":{"position":0,"type":"string"},"socs":{"position":0,"type":"array","items":{"$ref":"Object"}},"code":{"position":1,"type":"string"},"levels":{"position":2,"type":"array","items":{"type":"integer","format":"int32"}}}}},"basePath":"http://api.lmiforall.org.uk/api/v1"}