SG Developers Get Jobboard
Getting a jobboard
Request with tokens
By appending a channel’s ID to a /jobboards endpoint in a GET-request, one can access an individual jobboard, namely the one on the given channel. The result of the /jobboards/{channelID} request is a Jobboard-object.
|
1 |
curl -i -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -X GET "https://api.softgarden.io/api/rest/v2/frontend/jobboards/{channelId}" |
with TOKEN being either a client access token or a user access token and {channelId} corresponding to the desired channel.
The system attempts to localize the resulting Jobboard using information from the header.
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}" |
{clientId} is the ID for your application to develop given to you by softgarden. The colon seen in the example is obligatory.
Path parameters
| Name | Description | Data Type |
|---|---|---|
| channelID | The ID of the desired channel. Can be obtained via /jobboards. | String |
Query parameters
– none –
Response values
| Upon | Returned value | Description |
|---|---|---|
| success | JSON-encoded Jobboard-object | The desired jobboard. |
| failure | 500 – INTERNAL SERVER ERROR | When an error appears while processing your request. |
| authorization error | 401 / 403 | See here for details. |
Example return value for {channelId}=”5535_extern”
|
1 2 3 4 5 |
{ "id": "5535_extern", "name": "Website", "accessible": true } |