Multiposter
Click here for a complete list of operations.
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).
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /SOAP/Multiposter.asmx HTTP/1.1
Host: api.logicmelon.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.logicmelon.com/GetApplicationsWithFiltersPaged"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetApplicationsWithFiltersPaged xmlns="http://api.logicmelon.com/">
<sCultureID>string</sCultureID>
<sAPIKey>string</sAPIKey>
<sUsername>string</sUsername>
<sUserIdentifier>string</sUserIdentifier>
<sStartOrganisation>string</sStartOrganisation>
<sAdvertIdentifier>string</sAdvertIdentifier>
<sAdvertReference>string</sAdvertReference>
<sAdvertID>string</sAdvertID>
<Destinations>
<string>string</string>
<string>string</string>
</Destinations>
<ApplicationStartDateTime>dateTime</ApplicationStartDateTime>
<ApplicationEndDateTime>dateTime</ApplicationEndDateTime>
<Ranking>
<string>string</string>
<string>string</string>
</Ranking>
<ProgressID>
<string>string</string>
<string>string</string>
</ProgressID>
<AdvertCandidateID>
<string>string</string>
<string>string</string>
</AdvertCandidateID>
<bIncludeEmailBody>boolean</bIncludeEmailBody>
<bIncludeAttachment>boolean</bIncludeAttachment>
<bIncludeParsed>boolean</bIncludeParsed>
<bIncludeEmail>boolean</bIncludeEmail>
<LastScoreDate>dateTime</LastScoreDate>
<LastProgressDate>dateTime</LastProgressDate>
<Filters>
<NameValueFilter>
<Name>string</Name>
<Value>string</Value>
<Values>
<string>string</string>
<string>string</string>
</Values>
<ValueDateTime>dateTime</ValueDateTime>
<Comparitor>Equals or StartsWith or EndsWith or Contains or LessThan or GreaterThan or LessThanDate or GreaterThanDate</Comparitor>
</NameValueFilter>
<NameValueFilter>
<Name>string</Name>
<Value>string</Value>
<Values>
<string>string</string>
<string>string</string>
</Values>
<ValueDateTime>dateTime</ValueDateTime>
<Comparitor>Equals or StartsWith or EndsWith or Contains or LessThan or GreaterThan or LessThanDate or GreaterThanDate</Comparitor>
</NameValueFilter>
</Filters>
<CurrentPage>int</CurrentPage>
<RowsPerPage>int</RowsPerPage>
<OrderBy>string</OrderBy>
</GetApplicationsWithFiltersPaged>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetApplicationsWithFiltersPagedResponse xmlns="http://api.logicmelon.com/">
<ApplicationPaged>
<PageCount>int</PageCount>
<PageIndex>int</PageIndex>
<TotalItemCount>int</TotalItemCount>
<Applications>
<APIApplication>
<SchemaIdentifier>string</SchemaIdentifier>
<AdvertCandidateID>int</AdvertCandidateID>
<AdvertID>int</AdvertID>
<AdvertIdentifier>string</AdvertIdentifier>
<AdvertReference>string</AdvertReference>
<AdvertTitle>string</AdvertTitle>
<PostingID>int</PostingID>
<FeedID>int</FeedID>
<FeedName>string</FeedName>
<CandidateID>int</CandidateID>
<ApplicationDate>dateTime</ApplicationDate>
<EmailAddress>string</EmailAddress>
<LastName>string</LastName>
<FirstName>string</FirstName>
<HomePhone>string</HomePhone>
<WorkPhone>string</WorkPhone>
<MobilePhone>string</MobilePhone>
<Address>string</Address>
<Viewed>boolean</Viewed>
<Score>short</Score>
<Ranking>string</Ranking>
<ProgressID>int</ProgressID>
<Progress>string</Progress>
<UserID>int</UserID>
<OrganisationID>int</OrganisationID>
<OrganisationName>string</OrganisationName>
<Archived>boolean</Archived>
<Favourite>boolean</Favourite>
<EmailBody xsi:nil="true" />
<EmailFirstAttachment xsi:nil="true" />
<Parsed xsi:nil="true" />
<Email xsi:nil="true" />
<APIProcessingMessages>string</APIProcessingMessages>
<LastScoreDate>dateTime</LastScoreDate>
<LastProgressDate>dateTime</LastProgressDate>
<LastNoteDate>dateTime</LastNoteDate>
<sApplicationDate>string</sApplicationDate>
<sLastNoteDate>string</sLastNoteDate>
<sLastScoreDate>string</sLastScoreDate>
<sLastProgressDate>string</sLastProgressDate>
</APIApplication>
<APIApplication>
<SchemaIdentifier>string</SchemaIdentifier>
<AdvertCandidateID>int</AdvertCandidateID>
<AdvertID>int</AdvertID>
<AdvertIdentifier>string</AdvertIdentifier>
<AdvertReference>string</AdvertReference>
<AdvertTitle>string</AdvertTitle>
<PostingID>int</PostingID>
<FeedID>int</FeedID>
<FeedName>string</FeedName>
<CandidateID>int</CandidateID>
<ApplicationDate>dateTime</ApplicationDate>
<EmailAddress>string</EmailAddress>
<LastName>string</LastName>
<FirstName>string</FirstName>
<HomePhone>string</HomePhone>
<WorkPhone>string</WorkPhone>
<MobilePhone>string</MobilePhone>
<Address>string</Address>
<Viewed>boolean</Viewed>
<Score>short</Score>
<Ranking>string</Ranking>
<ProgressID>int</ProgressID>
<Progress>string</Progress>
<UserID>int</UserID>
<OrganisationID>int</OrganisationID>
<OrganisationName>string</OrganisationName>
<Archived>boolean</Archived>
<Favourite>boolean</Favourite>
<EmailBody xsi:nil="true" />
<EmailFirstAttachment xsi:nil="true" />
<Parsed xsi:nil="true" />
<Email xsi:nil="true" />
<APIProcessingMessages>string</APIProcessingMessages>
<LastScoreDate>dateTime</LastScoreDate>
<LastProgressDate>dateTime</LastProgressDate>
<LastNoteDate>dateTime</LastNoteDate>
<sApplicationDate>string</sApplicationDate>
<sLastNoteDate>string</sLastNoteDate>
<sLastScoreDate>string</sLastScoreDate>
<sLastProgressDate>string</sLastProgressDate>
</APIApplication>
</Applications>
</ApplicationPaged>
</GetApplicationsWithFiltersPagedResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /SOAP/Multiposter.asmx HTTP/1.1
Host: api.logicmelon.co.uk
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetApplicationsWithFiltersPaged xmlns="http://api.logicmelon.com/">
<sCultureID>string</sCultureID>
<sAPIKey>string</sAPIKey>
<sUsername>string</sUsername>
<sUserIdentifier>string</sUserIdentifier>
<sStartOrganisation>string</sStartOrganisation>
<sAdvertIdentifier>string</sAdvertIdentifier>
<sAdvertReference>string</sAdvertReference>
<sAdvertID>string</sAdvertID>
<Destinations>
<string>string</string>
<string>string</string>
</Destinations>
<ApplicationStartDateTime>dateTime</ApplicationStartDateTime>
<ApplicationEndDateTime>dateTime</ApplicationEndDateTime>
<Ranking>
<string>string</string>
<string>string</string>
</Ranking>
<ProgressID>
<string>string</string>
<string>string</string>
</ProgressID>
<AdvertCandidateID>
<string>string</string>
<string>string</string>
</AdvertCandidateID>
<bIncludeEmailBody>boolean</bIncludeEmailBody>
<bIncludeAttachment>boolean</bIncludeAttachment>
<bIncludeParsed>boolean</bIncludeParsed>
<bIncludeEmail>boolean</bIncludeEmail>
<LastScoreDate>dateTime</LastScoreDate>
<LastProgressDate>dateTime</LastProgressDate>
<Filters>
<NameValueFilter>
<Name>string</Name>
<Value>string</Value>
<Values>
<string>string</string>
<string>string</string>
</Values>
<ValueDateTime>dateTime</ValueDateTime>
<Comparitor>Equals or StartsWith or EndsWith or Contains or LessThan or GreaterThan or LessThanDate or GreaterThanDate</Comparitor>
</NameValueFilter>
<NameValueFilter>
<Name>string</Name>
<Value>string</Value>
<Values>
<string>string</string>
<string>string</string>
</Values>
<ValueDateTime>dateTime</ValueDateTime>
<Comparitor>Equals or StartsWith or EndsWith or Contains or LessThan or GreaterThan or LessThanDate or GreaterThanDate</Comparitor>
</NameValueFilter>
</Filters>
<CurrentPage>int</CurrentPage>
<RowsPerPage>int</RowsPerPage>
<OrderBy>string</OrderBy>
</GetApplicationsWithFiltersPaged>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetApplicationsWithFiltersPagedResponse xmlns="http://api.logicmelon.com/">
<ApplicationPaged>
<PageCount>int</PageCount>
<PageIndex>int</PageIndex>
<TotalItemCount>int</TotalItemCount>
<Applications>
<APIApplication>
<SchemaIdentifier>string</SchemaIdentifier>
<AdvertCandidateID>int</AdvertCandidateID>
<AdvertID>int</AdvertID>
<AdvertIdentifier>string</AdvertIdentifier>
<AdvertReference>string</AdvertReference>
<AdvertTitle>string</AdvertTitle>
<PostingID>int</PostingID>
<FeedID>int</FeedID>
<FeedName>string</FeedName>
<CandidateID>int</CandidateID>
<ApplicationDate>dateTime</ApplicationDate>
<EmailAddress>string</EmailAddress>
<LastName>string</LastName>
<FirstName>string</FirstName>
<HomePhone>string</HomePhone>
<WorkPhone>string</WorkPhone>
<MobilePhone>string</MobilePhone>
<Address>string</Address>
<Viewed>boolean</Viewed>
<Score>short</Score>
<Ranking>string</Ranking>
<ProgressID>int</ProgressID>
<Progress>string</Progress>
<UserID>int</UserID>
<OrganisationID>int</OrganisationID>
<OrganisationName>string</OrganisationName>
<Archived>boolean</Archived>
<Favourite>boolean</Favourite>
<EmailBody xsi:nil="true" />
<EmailFirstAttachment xsi:nil="true" />
<Parsed xsi:nil="true" />
<Email xsi:nil="true" />
<APIProcessingMessages>string</APIProcessingMessages>
<LastScoreDate>dateTime</LastScoreDate>
<LastProgressDate>dateTime</LastProgressDate>
<LastNoteDate>dateTime</LastNoteDate>
<sApplicationDate>string</sApplicationDate>
<sLastNoteDate>string</sLastNoteDate>
<sLastScoreDate>string</sLastScoreDate>
<sLastProgressDate>string</sLastProgressDate>
</APIApplication>
<APIApplication>
<SchemaIdentifier>string</SchemaIdentifier>
<AdvertCandidateID>int</AdvertCandidateID>
<AdvertID>int</AdvertID>
<AdvertIdentifier>string</AdvertIdentifier>
<AdvertReference>string</AdvertReference>
<AdvertTitle>string</AdvertTitle>
<PostingID>int</PostingID>
<FeedID>int</FeedID>
<FeedName>string</FeedName>
<CandidateID>int</CandidateID>
<ApplicationDate>dateTime</ApplicationDate>
<EmailAddress>string</EmailAddress>
<LastName>string</LastName>
<FirstName>string</FirstName>
<HomePhone>string</HomePhone>
<WorkPhone>string</WorkPhone>
<MobilePhone>string</MobilePhone>
<Address>string</Address>
<Viewed>boolean</Viewed>
<Score>short</Score>
<Ranking>string</Ranking>
<ProgressID>int</ProgressID>
<Progress>string</Progress>
<UserID>int</UserID>
<OrganisationID>int</OrganisationID>
<OrganisationName>string</OrganisationName>
<Archived>boolean</Archived>
<Favourite>boolean</Favourite>
<EmailBody xsi:nil="true" />
<EmailFirstAttachment xsi:nil="true" />
<Parsed xsi:nil="true" />
<Email xsi:nil="true" />
<APIProcessingMessages>string</APIProcessingMessages>
<LastScoreDate>dateTime</LastScoreDate>
<LastProgressDate>dateTime</LastProgressDate>
<LastNoteDate>dateTime</LastNoteDate>
<sApplicationDate>string</sApplicationDate>
<sLastNoteDate>string</sLastNoteDate>
<sLastScoreDate>string</sLastScoreDate>
<sLastProgressDate>string</sLastProgressDate>
</APIApplication>
</Applications>
</ApplicationPaged>
</GetApplicationsWithFiltersPagedResponse>
</soap12:Body>
</soap12:Envelope>