API SOAP Interface

Introduction

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

There is a JSON version of these services available that is based on this SOAP service but supports JSON payloads..

Many of the methods will not require any further input for an 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 that is performing the admin action
• sPassword The password of the user that is performing the admin action
• sOrganisationIdentifier Generally where specified to limit the amount of the organisation-user tree that can be listed/accessed/updated.
• sUserIdentifier Generally where specified to limit the amount of the organisation-user tree that can be listed/accessed/updated based on the position in the tree of the selected user.

The add/update methods are designed where possible to retrieve an object using the list method and pass the object back in the add/update methods

Service Description

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

• FeedAuthenticationAddUpdate
  

  Update one or more sets of feed credentials.
  Optionally specify a higher level login and a sOrganisationIdentifier or sUserIdentifier.

  • OrganisationID or OrganisationIdentifier required.
  • UserID or UserIdentifier Optional to target a specific user
  • FeedID or FeedIdentifier required.
  • AuthValue1..5 Depending on feed requirements
  
  The following items are processed on the CFeedWithAuthentication class and the CFeed items are in general ignored
  FeedID, FeedIdentifier, FeedCost, FeedCostTypeID, CurrencyID, TurnOffDate, DefaultSelected, ForceSelected, Restricted, ReferencePrefix, ReferenceSuffix, ClientIdentifier, ClientName, OrganisationID, OrganisationIdentifier, UserID, UserIdentifier, AuthValue1, AuthValue2, AuthValue3, AuthValue4, AuthValue5,
• FeedAuthenticationList
  

  Provides a mechanism to retrieve the feed credentials for a specific organisation or user.
  Optionally specify a higher level login and a sOrganisationIdentifier or sUserIdentifier

  • DestinationsAsCSV Optional list of feeds as either numeric id's or string identifiers
  
  This item contains both authentication details (AuthValue1..5, FeedCost.. etc) and feed list details (FeedIdentifier, FeedName, AuthNotes, etc).
• FeedList
  

  Provides a mechanism to search for a list of currently configured feeds for a specific organisation or user.
  Optionally specify a higher level login and a sOrganisationIdentifier or sUserIdentifier

  • sFeedNameSearch filter the results based on a string filter (e.g. mon to return e.g. Monster)
• FeedPublicList
  

  Provides a mechanism to search for a list of public feeds for a specific organisation or user.
  Optionally specify a higher level login and a sOrganisationIdentifier or sUserIdentifier

  • sFeedNameSearch filter the results based on a string filter (e.g. mon to return e.g. Monster)
• FeedQuotaAddUpdate
  

  Update one or more sets of feed credentials.
  Optionally specify a higher level login and a sOrganisationIdentifier or sUserIdentifier.

  • OrganisationID or OrganisationIdentifier required.
  • UserID or UserIdentifier Optional to target a specific user
  • FeedID or FeedIdentifier required.
  
  The following items are processed on the CFeedWithQuota class and the CFeed items are in general ignored
  FeedID, FeedIdentifier, Slots, Postings, Spend, QuotaWarningLevel, SchedulePostings, ScheduleSpend, ScheduleTrigger, OrganisationID, OrganisationIdentifier, UserID, UserIdentifier,
• FeedQuotaList
  

  Provides a mechanism to retrieve the feed credentials for a specific organisation or user.
  Optionally specify a higher level login and a sOrganisationIdentifier or sUserIdentifier

  • DestinationsAsCSV Optional list of feeds as either numeric id's or string identifiers
  
  This item contains both Quota details (AuthValue1..5, FeedCost.. etc) and feed list details (FeedIdentifier, FeedName, AuthNotes, etc).
• GetScheduleTriggers
  

  Returns a list of valid schedule triggers.

• GetWeeksToAdvertise
  

  Returns a list of valid schedule triggers.

• OrganisationAdd
  

  Provides a mechanism to create a new organisation.
  Please note sParentOrganisationIdentifier is required to indicate placement in the tree (either a valid numeric OrganisationID or string OrganisationIdentifier).
  The newly created organisation is returned or null if failed.

• OrganisationAndUserAdd
  

  Sep 2018. Provides a mechanism to create a new organisation and user at the same time.
  Please note sParentOrganisationIdentifier is required to indicate placement in the tree (either a valid numeric OrganisationID or string OrganisationIdentifier).
  The newly created organisation is returned or null if failed.

• OrganisationDelete
  

  Provides a mechanism to delete an existing organisation.
  It is suggested to get an organisation object using OrganisationList, and then submit back in this function.
  Please note that all child orgs and users will become inaccessible.
  True is returned if the deletion is successful.

• OrganisationList
  

  Provides a mechanism to search for a list of organisations based on a administrators credentials and optional a top level organisation identifier.
  If an organisation identifier (numeric OrganisationID or string OrganisationIdentifier) it will look for the specific active organisation.

• OrganisationUpdate
  

  Provides a mechanism to update an existing organisation.
  It is suggested to get an organisation object using OrganisationList, modify values, and then submit back in this function.
  Only certain fields are updateable.
  The updated organisation is returned.

• UserAdd
  

  Provides a mechanism to create a new user.
  Please note sParentOrganisationIdentifier is required to indicate placement in the tree (either a valid numeric OrganisationID or string OrganisationIdentifier).
  The newly created user is returned.

• UserDelete
  

  Provides a mechanism to delete an existing user.
  It is suggested to get a user object using UserList, and then submit back in this function.
  True is returned if the delete is successful.

• UserList
  

  Provides a mechanism to search for a list of users based on a administrators credentials and optional a top level organisation identifier.
  If a user identifier (numeric UserID or string UserIdentifier) it will look for the specific active user.

• UserUpdate
  

  Provides a mechanism to update an existing user.
  It is suggested to get a user object using UserList, modify values, and then submit back in this function.
  Only certain fields are updateable.
  The updated user is returned.
  Important notes: You are not able to move users using this function.