Multiposter
API JSON Interface (JSON version of SOAP api interface)
Introduction
A set of JSON based API services to interact with the multiple job posting and applicant tracking system. There is also an optional Administration service around managing users, credentials and quota.
This is based on the XML based SOAP service but will accept and return JSON (and standard SOAP). Simply change your Content-Type to be application/json and convert the XML sample object into a compatible and similar JSON object and JSON will be returned. You can convert the XML to JSON structures here.
You can view JSON payload samples through Multiposter.ashx but the primary service end point (which supports XML and JSON) remains Multiposter.asmx.
Important: To receive back JSON the request has to be a POST made with the Content-Type: application/json to prevent CSS attacks. (Why HTTP POST with Content-Type: application/json)
By example:
POST https://api.logicmelon.com/JSON/Multiposter.asmx/GetValues HTTP/1.1 Content-Type: application/json Host: api.logicmelon.com Content-Length: nn { "Request": { "sCultureID": "en-GB", "sAPIKey": "TBC", "sFieldID": "15" } }
Responses commonly include a data object d
{ "d": [{ "__type": "MPATSAPI.Models.GetValue", "CultureID": "en", "Description": "Accounting", "FieldID": 15, "OrganisationID": 0, "SortOrder": null, "Value": "AC" }, ... ] }
or an exception or message object
{ "Message": "message", "StackTrace": " at ...", "ExceptionType": "System.TypeOfException" }
Service Description
The following operations are supported. For a formal definition, please review the Service Description.
-
AddAdvert
from AddAdvertWithValuesCreate an advert on the system and return a redirect url for the user to complete the posting process.
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "string", "sAPIKey": "string", "sUsername": "string", "sPassword": "string", "sAdvertIdentifier": "string", "sAdvertReference": "string", "sSearchDays": "string", "sOnDuplicate": "string", "sJobTitle": "string", "sJobType": "string", "sJobHours": "string", "sPrimaryLocation": "string", "sIndustry": "string", "sSalaryFrom": "string", "sSalaryTo": "string", "sSalaryCurrency": "string", "sSalaryPer": "string", "sSalaryBenefits": "string", "sContactName": "string", "sContactEmail": "string", "sJobDescription": "string", "sApplicationURL": "string", "sApplicationCallbackURL": "string", "sIframe": "string", "DestinationsAsCSV": "string", "Destinations": [ "string", "string" ], "sFuturePostDateTimeInUtc": "string", "FuturePostDateTimeInUtc": "dateTime", "sRedirectDomain": "string", "sAdvertStatusID": "string", "sAdvertID": "string", "AdvertValues": [ { "Name": "string", "Value": "string", "Values": [] }, { "Name": "string", "Value": "string", "Values": [] } ] } } -
AddAdvertCandidate
from AddAdvertCandidateWithFiltersAttach 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.
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", ... } } -
AddAdvertCandidateNote
from AddAdvertCandidateNoteProvides a mechanism to add a note to a candidate.
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "string", "sAPIKey": "string", "sUsername": "string", "sPassword": "string", "sAdvertID": "string", "sAdvertCandidateID": "string", "sSubject": "string", "sBody": "string"} } -
AddAdvertCandidateWithDocument
from AddAdvertCandidateWithDocument -
AddAdvertValues
from AddAdvertValuesUpdate field values against a current advert.
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "string", "sAPIKey": "string", "sUsername": "string", "sPassword": "string", "sAdvertIdentifier": "string", "sAdvertReference": "string", "sAdvertID": "string", "sSearchDays": "string", "AdvertValues": [ { "Name": "string", "Value": "string", "Values": [] }, { "Name": "string", "Value": "string", "Values": [] } ], "sRedirectDomain": "string" } } -
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
-
ArchiveAdvert
from ArchiveAdvertWithFiltersProvides 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.
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", ... } } -
CandidateTag
from CandidateTagProvides 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
HTTP POST with Content-Type: application/json
{ "Request": { "sAPIKey": "string", "sCandidateEmail": "string", "sCandidateFirstName": "string", "sCandidateLastName": "string", "Tag": "string" } } -
CloseAdvert
from CloseAdvertWithFiltersProvides 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
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", ... } } -
DeliverAdvert
from DeliverAdvertValidate an existing advert against a supplied set of destinations and mark for delivery if valid.
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", ... } } -
ExpressPostAdvert
from ExpressPostAdvertWithFiltersProvides 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
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", ... } } -
GetAdvert
from GetAdvertWithValuesWithFiltersProvides 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).
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", ... } } -
GetAdvertPaged
from GetAdvertWithValuesWithFiltersPagedPaged 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).
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", ... }, "CurrentPage": 1, "RowsPerPage": 10, "OrderBy": "LastPostDate desc" } -
GetApplications
from GetApplicationsWithFiltersProvides 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.
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", ... } } -
GetApplicationsPaged
from GetApplicationsWithFiltersPagedPaged 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.
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", ... }, "CurrentPage": 1, "RowsPerPage": 10, "OrderBy": "LastPostDate desc" } -
GetCurrency
from GetCurrencyRetrieve lookup data for a specific drop down or radio button or check box
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string" } } -
GetLoginURL
from GetLoginURLResultProvides a mechanism to convert a global password for a user login to a url to authentication and log the user into LogicMelon.
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", "sUsername": "string", "sPassword": "string", "sRedirectDomain": "string", "returnUrl": "string" } } - GetTypes
-
GetValues
from GetValuesRetrieve lookup data for a specific drop down or radio button or check box
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", "sFieldID": "string" } } -
QueryJobTitle
from QueryJobTitlePerform a job title query. For a specific location specify LocationValue, or to search specify q (minimum 2 characters) along with a priority or prefix
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", "q": "string", "Industry": "string" } } -
QueryLocations
from QueryLocationsPerform a location query. For a specific location specify LocationValue, or to search specify q (minimum 2 characters) along with a priority or prefix
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", "q": "string", "prefix": "string", "priority": "string", "LocationValue": "string" } } - SaveTypes
-
TrackAdvert
from TrackAdvertWithFiltersProvides a mechanism to search for an advert and getting tracking information on the delivery. Allows extra search Filters to be included
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", ... } } -
UnarchiveAdvert
from UnarchiveAdvertWithFiltersProvides a mechanism to restore (make visible) an advert on the system.
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", ... } } -
UserFeedsAndQuota
from UserFeedsAndQuotaWithDestinationsReturn a set of feeds and quota as configured in the database.
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "string", "sAPIKey": "string", "sUsername": "string", "sPassword": "string" "DestinationsAsCSV": "string", "Destinations": [ "string", "string" ] } } -
ValidateAdvertValues
from ValidateAdvertValuesValidate a supplied set of fields against the selected destinations.
HTTP POST with Content-Type: application/json
{ "Request": { "sCultureID": "", "sAPIKey": "string", ... } }