Overview

Updated 11/18/2021

There are several ways that your posted jobs can be displayed on a website.  This article will cover the JSON Jobs Feed that Avionté offers for displaying jobs in a robustly customizable fashion.

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 > 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:

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

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 end point 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 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.

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 “reqID” parameter

https://myavionte.com/staff/jsonjobsv3.aspx?ID=YOURAPIKEY&proc=getsinglejob&reqID=JOBID

An 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);
	}
});

Here is a sample of what is returned when a call is made to the JSON endpoint for a single job:

{
 "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": "Select One",
 "Name": "Senior Java Developer",
 "Description": "Category: Select One - Location: Atlanta GA",
 "JobCity": "Atlanta",
 "Department": "",
 "Division": "",
 "Link": "https://buildname.myavionte.com/staff/consol_careers/careers_source.aspx?ref=\u0026jbID=null\u0026extref=null\u0026extu=null\u0026uri=localhost?cjobid=JU6549916",
 "ApplyLink": "http:// buildname.myavionte.com/staff/consol_careers/webapply_if.aspx?ID=97645\u0026ref=",
 "ApplyLinkSSL": "https://buildname.myavionte.com/staff/consol_careers/webapply_if.aspx?ID=97645\u0026ref=",
 "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 and Apply pages:

• The “Link” object is the URL for the job description
• The “ApplyLink” object is the URL for the Apply Page (HTTP)
• The “ApplyLinkSSL” object is the URL for the secure Apply Page (HTTPS)

We highly recommend 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.

Back to Top