Executing a job search
Executing a job search
Request with tokens
The endpoint /jobboards/{channelID}/jobs allows for search operations.
1 |
curl -i -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -X GET "https://api.softgarden.io/api/rest/v2/frontend/jobboards/{channelID}/jobs?search={search}&geoLocation={geolocation}" |
with TOKEN being either a client access token or a user access token and {channelID} corresponding to the desired channel. The other two query parameters define the search. They may be empty respectively left out. When using a geolocation to limit the result, please take notice of the following. The geolocation refers to the position, not to the job advertisement rubrification. And of course the geolocation has to be set in the positions data.
The system will attempt to localize the search’s results, the locale is extracted from the header. In the curl example you can manipulate the header by adding -H “Accept-Language:{locale}”, whereat locale can be en, de and so on.
Request with basic authorization
As an alternative, you can use here the basic authorization method. Just write
1 |
curl -i -u "{clientId}:" -H "Content-Type: application/json" -X GET "https://api.softgarden.io/api/rest/v2/frontend/jobboards/{channelID}/jobs?search={search}&geoLocation={geolocation}" |
{clientId} is the ID for your application to develop given to you by softgarden. The colon seen in the example is obligatory.
Path parameters
Path parameters
Name | Description | Data Type |
---|---|---|
channelID | ID of the channel to search through. | String |
Query parameters
Name | Description | Data Type | Default Value |
---|---|---|---|
search | A string with the search content. | String | empty string |
geoLocation | Demanded geographic location, format ‘LatitudeAsRealNumber::LongitudeAsRealNumber::DistanceInKilometers‘. For more information see Wikipedia or a a tool for determining such a geotag. An example would be 52.520014::13.373006::50 for a radius of 50 kilometers around the German Bundestag building in Berlin. Additional job locations are also considered when this parameter is supplied. | String | empty string |
Response values
Upon | Returned value | Description |
---|---|---|
success | JSON-encoded JobSearchResult-object | Results of the search. |
failure | 500 – INTERNAL SERVER ERROR | When an error appears while processing your request. |
authorization error | 401 / 403 | See here for details. |
Example return value:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
{ "itemsPerPage": 65500, "numPages": 1, "offset": 0, "actualPage": 0, "firstPostingOnPage": 1, "lastPostingOnPage": 4, "totalNumberOfJobs": 4, "results": [ { "jobPostingId": 3351, "postingVersionId": 14904, "title": "API Testposition", "applyOnlineLink": "https://jobdb-tc.softgarden.de/jobdb/public/jobposting/applyonline/click?jp=3351&ADP", "config": { "ProjectLocation": ["4800067"], "ProjectNumber": ["924"], "audience": ["00006"], "ProjectLocationGerman": ["Saarbrücken"], "location": ["4800067"], "softgardenvisibility": ["visible"], "listingStartDate": ["1372370400000"], "internalPostingName": ["API Testposition"], "softgarden_internalAdText": ["<p> internal text </p>"], "jobcategory": ["d4d2f9707f0000022fc38d23ef0f1138"], "ProjectCompanyNameGerman": ["softgarden GmbH"], "sg_remote_status": ["FULLY_REMOTE"] }, "jobStartDate": 1372370400000, "postingVersionStartDate": 1372370400000, "postingVersionEndDate": 0 }, { "jobPostingId": 3201, "postingVersionId": 14832, "title": "Some jobposting", "applyOnlineLink": "https://jobdb-tc.softgarden.de/jobdb/public/jobposting/applyonline/click?jp=3201&ADP", "config": { "ProjectNumber": ["610"], "audience": ["00009"], "location": ["4800000"], "softgardenvisibility": ["visible"], "internalPostingName": ["Some jobposting"], "listingStartDate": ["1362610800000"], "jobcategory": ["d4d2f9707f0000022fc38d23ef0f1138"], "ProjectCompanyNameGerman": [""] }, "jobStartDate": 1362610800000, "postingVersionStartDate": 1362610800000, "postingVersionEndDate": 0 }, { ... }, { ... } ] } |