Introduction
The jobs feed feature provides a feed of data for open, published jobs. This data can be used for a variety of purposes, such as displaying job listings on your website or integrating with other systems.
The base URL for the jobs feed is: https://portal.itris.app/opportunity/publish, but for any data to be returned, you’ll need to append some query parameters. The important ones to get you started are db, output and fields:
- The
dbparameter is a pointer to your itris X database and can be obtained from our Support Team. - The
outputparameter specifies the output format of the feed. The available formats arejson,xml, andhtml. - The
fieldsparameter is a comma-separated list of fields you want to include in the feed. A full list of available fields can be found below.
A working example of a jobs feed URL would look like this:
https://portal.itris.app/opportunity/publish?db=your_db&output=json&fields=title,location,salaryfrom,salaryper
Tip: Be sure to replace your_db with the database name advised by our Support Team.
Parameter Reference
* Required.
| Parameter | Description |
|---|---|
| db* | Your database name obtained from our Support Team. |
| fields* | A comma-separated list of fields to include in the feed. See below for a list of available fields. |
| output | The output format. The available formats are json, xml, and html. The default is html. |
| filters | A comma-separated list of filters to apply to the feed. See below for a list of available filters. |
| sorts | A comma-separated list of fields to sort the feed by. For example, to order by publish date descending you’d specify &sorts=publishdate%20desc. |
| start | The starting point for the feed. This is useful for pagination. |
| limit | The maximum number of records to return in the feed. |
Field Reference
The following fields are available to include in the feed, the majority of which can be found in the ‘Publish Job’ section of a job record.
| Field Name | Notes |
|---|---|
| benefits | |
| businesstype | |
| category | |
| city | |
| consultantemail | The email address for the “Main Contact” specified on the job’s publish settings. |
| consultantname | The name of the “Main Contact” specified on the job’s publish settings. |
| consultantphoto | The photo for the “Main Contact” specified on the job’s publish settings. |
| consultanttelephone | The telephone number for the “Main Contact” specified on the job’s publish settings. |
| creationdate | |
| lastupdated | The last modified date of the job record |
| department | |
| description | In HTML format. |
| duration | |
| jobtype | |
| linkregister | The URL for this jobs application page. |
| location | |
| postcode | |
| publishdate | |
| reference | The itris X ID for the job. |
| salaryfrom | |
| salaryper | |
| salaryto | |
| sector | |
| startdate | |
| state | |
| title | |
| worktype | |
| [customfieldname] | See below. |
Including Custom Fields
If you want to include a custom field associated to Jobs, please provide the custom field name as the field name with no spaces and in lower case.
For example, if you have a custom fields associated to Jobs called “Job Division” then you would use &fields=jobdivision.
Please ensure that your custom field names do not match any of those in the table above as the standard filters will always take precedence.
Filter Reference
The following filters are available to apply to the feed using the format filter|value e.g. &filters=worktype|Permanent.
| Filter Name | Description |
|---|---|
| businesstype | |
| department | |
| departmentwildcard | e.g. departmentwildcard|Health would include “Healthcare” and “Health” departments. |
| keywords | Text search on both title and description. |
| location | |
| reference | Useful for loading a single job record e.g. reference|JOB-1234. |
| sector | |
| user | The email address for the “Main Contact” specified on the job’s publish settings. |
| worktype | |
| [customfieldname] | See below. |
Filtering on Custom Fields
If you want to filter on a custom field associated to Jobs, please provide the custom field name as the filter name and the value as required from the custom field.
For example, if you have a custom fields associated to Jobs called “Division” then you would use &filters=Division|ABC.
Please ensure that your custom field names do not match any of those in the table above as the standard filters will always take precedence.