SG Developers Getting a channel’s definition
This endpoint is deprecated. Please do not use it for new projects. The documentation remains here for legacy API consumers.
Obtaining the definition of a jobboard channel
Request with tokens
The endpoint /jobboards/{channelID}/config returns a channel’s definition. For historical reasons, this endpoint both supports the JSON as well as the XML content type. You have to specify the desired content type in your Content-Type-header. To define the language of the catalog options on the channel definition, please set the ‘Accept-Language’ header.
|
1 |
curl -i -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -X GET "https://api.softgarden.io/api/rest/v2/frontend/jobboards/{channelID}/config" |
with TOKEN being either a client access token or a user access token and {channelID} corresponding to the desired channel will result in a json representation,
|
1 |
curl -i -H "Authorization: Bearer TOKEN" -H "Content-Type: application/xml" -X GET "https://api.softgarden.io/api/rest/v2/frontend/jobboards/{channelID}/config" |
will result in the xml form (as in the example below)
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}/config" |
{clientId} is the ID for your application to develop given to you by softgarden. The colon seen in the example is obligatory. Or, for the sake of completeness, use
|
1 |
curl -i -u "{clientId}:"-H "Content-Type: application/xml" -X GET "https://api.softgarden.io/api/rest/v2/frontend/jobboards/{channelID}/config" |
for the xml form.
Path parameters
Path parameters
| Name | Description | Data Type |
|---|---|---|
| channelID | ID of the desired channel. Can be obtained via /jobboards. | String |
Query parameters
– none –
Response values
| Upon | Returned value | Description |
|---|---|---|
| success | String | The channel’s definition in XML or null if no definitions for the locale could be found. |
| failure | 500 – INTERNAL SERVER ERROR | When an error appears while processing your request. |
| authorization error | 401 / 403 | See here for details. |
Example return value using “de”-locale and XML content type
|
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 |
<!--?xml version="1.0" encoding="UTF-8" standalone="yes"?--> <form><select>softgardenvisibility </select><label> In der Jobsuche show in jobsearch </label><select>1 false true maximal 1 Element(e) 1 <option>visible</option> </select><label> anzeigen yes </label><select> <option></option> <option>hidden</option> </select><label> nicht anzeigen no </label><select> <option></option>visible hidden </select><select>audience </select><label> Zielgruppe audience </label><select>2 false true maximal 1 Element(e) 1 <option>00001</option> </select><label> Auszubildende </label><select> <option></option> <option>00002</option> </select><label> Praktikanten </label><select> <option></option> <option>00009</option> </select><label> Werkstudent </label><select>jobcategory </select><label> Jobkategorie jobcategory </label><select>3 false true maximal 1 Element(e) 1 <option>d4d2f9707f0000022fc38d23ef0f1138</option> </select><label> Ausbildung </label><select> <option></option> <option>00010</option> </select><label> Logistik </label><select> <option></option> <option>00008</option> </select><label> Marketing / Vertrieb </label><select> <option></option> <option>00003</option> </select><label> Produktion </label> location <label> Standort location </label> 4 false true Bitte auswählen! 4800002 <div><label> Berlin </label></div> 4800067 <div><label> Saarbrücken </label></div> </form> |