getAllLocationsFlatListForRecruiter

Description:  This method returns all the locations currently set up for the account.

Usage:  This method is most commonly used to create search filters i.e. a user is able to select "Canberra" from a list or dropdown and the search will return all ads for "Canberra".

Parameters:

• advertiserId / String or Integer / True - Unique identifier for this account, please contact support for this value.
• recruiterId / String or Integer / True - Unique identifier for this account, please contact support for this value.
• onlyFirstLevel / Boolean / True - Determines whether sub-locations should be included i.e. NSW -> Parramatta
• withAdCount / Boolean / False - Determines whether the total number of ads posted in this location should be included

Example response:

<locations>
   <loc>
	  <id>54276</id>
	  <parent>0</parent>
	  <sort>1</sort>
	  <displayName>Australia - ACT</displayName>
	  <searchName>Australia - ACT</searchName>
   </loc>
   <loc>
	  <id>54277</id>
	  <parent>54276</parent>
	  <sort>2</sort>
	  <displayName>ACT</displayName>
	  <searchName>Australia - ACT ACT</searchName>
   </loc>
   <loc>
	  <id>54278</id>
	  <parent>0</parent>
	  <sort>3</sort>
	  <displayName>Australia - NSW</displayName>
	  <searchName>Australia - NSW</searchName>
   </loc>
</locations>
							

getWorkTypesForRecruiter

Description:  This method returns all the work types currently set up for the account.

Usage:  This method is most commonly used to create search filters i.e. a user is able to select "Full Time" from a list or dropdown and the search will return all "Full Time" roles.

Parameters:

• advertiserId / String or Integer / True - Unique identifier for this account, please contact support for this value.
• recruiterId / String or Integer / True - Unique identifier for this account, please contact support for this value.
• onlyFirstLevel / Boolean / True - Determines whether sub-worktypes should be included
• withAdCount / Boolean / False - Determines whether the total number of ads posted in this work type should be included

Example response:

<worktypes>
   <wor>
      <id>54460</id>
      <sort>1</sort>
      <displayName>Casual/Vacation</displayName>
      <searchName>Casual/Vacation</searchName>
   </wor>
   <wor>
      <id>54461</id>
      <sort>2</sort>
      <displayName>Contract/Temp</displayName>
      <searchName>Contract/Temp</searchName>
   </wor>
   <wor>
      <id>54462</id>
      <sort>3</sort>
      <displayName>Full Time</displayName>
      <searchName>Full Time</searchName>
   </wor>
   <wor>
      <id>54463</id>
      <sort>4</sort>
      <displayName>Part Time</displayName>
      <searchName>Part Time</searchName>
   </wor>
</worktypes>
							

viewAd

Description:  This method returns the ad in either XML or full HTML.

Usage:  This method is used to create a "job details" page, the "job details" page displays the full ad and provides candidates with the ability to apply for the ad if they wish.

Parameters:

• jobAdId / Integer / True - Ad to return, this ID is received from the searchAdsV2 method and can be found in the JobPosting elements ad_id attribute.
• params / String or JSON object / True - A JSON object of additional parameters based on reserved keywords:
  • format / String / False - Format to return the ad in accepted values are XML and HTML if this is not provided, defaults to HTML
  • applicationUrl / String / False - If you wish to re-implement the application process or override the system default application form, provide a URL to your form here.

Example Request (XML):

<viewAd>
	<jobAdId>6656944</jobAdId>
	<params>{"format":"xml"}</params>
</viewAd>
							

Example response (XML):

<JobPosting ad_id="6656944" advertiserId="10000" distribution="E"
    hotJob="false" reference="wowsuchnetworkengineer" template="demoRecruitment">
    <PlacedBy>
        <Brand>ABC Personnel Pty Limited</Brand>
        <Office>ABC Personnel Pty Limited</Office>
        <Account>SUPPLY_BY_CLIENT_USE_TAGS</Account>
    </PlacedBy>
    <JobTitle><![CDATA[Top Notch Network Engineer | Sydney CBD - Edit from ad]]]]>><![CDATA[</JobTitle>
    <adFooter><![CDATA[<center>To apply 7777777, please click on the appropriate link below. Alternatively, for a confidential discussion, please contact Apple Developer Test on , quoting Ref No. wowsuchnetworkengineer.</center><p> </p>]]]]>><![CDATA[</adFooter>
    <JobDescription><![CDATA[<p>We're looking for a <strong>top</strong> <em>notch</em> network engineer</p>]]]]>><![CDATA[</JobDescription>
    <SearchHeadline><![CDATA[Top Notch Network Engineer | Sydney CBD - Edit from ad]]]]>><![CDATA[</SearchHeadline>
    <SearchSummary><![CDATA[We're looking for the most kickass network engineer ever. If you've got atleast 5 years of experience and know how to Linux and Java]]]]>><![CDATA[</SearchSummary>
    <BulletPoints>
        <BulletPoint><![CDATA[great transport]]]]>><![CDATA[</BulletPoint>
        <BulletPoint><![CDATA[bullet32]]]]>><![CDATA[</BulletPoint>
        <BulletPoint><![CDATA[aa]]]]>><![CDATA[</BulletPoint>
    </BulletPoints>
    <Enquiry>
        <Phone/>
        <Email>chrisa@adlogic.com.au</Email>
        <ApplicationURL>https://clientapplications.myrecruitmentplus.com/applicationform/?jobAdId=6656944</ApplicationURL>
        <Name>Apple Developer Test</Name>
        <ConsultantEmail>chrisa@adlogic.com.au</ConsultantEmail>
        <ConsultantImage><![CDATA[]]]]>><![CDATA[</ConsultantImage>
    </Enquiry>
    <standOut>
        <logoURL><![CDATA[http://rms.adlogic.com.au/recruiter_skin/demoRecruitmentlogos/demoRecruitmentlogo.png]]]]>><![CDATA[</logoURL>
        <BulletPoints>
            <BulletPoint><![CDATA[great transport]]]]>><![CDATA[</BulletPoint>
            <BulletPoint><![CDATA[bullet32]]]]>><![CDATA[</BulletPoint>
            <BulletPoint><![CDATA[aa]]]]>><![CDATA[</BulletPoint>
        </BulletPoints>
    </standOut>
    <locations>
        <location id="54278"><![CDATA[Australia - NSW]]]]>><![CDATA[</location>
        <location id="54279"><![CDATA[Sydney]]]]>><![CDATA[</location>
        <location id="54280"><![CDATA[CBD, Inner West & Eastern Suburbs]]]]>><![CDATA[</location>
    </locations>
    <classifications>
        <classification id="54098"><![CDATA[Information & Communication Technology]]]]>><![CDATA[</classification>
        <classification id="54110"><![CDATA[Networks & Systems Administration]]]]>><![CDATA[</classification>
    </classifications>
    <workType id="54462">Full Time</workType>
    <Salary>
        <salaryMinimum><![CDATA[90000]]]]>><![CDATA[</salaryMinimum>
        <salaryMaximum><![CDATA[105000]]]]>><![CDATA[</salaryMaximum>
        <salaryRate><![CDATA[AnnualPackage]]]]>><![CDATA[</salaryRate>
        <salaryAdditionalText><![CDATA[h]]]]>><![CDATA[</salaryAdditionalText>
    </Salary>
    <AdStatus><![CDATA[]]]]>><![CDATA[</AdStatus>
    <PublishedDate>2016-05-31 21:20:23</PublishedDate>
    <closeDate>2016-06-29 21:20:23</closeDate>
    <Subheading><![CDATA[subheading]]]]>><![CDATA[</Subheading>
    <OrganisationalUnit id="2930"/>
</JobPosting>
							

Example response (HTML):

<AdHTML>
<![CDATA[ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head>
<script type='text/javascript'>
var jobURL='https://clientapplications.myrecruitmentplus.com/applicationform/?jobAdId=6656944';
var mailURL='http://rms.adlogic.com.au/application/SendAdToFriend.jsp?jobAdId=6656944';
function openApplicationForm() {
	(function($) {
       if (jobURL.indexOf('http://rms.adlogic.com.au/smejobsearch/jsponly/SubmitJobApplication.jsp') == 0) {
			if (typeof (adlogicApplyJobDimensions) != 'object') {
				adlogicApplyJobDimensions = {
					height : '400',
					width : '680'
				};
			}

			$('#applyJobPopup').find('iframe#jobFrameId').height(adlogicApplyJobDimensions.height-150);
			$('#applyJobPopup').find('iframe#jobFrameId').width(adlogicApplyJobDimensions.width-20);

			$("#applyJobPopup").dialog("option", adlogicApplyJobDimensions);
			$("#applyJobPopup").dialog("open");
		} else {
			//window.location.href = jobURL;
			window.location.href = jobURL +'&referrer='+encodeURIComponent(window.location.href);
		}
	})(jQuery);
}
function openEmailToFriendForm() {
	(function($) {
		if (typeof (adlogicEmailToFriendDimensions) != 'object') {
			adlogicEmailToFriendDimensions = {
				height : '400',
				width : '680'
			};
		}

		$('#emailFriendPopup').find('iframe#mailFrameId').height(adlogicEmailToFriendDimensions.height-150);
		$('#emailFriendPopup').find('iframe#mailFrameId').width(adlogicEmailToFriendDimensions.width-20);

		$("#emailFriendPopup").dialog("option", adlogicEmailToFriendDimensions);
		$("#emailFriendPopup").dialog("open");
	})(jQuery);
}
function initializePopFrame() {
	jQuery(document).ready(function($) {
		$('#applyJobPopup').dialog({
			title : "Application Form",
			modal : true,
			resizable : true,
			autoOpen : false,
			width : 680,
			height : 400,
			beforeClose : function(event, ui) {
				$(this).dialog('destroy');
				setJobFrameURL();
				initializePopFrame();
			},
			resize: function(ev, el) {
				$(this).find('iframe#jobFrameId').height($(this).height()-40);
				$(this).find('iframe#jobFrameId').width($(this).width());
			},
			buttons : {
				'Close' : function() {
					$('#applyJobPopup').dialog('close');
				}
			}
		});
	});
}
function initEmailFriendPopFrame() {
	jQuery(document).ready(function($) {
		$('#emailFriendPopup').dialog({
			title : "Email to a Friend",
			modal : true,
			resizable : true,
			autoOpen : false,
			width : 680,
			height : 400,
			beforeClose : function(event, ui) {
				$(this).dialog('destroy');
				setMailFrameURL();
				initEmailFriendPopFrame();
			},
			resize: function(ev, el) {
				$(this).find('iframe#mailFrameId').height($(this).height()-40);
				$(this).find('iframe#mailFrameId').width($(this).width());
			},
			buttons : {
				'Close' : function() {
					$('#emailFriendPopup').dialog('close');
				}
			}
		});
	});
}
jQuery(document).ready(function($) {
	initializePopFrame();
	initEmailFriendPopFrame();
});
function closeApplicationForm() {
	(function($) {
		$("#applyJobPopup").dialog("close");
	})(jQuery);
}
function closeEmailForm() {
	(function($) {
		$("#emailFriendPopup").dialog("close");
	});
}
function setJobFrameURL() {
	(function($) {
		$("#jobFrameId").attr("src", jobURL);
		return false;
	});
}
function setMailFrameURL() {
	(function($) {
		$("#mailFrameId").attr("src", mailURL);
		return false;
	});
}
function goBack() {
	window.history.back();
}
</script>
	<title>Job Opportunity | Top Notch Network Engineer | Sydney CBD - Edit from ad | ABC Personnel Pty Limited</title>	<link rel="stylesheet" href="/recruiter_skin/demoRecruitment/template/demoRecruitment/style.css" type="text/css">	<meta property="og:title" content="Job Opportunity | Top Notch Network Engineer | Sydney CBD - Edit from ad | ABC Personnel Pty Limited" />	<meta name="description" content="We're looking for the most kickass network engineer ever. If you've got atleast 5 years of experience and know how to Linux and Java" /></head><body class="adlogic_job_details_body">	<!-- BEGIN JOB DETAILS CONTAINER DIV -->		<div class="adlogic_job_details_container demo_recruitment">		<div class="adlogic_recruiter_logo"></div>		<div class="adlogic_job_details_inner">			<h1 class="adlogic_job_details_title">Top Notch Network Engineer | Sydney CBD - Edit from ad</h1>			<ul class="adlogic_job_details_bullet_ul">				<li>great transport</li>				<li>bullet32</li>				<li>aa</li>			</ul>			<div class="adlogic_job_details_description"><p>We're looking for a <strong>top</strong> <em>notch</em> network engineer</p></div>			<div class="adlogic_job_attachments">				<div class="adlogic_attachment_header">Recruitment Kit:</div>				<div class="adlogic_attached_files"><table style="border:0px;"><tr><td class="attachment" style="border:0px;"><b>Job File 1 :  </b><a href="http://rms.adlogic.com.au/smejobsearch/jsponly/downloadFile.jsp?fileName=testresumeXqqNm.txt">file1 </a></td></tr><tr><td class="attachment" style="border:0px;"><b>Job File 2 :  </b><a href="http://rms.adlogic.com.au/smejobsearch/jsponly/downloadFile.jsp?fileName=testresumePsqNm.txt">file2</a></td></tr><tr><td class="attachment" style="border:0px;"><b>Job File 3 :  </b><a href="http://rms.adlogic.com.au/smejobsearch/jsponly/downloadFile.jsp?fileName=templatehooks.txt">file3</a></td></tr></table></div>			</div>			<p><div class="adlogic_job_details_footer"><center>To apply 7777777, please click on the appropriate link below. Alternatively, for a confidential discussion, please contact Apple Developer Test on , quoting Ref No. wowsuchnetworkengineer.</center><p> </p></div></p>			<!-- BEGIN SOCIAL SHARING HOLDER -->			<div class="adlogic_social_sharing_container">				<div class="ajb_social_sharing_sites">					<div class="ajb_social_sharing_site">						<span class="st_twitter_large" st_title="Top Notch Network Engineer | Sydney CBD - Edit from ad" st_summary="We're looking for the most kickass network engineer ever. If you've got atleast 5 years of experience and know how to Linux and Java"></span>					</div>					<div class="ajb_social_sharing_site">						<span class="st_facebook_large" st_title="Top Notch Network Engineer | Sydney CBD - Edit from ad" st_summary="We're looking for the most kickass network engineer ever. If you've got atleast 5 years of experience and know how to Linux and Java"></span>					</div>					<div class="ajb_social_sharing_site">						<span class="st_linkedin_large" st_title="Top Notch Network Engineer | Sydney CBD - Edit from ad" st_summary="We're looking for the most kickass network engineer ever. If you've got atleast 5 years of experience and know how to Linux and Java"></span>					</div>					<div class="ajb_social_sharing_site">						<span class="st_sharethis_large" st_title="Top Notch Network Engineer | Sydney CBD - Edit from ad" st_summary="We're looking for the most kickass network engineer ever. If you've got atleast 5 years of experience and know how to Linux and Java"></span>					</div>				</div>			</div>			<script src="https://ws.sharethis.com/button/buttons.js" type="text/javascript"></script>			<script type="text/javascript">stLight.options({publisher : '152ef02e-0737-4a2f-82d1-0ef6aa8cdf9f',offsetTop : '150'});</script>			<!-- END SOCIAL SHARING HOLDER -->			<div class="adlogic_job_details_button_bar">				<div id="adlogic_sharing_options">					<div class="print-job"><a href="javascript:window.print();">Print this job</a></div>					<div class="email-job"><a href="javascript:openEmailToFriendForm();" id="emailThisjob">Email this job</a>											<a id="openEmailToFriend" data-toggle="modal" data-target="#emailToFriend" style="display: none;">Email this job</a></div>				</div>				<div class="adlogic_apply_container"><button class="adlogic_job_details_apply" onclick="javascript:openApplicationForm()">Apply Now</button></div>				<button class="adlogic_job_details_email_friend" onclick="javascript:openEmailToFriendForm()">Email to a Friend</button>				<button class="adlogic_job_details_back" onclick="javascript:window.history.back();">Back To Search Results</button>							</div>		</div>			</div>
<div id="applyJobPopup" style="display:none"><center><iframe id="jobFrameId" src="https://clientapplications.myrecruitmentplus.com/applicationform/?jobAdId=6656944" frameborder="0" width="600" height="900"></iframe></center></div>
<div id="emailFriendPopup" style="display:none"><center><iframe id="mailFrameId" src="http://rms.adlogic.com.au/application/SendAdToFriend.jsp?jobAdId=6656944" frameborder="0" width="580" height="280"></iframe></center></div>
</body>
</html>   ]]]]>><![CDATA[
</AdHTML>
							

addApplicant

Description:  This method saves the candidates information in our database.

Usage:  This method is used to save the candidates data in our database and relies heavily on the getJobCriteriasForAd method for the JobCriteriaAnswers parameter.

Parameters:

• JobAdId / Integer / True - Ad to return, this ID is received from the searchAdsV2 method and can be found in the JobPosting elements ad_id attribute.
• Source / String / False - This is where the application come from e.g. "Company Website"
• Name / String / True - This is the candidates first name - this value will be set from the criteria question with the mappedField value set to "Name".
• Surname / String / True - This is the candidates last name - this value will be set from the criteria question with the mappedField value set to "Surname".
• Phone / String / False - This is the candidates home phone number - this value will be set from the criteria question with the mappedField value set to "Home Phone".
• PhoneWork / String / False - This is the candidates work phone number - this value will be set from the criteria question with the mappedField value set to "Work Phone".
• PhoneMobile / String / False - This is the candidates mobile phone number - this value will be set from the criteria question with the mappedField value set to "Mobile Phone".
• StreetAddress / String / False - This is the candidates street address - this value will be set from the criteria question with the mappedField value set to "Street" e.g. "50 Clarence"
• Email / String / True - This is the candidates street address - this value will be set from the criteria question with the mappedField value set to "Email"
• CoverLetterContent / String / False - DEPRECATED this parameter is deprecated and should not be used.
• ResumeData / String / True - This is the candidates resume - this should be base64 encoded file data.
• CoverLetterData / String / False - This is the candidates cover letter - this should be base64 encoded file data.
• RetentionConsent / Boolean / True - This is the acknowledgement that the candidate agrees to keep their data in on record, you will need to provide an option for candidates to change this option (checkbox, dropdown, etc.) and update this value accordingly.
• SubSourceId / String / False - This is where the candidate found the advertisement e.g. LinkedIn, Facebook, etc. We store unique ID's for each site and you'll need to contact support for assistance.
• PlatformId / Integer / False - This is the device the candidate has applied to the job from, this takes 2 possible values:
  • 1 - Desktop
  • 2 - Mobile / Tablet device
• UserAgent / String / False - The candidate's browsers useragent string.
• JobCriteriaAnswers / Object / False - REPEATABLE This is the object of questions & answers that the candidate has filled out and accepts 2 parameters. Questions with the type of multiple attachments upload DON'T get placed into this object, more about this below.
  • CriteriaId - This is the id returned for a question when using the getJobCriteriasForAd method.
  • Answer - This can be 1 of 2 possible values:
    • String - For the types below, you can pass the value of these fields directly to this parameter:
      • text
      • text area
      • date
      • date/month-year only
      • multiple - This takes a specific format for answers, see the examples in the getJobCriteriasForAd method.
    • Integer - For questions with the type of "select" you need to pass the value of the selected options to this parameter
• CustomFieldAnswers / Object / False - DEPRECATED this parameter has been deprecated and should not be used.
• ApplicantDocuments / Object / False - REPEATABLE For questions with the type of "multiple attachments upload" and have a mappedField value of "Additional Documents". This object accepts 3 parameters:
  • FileName - This is the name of the file the candidate has uploaded.
  • FileData - This is the data of the file the candidate has uploaded encoded in Base64.
  • CriteriaId - This is the id returned for a question when using the getJobCriteriasForAd method.
• ReferrerUrl / String / False - This is the URL of where the candidate has come from. Example: http://www.seek.com.au/job/2459234
• TrackingCode / String / False - DEPRECATED this parameter has been deprecated and should not be used.
• ApplicantId / String / False - DEPRECATED this parameter has been deprecated and should not be used.
• Password / String / False - DEPRECATED this parameter has been deprecated and should not be used.
• CandidateFileFields / Object / False - REPEATABLE For questions with the type of "multiple attachments upload" and does not have a mappedField value. This object accepts 3 parameters:
  • FileName - This is the name of the file the candidate has uploaded.
  • FileData - This is the data of the file the candidate has uploaded encoded in Base64.
  • CriteriaId - This is the id returned for a question when using the getJobCriteriasForAd method.

Example response:

								Applicant added successfully, id: 16101028