What’s new?
Addressing customer review and feedback, enhancements have been applied to existing APIs for smartAI to deliver additional data payloads to reduce the number of calls required to CRM to obtain the same level of data.
Applicant Placement Data
What's New
The Access Recruitment CRM API has been enhanced to streamline smartAI integration by including placement data directly within applicant queries. Previously, retrieving placement information required separate API calls. This enhancement embeds placement data within the applicant entity, allowing users to access both applicant and linked placement information through a single GraphQL query.
Key Features
Unified Data Retrieval: Placement data is now included as a relationship within the Applicant entity in GraphQL, eliminating the need for multiple API calls.
Enhanced Filtering: Apply placement-specific filters directly within applicant queries for more granular data retrieval.
Improved Integration Flow: Streamlined data access between Access Recruitment CRM and smartAI systems.
Technical Details
Added placements relationship to ApplicantEntity in the SDK.
Placement sub-selection now available in GraphQL queries.
API changes implemented to support embedded placement data within applicant entities.
How to Use This Feature
You can now include placement data directly in your applicant queries using the new placements sub-selection within the applicant entity. Here are some common use cases:
Basic Usage - Retrieve Applicants with Their Placements (Default: Up to 10 Placements)
graphql
{
applicants {
applicant {
applicantId
applicantName
applicantSurname
placements {
placement {
placementID
description
startDate
endDate
chargeRate
payRate
clientID
jobID
}
}
}
}
}
Control Result Size - Specify Custom Page Size
Use the pageSize parameter to retrieve more placements per applicant (up to 50):
graphql
{
applicants {
applicant {
applicantId
applicantName
applicantSurname
placements(pageSize: 50) {
placement {
placementID
description
startDate
endDate
}
}
}
}
}
Filter Placements - Search by Description
Apply filters directly to placement data within your applicant query:
graphql
{
applicants {
applicant {
applicantId
applicantName
applicantSurname
placements(filter: {description: "test"}) {
placement {
placementID
description
startDate
clientID
}
}
}
}
}
Available Placement Fields
The placement sub-selection provides access to comprehensive placement information including:
Basic details: placementID, description, startDate, endDate.
Financial data: chargeRate, payRate, salary, placementFee, commissionPerc.
Relationships: applicantId, clientID, jobID, clientContactID.
Management: primaryConsultantId, commercialManagerId, hSManagerId.
Additional fields: customFields, purchaseOrderNo, hoursPerWeek, and more.
Benefits
This enhancement improves integration efficiency by reducing the number of API calls required to retrieve comprehensive applicant and placement information, resulting in faster data retrieval and simplified integration workflows for smartAI users.
Last Notebook Item
What's New
The Access Recruitment CRM API has been enhanced to support advanced candidate filtering for smartAI integration. A new custom GraphQL endpoint (smartAIApplicants) has been added that enables filtering candidates based on notebook activity, placement history, and other key applicant fields. This enhancement improves the integration flow between Access Recruitment CRM and smartAI by providing more sophisticated candidate search capabilities.
Key Features
Notebook Activity Filtering: Filter candidates based on when the last notebook item was created, enabling identification of recently engaged candidates.
Enhanced Search Criteria: Apply multiple filters including job titles, attributes, location details, applicant status, and date ranges.
Comprehensive Data Access: Retrieve essential applicant information including contact details, location, status, and activity timestamps in a single query.
Purpose-Built Endpoint: Dedicated smartAI endpoint optimized for integration workflows.
Technical Details
New custom endpoint smartAIApplicants added to WebServices.ApiEndPoints table.
Enhanced filtering capabilities for applicant queries.
Support for date range filtering on notebook items, applicant updates, and placement start dates.
How to Use This Feature
The new smartAIApplicants endpoint accepts multiple filter parameters to refine candidate searches.
Available Filter Parameters
jobTitle (text CSV) - Filter by job title.
attributes (text CSV) - Filter by applicant attributes (allows multiple IDs to be passed).
postcode (text) - Filter by location postcode.
locationDescription (text) - Filter by location description.
applicantStatusId (int) - Filter by applicant status (allows multiple IDs to be passed).
lastNotebookItemCreatedDateFrom (date) - Filter candidates with notebook items created after this date.
lastNotebookItemCreatedDateTo (date) - Filter candidates with notebook items created before this date.
lastApplicantUpdatedDateFrom (date) - Filter candidates updated after this date.
lastApplicantUpdatedDateTo (date) - Filter candidates updated before this date.
lastPlacementStartDateFrom (date) - Filter by placement start date range (from).
lastPlacementStartDateTo (date) - Filter by placement start date range (to).
Returned Data Fields
The endpoint returns comprehensive applicant information:
Identification: applicantId, applicantName, applicantSurname, fileAs.
Job Details: jobTitle, flagText.
Location: postCode, locationId, locationDescription.
Status: applicantStatusId, applicantStatus.
Activity Timestamps: lastNotebookItemCreatedDate, lastApplicantUpdatedDate, lastPlacementStartDate.
Contact Information: primaryPhoneId, primaryPhoneNo, primaryEmailAddressPhoneId, primaryEmailAddress.
Example Use Cases
Find Recently Engaged Candidates: Filter for candidates who have had notebook items created within the last 30 days to identify actively managed applicants.
Location-Based Searches: Combine postcode and location description filters to find candidates in specific geographic areas.
Active Placement History: Use placement start date filters to identify candidates with recent placement experience.
Status-Based Filtering: Apply applicant status filters alongside activity date ranges to find candidates in specific workflow states with recent engagement.
Benefits
This enhancement improves integration efficiency by:
Reducing manual filtering - Apply sophisticated filters directly at the API level.
Identifying engaged candidates - Notebook activity timestamps help prioritize recently contacted applicants.
Streamlining workflows - Single endpoint provides all necessary data for candidate evaluation.
Enhancing match quality - Multiple filter combinations enable more precise candidate targeting.