1300 045 422
support@performzone.com
Facebook
LinkedIn
PERFORM ZONE
  • Employers
    • Post-a-job
      • About
      • Pricing
    • Accounts Login
    • Workshops
      • All Workshops
      • Blogs
    • Recruitment Software
      • Take a Tour
      • Book a Demo
      • User Manual
      • Login
      • Accounts
    • Vender Manager
  • Job Seekers
    • Search Jobs
    • Workshops
      • All Workshops
      • Blogs
    • Job Trends
  • Recruiters
    • Recruitment Software
      • Take a Tour
      • Book a Demo
      • User Manual
      • Login
      • Accounts
    • Workshops
    • Become a supplier
    • Open tenders
  • Login
    • Recruitment Software
    • Seeking Employment

API Functions

Career Centre, User ManualMarch 31, 2017pzlogin

API Functions

Function Name Parameters Description
GetJobInfo accesskey – string access key provided by PZ technical support.
jobID – integer ID of job in PZ system.
This returns the detailed information about a single job – for example the title, advert HTML code, location etc.
SearchJobs Accesskey – string access key provided by PZ technical support. Search parameters – various parameters to search on – elaborated further in below this summary table. This returns a list of jobs based on the requested search parameters, or returns all jobs in your PZ system, if no parameters are sent through.
CreateApplication Accesskey – string access key provided by PZ technical support.
jobID – integer ID of job in PZ system.
Email address of candidate ID – used to uniquely identify a candidate in the system. Fields used to create this application, more information below. This attempts to create a new application for a job, combining candidate information and a job ID. If a candidate with matching email address doesn’t already exist in the system, the web service will create them.
UpdateApplication Accesskey – string access key provided by PZ technical support. Application ID – used to uniquely identify the application to update. Fields used to update this application, more information below. This updates the details of an application – it is used in multi page application processes.
GetFieldList No input parameters Any web services that take field/subfield values operate on codes only, not on labels (the text that usually shows in Perform Zone) – since your field list is customizable in settings, it may be required that your web site regularly gets updates of your Perform Zone field list, to keep your website in sync with your Perform Zone.

Functions Specifications

Function: GetJobInfo

Description: A job ID from the PZ system is sent to the web service, and the web service sends a data set back with a set of information about the job from within the PZ database.

Calling Parameters:

Field Description Type Example
accesskey Key given to you by technical support to allow you to authenticate with the web service system. string Shjgdfkdj353
jobid ID of the job within the database whose details to return. int 25

Returned Data:

Field Description Type Example
errorcode Number of the error – see appendix for full list and description. int 111
error Text description of error. String Internal server error.
id The job ID in PZ. int 25
jobtitle The position title. String My Job
adverthtml The HTML for the MySite job created in the system. String This is job description with html tags.
jobcityarea A code referring to the city area list in the MySite details. String 1
jobstate A code for the state the job is in. String Vic
jobsuburb Suburb of job String Melbourne
jobcountry 2 letter ISO code for the country of this job. String AU
salary The text salary field entered in MySite String $40K+bonus
teaser The web teaser for MySite. String Here is a little summary to make you want the job
worktype A code for the type of work this job is. String permft
field The field code form your database, this job is set to. (the ‘field’ setting in MySite job board information) String 23
subfield The specialisation for the above field, set in MySite job board information. String 5

Function: SearchJobs

Description: A set of search parameters relating to fields in the PZ system is sent to the web service, and the web service sends an array data set back with a summary set of information about each job matching the search within the PZ database.

Calling Parameters: There is one structure called ‘searchParams’ which includes at least the first 3 of the following list of tags (the actual search parameters like keyword, status etc are optional):

Field Description Type Example
accesskey Key given to you by technical support to allow you to authenticate with the web service system. string Shjgdfkdj353
offset Offset and limit work the same as an SQL query – if 25 jobs are available and offset=10 and limit=5, then the result array will start from the 10th job and return 5 jobs. int 10
limit See above int 5
Status The status to search on – ‘all’ returns all jobs regardless of advertising status. ‘Advertised’ is the default and only returns jobs whose MySite is setup. string Advertised
country The jobs country as a 2 letter ISO code. String AU
keyword A string keyword to search job information on. String manager

Returned Data:

Field Description Type Example
errorcode Number of the error – see appendix for full list and description. int 111
error Text description of error. String Internal server error.
jobs Array of tns:job structures with basic summary info of each job returned from the web service. For this structure see below. array See below.

The job structure: (all fields are lower case)

Field Description Type Example
id ID of the job Int 25
jobtitle Position title of the job String My new job
jobcountry Country the job is located in – represented in standard 2 letter ISO code. String AU
salary Display salary of the job String $25K+bonus
teaser Teaser about the job String This is a very interesting job…
Worktype Code for what type of work the job is (see appendix for codes) string Permft

Function: CreateApplication

Description: This call attempts to create a brand new application linking a candidate in the system, with a job. Each candidate can only apply for each job once. There are 2 options for uniquely identifying candidate in the database – candidate ID or email address. If candidate ID is not equal to -1, this ID is used as the candidate in the database. If it is -1, then the email address is searched for in the database, and the first matching candidate is used (even if they have been deleted or archived).

Calling Parameters:

Field Description Type Example
accesskey Key given to you by technical support to allow you to authenticate with the web service system. string Shjgdfkdj353
jobid ID of the job within the database to create an application for. int 25
candid ID of the candidate this job is for. If candidate ID is set to -1, the system will attempt to search for a current candidate using the email address provided. If none is found it will create a new candidate for this application. int 551
email An email address for the applicant. string Boss@pz.com
firstname The first name of the applicant. string bob
surname The last name of the applicant. String smith
resumedata The resume binary in base64 encoded format. String (base64 encoding)
resumename The file name of the resume uploaded to the web site. String Myresume.doc
coverdata The cover letter in base64 encoded format. String (base64 encoding)
covername The file name of the cover letter uploaded to the web site. String MyCoverLetter.doc
mobile Mobile phone number String 0408000000
homephone Home phone number String 12345678
country 2 letter ISO standard country code of this candidate String AU
state 3 letter state code – see appendix for Perform Zone’s state codes. String Vic
password The candidates password – for if you have a candidate login system on your Career Centre. String hellopassword
workphone Work contact phone number String 87654321
visastatus Code for the Visa status of this candidate. The appendix shows all valid codes. String auscit
secclearance Code for the security clearance level of this candidate. The appendix shows all valid codes. String restricted
idealrole Text the candidate has entered describing their ideal role. This text will be added to the text previously entered into your database. String Looking for role where I can move up.
optin The marketing email opt in status. This relates to the candidate marketing information opt in/opt out in the interface. no = opt out, yes = opt in. String yes
newsletter Relates to the ‘wants newsletter’ (yes or no) option in the interface. Which allows you to send a marketing newsletter to any candidates that would like it. String yes
source The internal code for the source this application has come from. Appendix has a list of the common codes, but specific codes can be setup for each of our clients, so your list may vary form the standard one. int 1
suburb Suburb this candidate is from String Melbourne
street Street address for this candidate String 230 Church St
yeargrad This is the year the applicant graduated from their highest qualification. It is available as a merge field for documents. Int 2010
qualification This is a text description of the candidate’s highest qualification. String MBA
appstatue This allows you to set the applications status on creation or on update. Currently only the ‘reject’ status is supported – allowing you to reject an application automatically in the system. This is useful if you want to record the application in Perform Zone, but want to reject it automatically as the applicant’s answers don’t meet the minimum requirements of the job; ie – country must be ‘Australia’ for example. String reject
jobalertfield The next 3 fields are for composite job alerts. This is for creating a set of job alerts mixing several field settings at once. So if candidate wants alerts for Australia and New Zealand and for anything in IT, you can set the ‘jobalertfield’ to your code for ‘IT’, and list 2 countries in ‘jobalertlocation’ and the web service will create 2 alerts for that candidate – one for IT jobs in Australia, the other for IT jobs in New Zealand.

Field formats are “Field:SubField|Field:SubField” so you can send a list of field/subfield codes through at once – codes must not have colons (:) or pipes (|) in them.

It is important to note that codes are sent through, not the descriptive text you see in the Perform Zone interface. Codes can sometimes be text (not necessarily numbers).

String 24:3|35:4|IT:Programmer
jobalertlocation See ‘jobalertfield’ for general description. Location is expressed in a list of country:state, or country by itself. Different country:state or country values are separated by a pipe (|). Countries are 2 letter standard ISO codes, states for Australia are defined in appendix. States for other countries may be provided on request. String AU:NSW|AU:SA|NZ
jobalertworktype See ‘jobalertfield’ for general description. Can be ‘perm’, ‘contract’ or ‘perm:contract’. String perm
sendconfirm Whether the system should send out a standard application confirmation email. This email can be setup from within settings on a client’s Perform Zone. This will send out this email in the standard way, recording a comment to the database, and logging information. It also allows merge fields. Clients are free to not use this system, however, and create their own confirmation emails from their server directly. The benefit of this may be greater control over the emails contents – for example you may want to embed images or attach a document, neither of which 3hats can do with the standard confirmation letter. String yes
skills An array of the skill structure defining a list of skills to be added to candidates. These are often used in relation to job skills entered in the job description section of Perform Zone – so they match the desired skills of the job. See the candidate skills structure table below this one to get a definition of each skills structure. Array (see skills structure table below)
jobalerts An array of the job alert structure, defining what type of jobs the candidate wants to receive an automated job alert email about. (these must be setup within the Perform Zone system – see the manual or contact support) Array (see job alerts structure table below)
poll A structure defining the answer to a poll question. This is a client specific extension and not generally available to clients at this stage.

Skills structure:

Field Description Type Example
skill Text short description of the skill. String .Net
comment The candidate’s description of their skills. String Have worked on web sites using C#.
yearsexp Total years commercial experience the candidate claims to have. Int 5
qualification The candidate’s qualification level in this field, if necessary. String B Sc.
yesno For skills which require a yes or no answer – for example ‘do you have a driver’s license?’. String yes

 

Job Alerts structure:

Field Description Type Example
field The code of the field of jobs the candidate is searching for. String 12
subfield The code of the specialisation of jobs the candidate is searching for. String 4
worktype The type of work they are looking for – either ‘contract’, or ‘perm’ for permanent work. String perm
state The state code for the jobs they are looking for. See appendix for Australian state codes. String NSW
country The 2 letter ISO country code for the country the jobs they are looking for are in. String AU

Returned Data:

Field Description Type Example
errorcode Number of the error – see appendix for full list and description. int 111
error Text description of error. String Internal server error.
appid The internal application table primary key ID from your database. Will be unique for each application created. int 5234
candid The internal candidate table primary key ID from your database. Will be unique for each candidate created. int 3245

Function: UpdateApplication

Description: This call is essentially the same as CreateApplication above, except it takes an application ID (which is returned by CreateApplication) and doesn’t take a candidate ID or a job ID – where these are needed it gets them from the already created application record. It updates the data in the application – all the same fields as in CreateApplication are available for updating. It is used for creating multi page applications (this is where the web site application process is broken into several web pages).

Calling Parameters:

Field Description Type Example
accesskey Key given to you by technical support to allow you to authenticate with the web service system. string Shjgdfkdj353
appid ID of the application within the database whose details to update. int 300

Returned Data:

Field Description Type Example
errorcode Number of the error – see appendix for full list and description. int 111
error Text description of error. String Internal server error.

Function: GetFieldList

Description: Any web services that take field/subfield values operate on codes only, not on labels (the text that usually shows in Perform Zone) – since your field list is customizable in settings, it may be required that your web site regularly gets updates of your Perform Zone field list, to keep your website in sync with your Perform Zone.

The GetFieldList service call gets an array of arrays of your current field/subfield list.

Calling Parameters:

No calling parameters are required.

Returned Data:

Field Description Type Example
field Text description of the field. String Mining
code code referring to the field. String Mng
subfield An array of all subfields in this field. Array Array

Subfield array structure:

Field Description Type Example
subfield Text description of the subfield. String Coal
code code referring to the subfield. String 123

 

 

How do I style the candidate page (cand.php)?

The candidate page allows candidates who have been registered with your site to login and change their details themselves – change contact information and update resumes for example.
It uses the template ‘cand.tpl’, so the default template for this gives examples showing how this page works.

How do I style the jobs list page(jobs.php)?

The jobs list page does a search of all your available jobs using search parameters sent via HTML variables, and gives the page a list of active jobs with basic details about those jobs. It uses the ‘jobs.tpl’ for its template.

Checkout the default ‘jobs.tpl’ for details on the variables available for the job information you can display.

Check the default page ‘jobsearch.tpl’ for details about sending the search variables. Below are how to setup the search variable select lists.

Searching on Country

To create a country selection list which allows the user to search on the country of a job, use the following Smarty template code.

<select class=”searchSelect” name=”searchcountry” id=”searchcountry” onchange=”getLocationList(‘searchlocation’, ‘searchcountry’)”>

{foreach key=key item=item from=$countryListVals}
{if $item == $jobSearchCountry}
<option label=”{$countryList[$key]}” value=”{$item}” selected>{$countryList[$key]}</option>
{else}
<option label=”{$countryList[$key]}” value=”{$item}”>{$countryList[$key]}</option>
{/if}
{/foreach}

</select>

Please Note:

The ‘onchange’ handler is optional – you must include the javascript file ‘js/comms.js’ in your page if you want to use it. It uses AJAX to fetch a list of states for the chosen country and sets this list in the select control named ‘searchlocation’ (which you must add in also).

The ‘name’ must be ‘searchcountry’ – this is what the code behind the page uses when it does its country search.

Searching on Active Country

There is a second country list that can be used to seed the country search – this is the ‘active’ country list. Only the countries that have currently active jobs with adverts assigned to them will be shown in this list.

To create a country selection list which allows the user to search on the country of a job, use the following Smarty template code.

<select class=”searchSelect” name=”searchcountry” id=”searchcountry” onchange=”getLocationList(‘searchlocation’, ‘searchcountry’)”>

{foreach key=key item=item from=$activeCountryListVals}
{if $item == $jobSearchCountry}
<option label=”{$activeCountryList[$key]}” value=”{$item}” selected>{$activeCountryList[$key]}</option>
{else}
<option label=”{$activeCountryList[$key]}” value=”{$item}”>{$activeCountryList[$key]}</option>
{/if}
{/foreach}

</select>

Please Note:

The ‘onchange’ handler is optional – you must include the javascript file ‘js/comms.js’ in your page if you want to use it. It uses AJAX to fetch a list of states for the chosen country and sets this list in the select control named ‘searchlocation’ (which you must add in also).

The ‘name’ must be ‘searchcountry’ – this is what the code behind the page uses when it does its country search.

Searching on State

To search on state, we should already have the country list. Perform Zone has a partial list of all states connected to their countries and can use AJAX to fetch them. Use the country search above with this code below to achieve a state search:

<select class=”searchSelect” name=”searchlocation” id=”searchlocation”>

{foreach key=key item=item from=$locationListVals}
{if $item == $jobSearchLocation}
<option label=”{$locationList[$key]}” value=”{$item}” selected>{$locationList[$key]}</option>
{else}
<option label=”{$locationList[$key]}” value=”{$item}”>{$locationList[$key]}</option>
{/if}
{/foreach}

</select>

Searching on Region

You can also search on the region in the world a job is in. Perform Zone has a list of regions and countries connected with those regions. It can use AJAX to fetch the countries associated with a region – to do this use the code below:
<select class=”searchSelect” name=”searchregion” id=”searchregion” onchange=”getCountryList(‘searchregion’, ‘searchcountry’, ‘searchstate’, ‘searchlocation’)”>

{foreach key=key item=item from=$regionListVals}
{if $item == $jobSearchRegion}
<option label=”{$regionList[$key]}” value=”{$item}” selected>{$regionList[$key]}</option>
{else}
<option label=”{$regionList[$key]}” value=”{$item}”>{$regionList[$key]}</option>
{/if}
{/foreach}

</select>

Please Note:

The ‘onchange’ handler is optional – it triggers an AJAX call which gets a list of all countries for the selected region. You must include ‘js/comms.js’ in your page for this to work.

Searching on Employer Industry

The search shows jobs based on industry of employer posting that job. Use the following code to do this:

<select class=”searchSelect” name=”clientindustries” id=”clientindustries” >
<option value=”” label=”Any”>Any</option>
{foreach key=key item=item from=$clientIndustryListVals}
{if strtolower($item) == strtolower($clientindustries)}
<option label=”{$clientIndustryList[$key]}” value=”{$item}” selected>{$clientIndustryList[$key]}</option>
{else}
<option label=”{$clientIndustryList[$key]}” value=”{$item}”>{$clientIndustryList[$key]}</option>
{/if}
{/foreach}

</select>

Search on Job Field

This search shows jobs based on what Field the Job is in.
Use the following code for this:

<select class=”searchSelect” name=”searchindustry” id=”searchindustry” onchange=”getJobTypeList(‘searchindustry’, ‘searchjobtype’)”>

{foreach key=key item=item from=$industryListVals}
{if strtolower($item) == strtolower($jobSearchIndustry)}
<option label=”{$industryList[$key]}” value=”{$item}” selected>{$industryList[$key]}</option>
{else}
<option label=”{$industryList[$key]}” value=”{$item}”>{$industryList[$key]}</option>
{/if}
{/foreach}

</select>

Search on Job Field & Job Field Specialisation

This search allows the jobseeker to drill down on Job Field Specialisation after selecting the Job Field.
Use the following code for this:

<select class=”searchSelect” name=”searchjobtype” id=”searchjobtype”>

{foreach key=key item=item from=$functionListVals}
{if strtolower($item) == strtolower($jobSearchJobType)}
<option label=”{$functionList[$key]}” value=”{$item}” selected>{$functionList[$key]}</option>
{else}
<option label=”{$functionList[$key]}” value=”{$item}”>{$functionList[$key]}</option>
{/if}
{/foreach}

</select>

new job type

<select class=”searchSelect” name=”searchjobtype” id=”searchjobtype”>
</select>

Search on Work Type

This search searches on the jobs work type – ‘full time’, ‘part time’ etc. Use the following code to do this search:

<select class=”searchSelect” name=”searchworktype” id=”searchworktype”>

{foreach key=key item=item from=$worktypeListVals}
{if $item == $jobSearchWorkType}
<option label=”{$worktypeList[$key]}” value=”{$item}” selected>{$worktypeList[$key]}</option>
{else}
<option label=”{$worktypeList[$key]}” value=”{$item}”>{$worktypeList[$key]}</option>
{/if}
{/foreach}

</select>

Adding a ‘Hot Jobs’ feature

Sometimes you will want to display on the top few jobs, maybe of a particular priority. You can create a special jobs list page using the ‘page’ parameter and reference it in an iframe. For example:

<iframe src=”jobs.php?page=hotjobs” />

Then in jobs.tpl you will use an ‘if’ statement to provide 2 alternative jobs list pages:

{if $page==”hotjobs”}

Contents to show for hot jobs list.

{else}

Normal jobs page contents

{/if}

You can put default search parameters in the iframe source parameters to define the jobs to be displayed:

<iframe src=”jobs.php?page=hotjobs&searchpriority=1&&searchoffset=0&searchlimit=2&jobsearch=1″ />

searchpriority means only show jobs with priority = 1 (this is set in the job details in Perform Zone).

searchoffset means start at the first job (job = 0) in the list of jobs that the search produces – ie; start with the most recently added job.

searchlimit says how many jobs to display in the search = 2 in this example meaning display top 2 jobs.

jobsearch = 1 tells the system to actually perform the search.

Download User Manual

Current Hits

  • Is there is a way we can identify if a candidate is contracted?
  • How do I import tasks?
  • About the Referees tab
  • What can Perform Zone do with SendGrid?
  • How do I sync with SendGrid?

Archives

  • February 2020
  • December 2019
  • May 2019
  • February 2019
  • November 2017
  • October 2017
  • July 2017
  • June 2017
  • May 2017
  • April 2017
  • March 2017
  • February 2017
  • January 2017

Topics

  • Adverts (26)
  • Applicants (67)
  • Basics (16)
  • Candidates (19)
  • Career Centre (10)
  • Coaching (1)
  • Contacts (4)
  • Dashboard graphs (6)
  • Data (10)
  • Email (13)
  • Employers (9)
  • FAQ (16)
  • Hiring (5)
  • Job alerts (2)
  • Job ready pool (6)
  • Jobs (53)
  • Konektiva API (3)
  • Marketing (8)
  • Merge fields (10)
  • Placed (6)
  • Reports (8)
  • Resumes (11)
  • Reverse marketing (7)
  • Settings (35)
  • SFIA (2)
  • SMS (4)
  • Tasks (9)
  • Templates (4)
  • Tests (4)
  • Uncategorised (5)
  • User Manual (365)

Tags

Adverts Applicants Basics Blogs Candidates Career Centre Coaching Contacts Dashboard graphs Data Email Employers FAQ Hiring Job alerts Job ready pool Jobs Konektiva API Marketing Merge fields Placed Reports Resumes Reverse marketing Settings SFIA SMS Tasks Templates Tests Uncategorised User Manual

Search over 913 Aussie Jobs using our mobile job seeker app

android-download android-download

Perform Zone logo  PERFORM ZONE    TAKE CONTROL

Founded in 1997, Perform Zone’s cloud-based recruitment software solutions are used around the globe to help businesses be efficient and profitable.
Company
About
Terms of Service
Privacy Policy
Press Release

Job Seekers
Search Jobs
Market Trends
Tests
Mobile APP
Software
Take a tour
Book a demo
User Manual
Login

Workshops
Evening sessions
Blogs
Post a Job
Start posting
Pricing
Login

Vendor Management
For Employers
New Suppliers
Login

+61 (0)3 9573 1554

Email
Facebook
LinkedIn
© 2004 - 2022 Perform Zone. All rights reserved.