SG Developers Check if posting is available for basket
This endpoint is deprecated. Please do not use it for new projects. The documentation remains here for legacy API consumers.
Checking if a job posting is available for the basket
Request with tokens
To check if a job is available for the basket, one uses a GET-request with the /jobs/basket/{jobDbId}/available endpoint:
|
1 |
curl -i -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -X GET "https://api.softgarden.io/api/rest/v2/frontend/jobs/basket/{jobDbId}/available?cookie={cookie}" |
with TOKEN being either a client access token or a user access token. {cookie} must be set to the client’s cookie ID, for example ‘123456’ and {jobDbId} to the job that is to be checked. A cookie ID is neccessary when the user is not logged in (client access token) or the basket should be examined in a merged state (cookie and database stored).
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/jobs/basket/{jobDbId}/available?cookie={cookie}" |
{clientId} is the ID for your application to develop given to you by softgarden. The colon seen in the example is obligatory.
A job is “available” if it is not already in the basket and there is no application for it.
Path parameters
| Name | Description | Data Type |
|---|---|---|
| jobDbId | The ID of the job to be checked. | long |
Query parameters
| Name | Description | Data Type |
|---|---|---|
| cookie | The client’s cookie ID. | String |
Response values
| Upon | Returned value | Description |
|---|---|---|
| success | boolean | ‘true‘ if job is available, ‘false‘ otherwise |
| 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 |
true |