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.

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,

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

{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

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



Comments are closed.