API SOAP Interface

Introduction

There is a JSON version of these services available that is based on this SOAP service but supports JSON payloads.. There is also an optional Administration service around managing users, credentials and quota.

A set of SOAP based API services to interact with the multiple job posting and applicant tracking system.

Many of the methods will not require any further input for a user except for posting where the user will be required to complete the process interactively

• sCultureID optionally target a specific language culture
• sAPIKey api key required
• sUsername The username of the user
• sPassword The password of the user
• sAdvertIdentifier The advert identifier in your system
• sAdvertReference The reference sent to job boards and for user consumption
• sSearchDays By default the system will look for adverts in the last 30 dates when reducing duplication. -1 will indicate all time any other number indicates the numbers of days in the past to look for a duplicate.
• Date filters When in string formats can be in the form yyyy-MM-dd HH:mm:ss or yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ (24 hour clock UTC time).

Getting started

This api has grown over time with extra methods to accomodate a larger number of client requested features. The concept remains the same. Connect to the soap service, authenticate and push or pull data.

Broadly the functionality is split into the following areas

• Push in job data
• Pull back status, jobs and applications
• Request removals or bulk action posts
• Pull back per user job board access
• Request lookup data
• Perform simple actions on applications

The most important methods are AddAdvert or a variant to push job data into the system combined with TrackAdvert which allows you to view the delivery results.

Following that you may want to enhance functionality by pushing through removals with CloseAdvert or even listing jobs in the system with GetAdvertPaged. You can also look at listing or retrieving applications with GetApplicationsPaged

If you want to pull data on job board access you can use UserFeedsAndQuota and if you need to lookup data in the platform with GetValues, QueryJobTitle and QueryLocations.

Recent change log

• 2020-10-05 (non breaking) Added support for AddAdvert methods - sApplicationCallbackURL to allow setting a web URL for callback for applications, when configured.
• 2020-10-05 (non breaking) New method AddAdvertCandidateWithDocument - extension of AddAdvertCandidate to include base64 encoded CV/Resume.
• 2020-08-05 (should be non breaking) TrackAdvertsWithFilters, TrackAdvertsWithFiltersPaged - Additional filtering applied to Postings if filter 'estimatedexpirydate' is used.
• 2020-04-06 (should be non breaking) Implemented storage of CandidateDetails in database as part of method AddAdvertCandidate.
• 2019-12-18 (should be non breaking) New method TrackAdvertWithFiltersPaged, and additional NameValueFilters - isLive, isDeleted, LastPostDate, PostDate, and EstimatedExpiryDate.
• 2019-08-06 (mild breaking) Extended search criteria on TrackAdvert to include posting criteria such as JobBoardIdentifier and JobBoardUrl. The extension resulted in a new class NameValueFilter to replace NameValue with extra attributes.
• 2019-07-11 (should be non breaking) Added string versions of date columns for easier JSON consumption in ISO8601 format (yyyy-MM-ddTHH:mm:ssZ). For reference all our dates are in UTC.
• 2019-07-08 (should be non breaking) Released JSON version of our services /JSON/Multiposter.asmx and /JSON/Administration.asmx.
• 2018-04-16 (mild breaking) For AddAdvertWithValues and AddAdvertValues if a AdvertValues node is supplied with an empty string it will remove existing data. (previously values were only updated if changed and supplied. Empty strings and nulls were ignored.)
• 2018-01-30 (non breaking) Adjusted TrackAdvert, CloseAdvert to utilise user visibility tiering in finding adverts.
• 2018-01-09 (non breaking) Corrected error in ValidateAdvertValues.
• 2017-12-08 (non breaking) Extended GetAdvertX to include LastDeliveryStatusID and LastDeliveryDate.
• 2017-09-20 (non breaking) Add support to score or progress applications.
• 2017-06-05 (should be non breaking) added support for filters and data in LastScoreDate and LastPostDate to filter when applications changed state.
• 2016-05-12 (should be non breaking) added support for sAdvertID if known in AddAdvert and AddAdvertWithFilters

List of methods

• AddAdvert
• AddAdvertCandidate
• AddAdvertCandidateNote
• AddAdvertCandidateWithDocument
• AddAdvertCandidateWithFilters
• AddAdvertValues
• AddAdvertWithValues
• ApplicationScore
• ApplicationProgress
• ArchiveAdvert
• ArchiveAdvertWithFilters
• CandidateTag
• CandidateTagPeoplEd
• CloseAdvert
• CloseAdvertWithFilters
• DeliverAdvert
• ExpressPostAdvert
• ExpressPostAdvertWithFilters
• GetAdvert
• GetAdvertPaged
• GetAdvertWithFilters
• GetAdvertWithFiltersPaged
• GetAdvertWithValues
• GetAdvertWithValuesPaged
• GetAdvertWithValuesWithFilters
• GetAdvertWithValuesWithFiltersPaged
• GetApplications
• GetApplicationsPaged
• GetApplicationsWithFilters
• GetApplicationsWithFiltersPaged
• GetCurrency
• GetLoginURL
• GetValues
• QueryJobTitle
• QueryLocations
• TrackAdvert
• TrackAdvertWithFilters
• TrackAdvertWithFiltersPaged
• UnarchiveAdvert
• UnarchiveAdvertWithFilters
• UserFeedsAndQuota
• UserFeedsAndQuotaWithDestinations
• ValidateAdvertValues

Output values

• LastDeliveryStatusID -2 waiting to authorise, -1 waiting to deliver, 0 complete failure, 100 complete success, 1-99 % success
• Score 0 unranked, 1 red flagged (unsuitable), 2 blue/yellow flagged (MaybeSuitable), 4 green flagged (Suitable)
• AdvertStatusID 0 - Created, 1 - Expired, 11 - Deleted, 16 - ToAuthorise, 32 - Watch Dog, 64 - Template, 128 - RequisitionToAuthorise

Service Description

The following operations are supported. For a formal definition, please review the Service Description.

• AddAdvert
  

  Create an advert on the system and return a redirect url for the user to complete the posting process.

  • eOnDuplicate What action to perform if this advert is already found under this user (duplicate/ignore/update/error) (create a duplicate / ignore and return the access url / update the advert with these values / throw an exception about a duplicate)
  • sJobTitle The title of the job
  • sJobType The job type (P)ermanent, (C)ontract, (T)emporary
  • sJobHours The job hours (F)ull time, (P)art time
  • sPrimaryLocation The primary location
  • sIndustry The specific industry
  • sSalaryFrom The minimum salary. Must be numeric.
  • sSalaryTo The maximum salary. Must be numeric.
  • sSalaryCurrency The salary currency in 3 letter ISO e.g. GBP, EUR, USD
  • sSalaryPer The salary period (H)our, (D)ay, (W)eek, (M)onth, (Y)ear
  • sSalaryBenefits and salary benefits
  • sContactName Optionally a specific contact name (default to use the user the vacancy is stored under)
  • sContactEmail Optionally a specific contact email (default to use the user the vacancy is stored under)
  • sJobDescription The job description in plain text or HTML
  • sApplicationURL Optionally an application URL to pass to the different media. Contact support for details.
  • Destinations A list of job board destinations as either numeric id's or string identifiers
  • sFuturePostDateTimeInUtc Future date for advert and posting data. Must parse to a date using
  • sRedirectDomain The domain to redirect the user to on completion. Defaults to a system configured domain.
  • AdvertValues Extra values keyed on numeric field id or field string identifier and the associated value
  • sAdvertStatusID Adverts by default are marked as Created (0). The may also be marked as ToAuthorise (16) or Deleted (1)
  • sAdvertID 12 May 2016 optionally if you know the existing AdvertID supply it here
  • sApplicationCallbackURL 4 March 2021 optionally if you have an endpoint we can call with our applicationID, when an application is made
  • sIframe 22 Aug 2022 optionally if you need sRedirectDomain to return iframe version of RedirectUrl
• AddAdvertCandidate
  

  Attaches a candidate to the application pipeline using their email address, information to locate and advert, and a specific feed identifier or feed id.

  Optionally specify a username to limit the search

  • sFeedID If known our internal database key for the source. e.g. 108
  • sFeedIdentifier If known our internal string identifier for the source. e.g Totaljobs
  • sCandidateEmail The candidates email address (required)
  • sCandidateFirstName The candidates first name (optional)
  • sCandidateLastName The candidates last name (optional)
  • sCandidateHomePhone The candidates home phone (optional)
  • sCandidateWorkPhone The candidates work phone (optional)
  • sCandidateMobilePhone The candidates mobile phone (optional)
  • CandidateDetails Extra candidate details (contact support for details)
• AddAdvertCandidateNote
  

  Attaches a note to a Candidate.

• AddAdvertCandidateWithDocument
  

  Attaches a candidate to the application pipeline using their email address, and a base64 encoded document to attach to the candidate.

• AddAdvertCandidateWithFilters
  

  Attach a candidate to the application pipeline using their email address, information to locate an advert, and a specific feed identifier or feed id are required.

  Optionally specify a username to limit the search

• AddAdvertValues
  

  Update field values against a current advert.

• AddAdvertWithValues
  

  Create an advert on the system and return a redirect url for the user to complete the posting process.

• AdvertTracking
  

  Provides a mechanism to search for an advert and getting tracking information on posting delivery. Allows extra search Filters to be included

• AdvertTrackingResponseLog
  

  Provides a mechanism to search for an advert's posting delivery response logs

• AdvertTrackingSentLog
  

  Provides a mechanism to search for an advert's posting delivery sent logs

• ApplicationProgress
  

  Progress a specific application from a 3rd party RMS.

  • sUsername This action will be performed in the context of the authenticated user. If you want to score as the job owner then please indicate boolScoreAsJobOwner = true.
  • sAdvertID Our AdvertID of the job
  • sAdvertCandidateID Our ApplicationID of the applicant. sAdvertID and sAdvertCandidateID must line up to be able to score.
  • sProgressID The specific progressID. Contact us for id's applicable to your account. A list of commons ones are listed below:
    • 100 Reject
    • 200 General
    • 201 Apply with CV
    • 204 Applied already
    • 220 Blank
    • 300 Consider
    • 351 Forwarded to manager
    • 380 Suitable - Application form requested
    • 750 Shortlist
    • 850 Request for More Information
    • 900 Questions
    • 1210 General e-mail to candidates
    • 1360 Request to get in touch
    • 1361 Job Application To Ourselves
    • 3000 Testing
    • 4900 Interview request
    • 5000 1st interview
    • 5100 2nd interview
    • 5200 3rd interview
    • 5300 4th interview
    • 6000 Not offered
    • 6002 Regret after interview
    • 8000 Offered
    • 10000 Placement
    • 11000 Vacancy closed
    • 11002 Candidate Withdrawn
  • sProgressAsJobOwner Progress as the job owner instead of the authenticated user. Boolean defaults to false.
• ApplicationScore
  

  Score a specific application from a 3rd party RMS.

  • sUsername This action will be performed in the context of the authenticated user. If you want to score as the job owner then please indicate boolScoreAsJobOwner = true.
  • sAdvertID Our AdvertID of the job
  • sAdvertCandidateID Our ApplicationID of the applicant. sAdvertID and sAdvertCandidateID must line up to be able to score.
  • sScore The score to apply (S)uitable (green flag/4), (M)aybe suitable (blue/yellow flag/2), (U)nsuitable (red flag/1), (F)avourite (favourite star/64), (N)one (no flag/0)
  • sScoreAsJobOwner Score as the job owner instead of the authenticated user. Boolean defaults to false.
• ArchiveAdvert
  

  Provides a mechanism to archive an advert and abort future postings. If you want to close an advert on portals and other media that support this please use the CloseAdvert method.

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

• ArchiveAdvertWithFilters
  

  Provides a mechanism to archive an advert and abort future postings. If you want to close an advert on portals and other media that support this please use the CloseAdvert method.

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

• CandidateTag
  

  Provides a mechanism to Tag a specific candidate so that the tag appears on the front end recruiter interface. A Tag is any short phrase. e.g. Ignore, Reviewed, etc

• CandidateTagPeoplEd
  

  Provides a mechanism to Tag a specific candidate so that the tag appears on the front end recruiter interface. A Tag is any short phrase. e.g. Ignore, Reviewed, etc

• CloseAdvert
  

  Provides a mechanism to search for an advert and request closure of the advert on job boards that support this feature.

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

  • Destinations Optionally a comma separated list of job board destinations as either numeric id's or string identifiers. If not specified requests removals on all support destinations.
  • sArchive Optionally indicate if the advert should be archived on the local system as well (defaults to false)
• CloseAdvertWithFilters
  

  Provides a mechanism to search for an advert and request closure of the advert on job boards that support this feature. Allows extra search Filters to be included

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

  • Destinations Optionally a list of job board destinations as either numeric id's or string identifiers. If not specified requests removals on all support destinations and closes the advert.
  • sArchive Optionally, when destinations are specified, indicate if the advert should be archived on the local system as well (defaults to false)
• DeliverAdvert
  

  Validate an existing advert against a supplied set of destinations and mark for delivery if valid.

  • Destinations Required list of job board destinations as either numeric id's or string identifiers.
  • FuturePostDateTimeInUtc An optional Date and Time components in UTC of when to deliver the advert (default is ASAP).
  • sAdvertID, sAdvertReference, sAdvertIdentifier Locate the existing advert data already stored in the database.
• ExpressPostAdvert
  

  Provides a mechanism to search for an advert and request for it to be delivered unaltered to job boards previously posted to.

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

  • Destinations Optionally a comma separated list of job board destinations as either numeric id's or string identifiers. If not specified requests removals on all support destinations.
  • sArchive Optionally indicate if the advert should be archived on the local system as well (defaults to false)
• ExpressPostAdvertWithFilters
  

  Provides a mechanism to search for an advert and request for it to be delivered unaltered to job boards previously posted to. Allows extra search Filters to be included

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

  • Destinations Optionally a list of job board destinations as either numeric id's or string identifiers. If not specified requests removals on all support destinations.
  • sArchive Optionally indicate if the advert should be archived on the local system as well (defaults to false)
• GetAdvert
  

  Provides a mechanism to search for a specific advert (with possibly multiple instances) on the database and return some basic information.

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

• GetAdvertPaged
  

  Paged version of GetAdvert. Provides a mechanism to search for a specific advert (with possibly multiple instances) on the database and return some basic information.

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

• GetAdvertWithFilters
  

  Provides a mechanism to search for a specific advert (with possibly multiple instances) on the database and return some basic information.

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

• GetAdvertWithFiltersPaged
  

  Paged version of GetAdvert. Provides a mechanism to search for a specific advert (with possibly multiple instances) on the database and return some basic information.

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

• GetAdvertWithValues
  

  Provides a mechanism to search for a specific advert (with possibly multiple instances) on the database and return some basic information with extra field values included. The extra field values can be filtered by a list of Field identifiers or for Feed specific values by Feed identifiers.

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

• GetAdvertWithValuesPaged
  

  Paged version of GetAdvert. Provides a mechanism to search for a specific advert (with possibly multiple instances) on the database and return some basic information with extra field values included. The extra field values can be filtered by a list of Field identifiers or for Feed specific values by Feed identifiers.

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

• GetAdvertWithValuesWithFilters
  

  Provides a mechanism to search for a specific advert (with possibly multiple instances) on the database and return some basic information with extra field values included. The extra field values can be filtered by a list of Field identifiers or for Feed specific values by Feed identifiers.

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

• GetAdvertWithValuesWithFiltersPaged
  

  Paged version of GetAdvert. Provides a mechanism to search for a specific advert (with possibly multiple instances) on the database and return some basic information with extra field values included. The extra field values can be filtered by a list of Field identifiers or for Feed specific values by Feed identifiers.

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

• GetApplications
  

  Provides a mechanism to search for applications by job, job board or time on the database and return some basic information along with the ability to include source documents and parsed data.

  • Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).
  • At a minimum 1 search filter must be specified to find (1) either a job or (2) an application time period.
  • Destinations are either numeric (FeedID) or string (FeedIdentifier)
  • ApplicationDateTime A variety of date formats are supported but the safest may be yyyy-MM-d HH:mm:ss (24 hour clock UTC).
  • Ranking can be string or numeric Unranked (0), Unsuitable (1), MaybeSuitable (2), Suitable (4)
  • ProgressID must be numeric and values can be requested from support or determined from the main recruiter interface
  • Default SortOrder: ApplicationDate asc, AdvertCandidateID asc
  • boolIncludeParsed You can choose to include parsed data (if you have parsing activated on your account) which is generally in an HRXML format
  • boolIncludeEmailBody, boolIncludeAttachment, boolIncludeEmail You can choose to include parts of the actual application email. From the full email (boolIncludeEmail) to just the body content (boolIncludeEmailBody) and the probable most appropriate attachment (boolIncludeAttachment).
  • AdvertCandidateIDAsCSV You may want to select which applications to import and then re-request the data using AdvertCandidateIDAsCSV to retrieve the exact parsed data, attachments or emails for the specific applications you need.
  • LastScoreDate, LastProgressDate The date and time (UTC) and action was last performed on an application (score is flagging and progress is replying/progressing).
• GetApplicationsPaged
  

  Paged version of GetApplications. Provides a mechanism to search for applications by job, job board or time on the database and return some basic information along with the ability to include source documents and parsed data.

  • Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).
  • At a minimum 1 search filter must be specified to find (1) either a job or (2) an application time period.
  • Destinations are either numeric (FeedID) or string (FeedIdentifier)
  • ApplicationDateTime A variety of date formats are supported but the safest may be yyyy-MM-d HH:mm:ss (24 hour clock UTC).
  • Ranking can be string or numeric Unranked (0), Unsuitable (1), MaybeSuitable (2), Suitable (4)
  • ProgressID must be numeric and values can be requested from support or determined from the main recruiter interface
  • Default SortOrder: ScorePreSort asc, Score desc, ScoreExtra desc, Favourite desc, ApplicationDate desc, AdvertCandidateID desc
  • CurrentPage and RowsPerPage must always be supplied
  • boolIncludeParsed You can choose to include parsed data (if you have parsing activated on your account) which is generally in an HRXML format
  • boolIncludeEmailBody, boolIncludeAttachment, boolIncludeEmail You can choose to include parts of the actual application email. From the full email (boolIncludeEmail) to just the body content (boolIncludeEmailBody) and the probable most appropriate attachment (boolIncludeAttachment).
  • AdvertCandidateIDAsCSV You may want to select which applications to import and then re-request the data using AdvertCandidateIDAsCSV to retrieve the exact parsed data, attachments or emails for the specific applications you need.
  • LastScoreDate, LastProgressDate The date and time (UTC) and action was last performed on an application (score is flagging and progress is replying/progressing).
• GetApplicationsWithFilters
  

  Provides a mechanism to search for applications by job, job board or time on the database and return some basic information along with the ability to include source documents and parsed data.

  • Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).
  • At a minimum 1 search filter must be specified to find (1) either a job or (2) an application time period.
  • Destinations are either numeric (FeedID) or string (FeedIdentifier)
  • ApplicationDateTime A variety of date formats are supported but the safest may be yyyy-MM-d HH:mm:ss (24 hour clock UTC).
  • Ranking can be string or numeric Unranked (0), Unsuitable (1), MaybeSuitable (2), Suitable (4)
  • ProgressID must be numeric and values can be requested from support or determined from the main recruiter interface
  • Default SortOrder: ApplicationDate asc, AdvertCandidateID asc
  • bIncludeParsed You can choose to include parsed data (if you have parsing activated on your account) which is generally in an HRXML format
  • bIncludeEmailBody, bIncludeAttachment, bIncludeEmail You can choose to include parts of the actual application email. From the full email (bIncludeEmail) to just the body content (bIncludeEmailBody) and the probable most appropriate attachment (bIncludeAttachment).
  • AdvertCandidateIDAsCSV You may want to select which applications to import and then re-request the data using AdvertCandidateIDAsCSV to retrieve the exact parsed data, attachments or emails for the specific applications you need.
  • LastScoreDate, LastProgressDate The date and time (UTC) and action was last performed on an application (score is flagging and progress is replying/progressing).
• GetApplicationsWithFiltersPaged
  

  Paged version of GetApplications. Provides a mechanism to search for applications by job, job board or time on the database and return some basic information along with the ability to include source documents and parsed data.

  • Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).
  • At a minimum 1 search filter must be specified to find (1) either a job or (2) an application time period.
  • Destinations are either numeric (FeedID) or string (FeedIdentifier)
  • ApplicationDateTime A variety of date formats are supported but the safest may be yyyy-MM-d HH:mm:ss (24 hour clock UTC).
  • Ranking can be string or numeric Unranked (0), Unsuitable (1), MaybeSuitable (2), Suitable (4)
  • ProgressID must be numeric and values can be requested from support or determined from the main recruiter interface
  • Default SortOrder: ScorePreSort asc, Score desc, ScoreExtra desc, Favourite desc, ApplicationDate desc, AdvertCandidateID desc
  • CurrentPage and RowsPerPage must always be supplied
  • bIncludeParsed You can choose to include parsed data (if you have parsing activated on your account) which is generally in an HRXML format
  • bIncludeEmailBody, bIncludeAttachment, bIncludeEmail You can choose to include parts of the actual application email. From the full email (bIncludeEmail) to just the body content (bIncludeEmailBody) and the probable most appropriate attachment (bIncludeAttachment).
  • AdvertCandidateIDAsCSV You may want to select which applications to import and then re-request the data using AdvertCandidateIDAsCSV to retrieve the exact parsed data, attachments or emails for the specific applications you need.
  • LastScoreDate, LastProgressDate The date and time (UTC) and action was last performed on an application (score is flagging and progress is replying/progressing).
• GetCurrency
  

  Retrieve lookup data for a specific drop down or radio button or check box

• GetLiveAdvertPostings
• GetLiveAdvertPostingsPaged
• GetLoginURL
  

  Provides a mechanism to convert a global password for a user login to a url to authentication and log the user into LogicMelon.

  sRedirectDomain is optional (unless you are targetting specific branding) and the sRedirectURL can be used to include a redirect to the specific landing functionality.

• GetValues
  

  Retrieve lookup data for a specific drop down or radio button or check box

• QueryJobTitle
  

  Perform a job title query. For a specific location specify LocationValue, or to search specify q (minimum 2 characters) along with a priority or prefix

  • q free text query (e.g. Project)
  • Industry Return job titles in a specific industry.
• QueryLocations
  

  Perform a location query. For a specific location specify LocationValue, or to search specify q (minimum 2 characters) along with a priority or prefix

  • q free text query (e.g. Cam)
  • prefix Results only in a specific country (e.g. US) or county (e.g. GB.EEEC for Cambridgeshire).
  • priority Give higher scores by country (e.g. US) or county (e.g. GB.EEEC for Cambridgeshire).
  • LocationValue Return the data for a specific known location e.g. GB.EEEC.0460 for Cambridge in Cambridgeshire.
• TrackAdvert
  

  Provides a mechanism to search for an advert and getting tracking information on the delivery.

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

  • Destinations Optionally filter the tracking results by a comma separated list of job board destinations as either numeric id's or string identifiers.
• TrackAdvertWithFilters
  

  Provides a mechanism to search for an advert and getting tracking information on the delivery. Allows extra search Filters to be included

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

  • Destinations Optionally filter the tracking results by a list of job board destinations as either numeric id's or string identifiers.
• TrackAdvertWithFiltersPaged
  

  Paged version of TrackAdvertWithFilters. Provides a mechanism to search for an advert and getting tracking information on the delivery. Allows extra search Filters to be included

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

  • Destinations Optionally filter the tracking results by a list of job board destinations as either numeric id's or string identifiers.
• UnarchiveAdvert
  

  Provides a mechanism to restore (make visible) an advert on the system.

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

• UnarchiveAdvertWithFilters
  

  Provides a mechanism to restore (make visible) an advert on the system.

  Optionally specify a sUsername or sStartOrganisation to limit the search to a specific user (sUsername or sUserIdentifier) or specific portion of the tree (sStartOrganisation).

• UserFeedsAndQuota
  

  Return a set of feeds and quota as configured in the database.

  • sUsername, sPassword Credentials to find a users feed and quota details.
• UserFeedsAndQuotaWithDestinations
  

  Return a set of feeds and quota as configured in the database.

  • sUsername, sPassword Credentials to find a users feed and quota details.
  • Destinations Optional list of job board destinations to filter down to as either numeric id's or string identifiers.
• ValidateAdvertValues
  

  Validate a supplied set of fields against the selected destinations.

  • sUsername Optionally specify a username to collect per user settings.
  • Destinations Required list of job board destinations as either numeric id's or string identifiers.
  • AdvertValues Required (except when an sAdvertID is specified) a set of field data in the form of name value pairs (with multiple values specified in the Values node).
  • sValidateSuppliedFieldsOnly Validate all feed fields, or only validate the data supplied (true or false, default false).
  • sAdvertID, sAdvertReference, sAdvertIdentifier Optionally validate advert data already stored in the database.