Displaying Posted Jobs via JSON Jobs API

Updated September 07, 2023 13:51

Once your careers page is up and running, users can easily post jobs to that page as well as multiple social networks, job aggregators and subscription sites like Monster and CareerBuilder. Furthermore, Avionte will insure you are leveraging the best services for your jobs by tracking where your applicants come from. This visibility will save you money on job ad spend while streamlining the hiring process and decreasing the time it takes to fill your open positions.

The JSON Jobs feed allows a web developer to pull as much or as little data from the feed as desired to create a highly customized careers page that is uniquely your own. Think of this as a replacement for viewing posted jobs and job descriptions in an iFrame. Next, the developer can utilize the Web Apply API to design and code every aspect of the apply page to your exact specifications. It requires more development and does not include all the web applicant workflow options, but it does provide the greatest flexibility and customization for the design of your apply page.

CHAPTERS

Locate API Key
Setup
Examples

Locate API Key

The JSON Jobs endpoint is located at http://www.myavionte.com/staff/jsonjobsv3.aspx.

Your API key can be found by going to Account & Settings (your avatar) > Utilities > Careers Page Editor (Job Board Editor). Your API key is used to identify your build to Avionté and is used by adding it to the end of your JSON Job Feed URL, like this:

Click on Account & Settings
Click on Utilities
Click on the Career Page Editor tile
Copy the API key from the Web Apply API Key field

Setup

Each build in Avionté comes with a JSON API endpoint (also referred to as a “feed”) and an API key. The API key is used to identify your build to Avionté. The JSON endpoint is a URL that will return data in JSON format for your Company’s posted jobs that a web developer can then use to set up a custom careers page.

We pass most of the details about each of your posted jobs in the JSON feed, including:

Division
Department
Location
Job Create Date
Job Country
Job City
Job State
Job Description in both HTML and TEXT
Board Name
Region
Office
Pay
Owner
Job Type
Job IDs
Title
Category
Various links to the job and apply process.
- As set up in the Careers Page Editor (job board editor)

Since all of this info is always in the JSON feed, your web developer can pull as much or as little data from the feed as is needed to create a highly customized Careers Page that is uniquely your own.

Examples

Note: The links used in the example will not work as it's just an example.

http://www.myavionte.com/staff/jsonjobsv3.aspx?ID=XgNViv56hnic0aLpVnLXbs==

This location will retrieve data for all Posted Jobs

https://myavionte.com/staff/jsonjobsv3.aspx?ID=YOURAPIKEY&proc=getalljobs

This location will retrieve data for a single job as designated in the “PostId20” parameter

https://myavionte.com/corp/jsonjobsv3.aspx?ID=YOURAPIKEY&proc=getsinglejob&postid=POSTID20

Example of how to use the JSON feed is below

$(document).ready(function () {
	var rssId = "YOUR_RSS_ID_GOES_HERE";
	var referralLocation = "YOUR_WEBSITE_URL_GOES_HERE";
	var buildId = "YOUR_BUILD_ID_GOES_HERE";
    $.ajax({
        type: 'GET',
        url: "http://www.myavionte.com/staff/jsonjobsv3.aspx?ID=" + rssId + "&refloc=" + referralLocation + "&proc=getalljobs",
        contentType: "application/json",
        dataType: 'jsonp',
        jsonpCallback: buildId,
        success: CompasJsonSuccessResult,
        error: CompasJsonErrorResult
    });
	
	function CompasJsonSuccessResult(json) {
		
		// Open up the browser developer tools and view the console window to see the results 
		// - Please remove before releasing to a production environment!
		console.log(json);
		alert("Success");
		
		// Example of adding all available Job Names to a list and appending them to body
		// - This will generate <ul class="my-new-list"><li id="0">Job Name 1</li><li id="1">Job Name 2</li>...<li id="N">Job Name N</li></ul>
		var items = [];
		$.each(json, function (key, val) {
			items.push('<li id="' + key + '">' + val.Name + '</li>');
		});
		$('<ul/>', {
			'class': 'my-new-li0st',
			html: items.join('')
		}).appendTo('body');
	}
	
	function CompasJsonErrorResult(e) {
		
		// Please remove before releasing to a production environment!
		alert("Error");
		console.log(e.message);
	}
});

Sample of what is returned when a call is made

JSON endpoint for a single job

{
 "PostDate": "2/2/2015 4:13:07 PM",
 "PostId20": "ZAfS7GXWOdU",
 "Region": "ABC Corp",
 "Office": null,
 "PayMin": "40.00",
 "PayMax": "60.00",
 "PayActual": "55.00",
 "Owner": null,
 "JobType": "Permanent",
 "SendFriend": null,
 "Location": null,
 "JobID": "ES6596816",
 "ReqID": "ES6548816",
 "JobDate": "1/6/2015",
 "JobCountry": "US",
 "JobState": "GA",
 "JobDesc_HTML": "HTML-FORMATTED JOB DESCRIPTION TEXT WILL BE HERE",
 "JobDesc_TEXT": "UN-FORMATTED JOB DESCRIPTION TEXT WILL BE HERE",
 "Category": "Engineering",
 "Name": "Senior Java Developer",
 "Description": "Category: Engineering - Location: Atlanta GA",
 "JobCity": "Atlanta",
 "Department": "",
 "Division": "",
 "Link": "https://myWebsite.com/careers/?cjobid=ES6548816&rpid=1&postid=ZAfS7GXWOdU",
 "ApplyLink": "http://buildname.myavionte.com/corp/consol_careers/webapply_if.aspx?ID=97645&ref=",
 "ApplyLinkSSL": "https://buildname.myavionte.com/corp/consol_careers/webapply_if.aspx?ID=97645&ref=",
 "Apply2Link": "https://myWebsite.com/careers/?postid=ZAfS7GXWOdU&direct=1"
 "BoardName": "Main Job Board"
 }

When a call is made to the Avionté JSON endpoint, each job item will include URLs for that job’s Description & Apply page:

The Link property is the URL for the Description
The Apply2Link property is the URL for the Apply Page

We require using these URLs in a programmatically created or “dynamic” Iframe. This will allow the applicant to complete the apply process for the job they have selected. See the article for implementing the Dynamically Created iFrame.

Click on the links below for more information:

Related to:

Careers Page

Articles in this section