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.

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 Administration.ashx but the primary service end point (which supports XML and JSON) remains Administration.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/Administration.ashx/FeedList HTTP/1.1
Content-Type: application/json
Host: api.logicmelon.com
Content-Length: nn

{ "Request":
{
	"sCultureID": "en-GB",
	"sAPIKey": "TBC",
	"sUsername": "string"
	"sPassword": "string"
	"sFeedNameSearch": "string"
  }
}

Responses commonly include a data object d

{
  "d": [{
"__type": "MPATSAPI.Models.CFeed",
"CultureID": "en",
"FeedNme": "Google",
"FeedID": 999,
"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.

• FeedAuthenticationAddUpdate
  from 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
  from 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

• FeedList
  from 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
  from 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
  from 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
  from 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
  from GetScheduleTriggers

  Returns a list of valid schedule triggers.

• GetWeeksToAdvertise
  from GetWeeksToAdvertise

  Returns a list of valid schedule triggers.

• OrganisationAdd
  from 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
  from 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
  from 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
  from 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
  from 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
  from 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
  from 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
  from 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
  from 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.