Arbetsförmedlingen API client (Swedish Public Employment Service).
Index
- Installation
- Post job ad (a.k.a Direktöverförda annonser)
- API clients for
- Platsannonser/Platsbanken
- Ontology
- Taxonomy (SOAP)
- WSOccupation (SOAP)
- RDoc.
API Clients
Create a client:
client = Arbetsformedlingen::API::Client.new(locale: 'en')
Fetch all ads containing specified keyword:
ads = client.ads(keywords: 'ruby')
ads.map(&:title)
Fetch one ad:
ad = client.ad(id: 7408089)
ad.title
ad.occupation
ad.application.last_application_at
Fetch countries in area:
countries = client.countries(area_id: 2)
countries.map do |country|
"#{country.name} has #{country.total_vacancies} total vacancies."
end
Post job ad
⚠️ In order to post live job ads to Arbetsförmedlingen you need to contact them and go through a test procedure. You can find their own documentation and some additional notes here.
You can find Arbetsförmedlingens own documentation and some additional notes here. Note that the documentation provided by Arbetsförmedlingen can be pretty hard to follow.
Validation support All models used to create a job ad include validations. A lot of work was put into finding all the quirks in the API and adding each validation to its corresponding model. I can't recommend using it enough.
Complete example creating a packet
There's a lot of data you can/must send to the API when creating an ad. See files in lib/arbetsformedlingen/models
for details.
WSOccupation API Client
client = Arbetsformedlingen::API::WSOccupationClient.new
response = client.occupations
response.xml.css('Name').first.text
# => "Landskapsarkitekter och landskapsingenjörer"
WSOccupationClient
documentation.
🔗 Arbetsformedlingen WsOccupation API documentation
Ontology API Client
client = Arbetsformedlingen::API::OntologyClient.new
response = client.concepts(filter: 'ruby', type: 'skill')
response.json
# => [{"uuid"=>"035fc466-605e-5684-a106-a458929f27c6", "name"=>"Ruby", "type"=>"skill"}, ...]
🔗 Arbetsformedlingen Ontology API documentation
Taxonomy API Client
client = Arbetsformedlingen::API::TaxonomyClient.new
response = client.occupation_names(language_id: 502) # sv language id
response.xml.css('OccupationName Term').first.text
# => "1:e Fartygsingenjör/1:e Maskinist"
🔗 Arbetsformedlingen TaxonomiService API documentation
Notes
Arbetsförmedlingen TaxonomyService
Some requests had to be made to Arbetsförmedlingens TaxonomyService in order to fetch the data for the occupation codes. You can find that (plus some more) here 👇 Postman.
Terms translation table
This gem has translated the attribute names in Arbetsförmedlingens (AF) API from Swedish to English. You can find the translations below.
Arbetsförmedlingen Term | Gem term |
---|---|
landområde/värdsdel | areas |
kommun | municipality |
län | counties |
län2 | counties2 |
yrkesområde | occupational_fields |
yrkesgrupp | occupational_group |
yrkesgrupp | occupational_group |
yrkesnamn | occupation |
Installation
Add this line to your application's Gemfile:
gem 'arbetsformedlingen'
And then execute:
$ bundle
Or install it yourself as:
$ gem install arbetsformedlingen
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/buren/arbetsformedlingen.
License
The gem is available as open source under the terms of the MIT License.