{"info":{"_postman_id":"e24e97df-030b-4498-b4bd-5405d429d80a","name":"Jobtrain - OpenAPI","description":"

Current Version: 1.0

Last Revision: 20/10/25

Jobtrain's OpenAPI based on the OpenAPI 3.0 specification. You can find out more about Jobtrain at https://jobtrain.co.uk.

Jobtrain's API enables client internal IT/software teams or authorized third parties to build integrations with Jobtrain and provides a standard interface for data exchange.

If you would like to use the API to build your own integrations, speak with your Continuous Improvement Consultant about arranging a Partnership Agreement, after which, we can provide your Client ID and credentials.

If you have any queries regarding the API, please get in touch with our Support Team.

FAQs

Why am I not getting the number of expected records? There are 300 candidates in a job, but I'm only seeing 20.
\n
1. By default the page size is limited to 20 records. This can be changed using the PageSize parameter, up to a max of 100.
  \n
2. To retrieve more records, please use pagination to move between the pages. This can be controlled using the PageNo parameter.
  \n
\n
What's the difference between total and results?
\n
1. At the top of some calls, you may see these two numbers.
  \n
2. Total is the overall number of records returned via that call.
  \n
3. Results is the number of those overall records being shown in the current page. This will usually be the same as PageSize, unless there are too few results to fill the page.
  \n
\n

\n\n

Response Codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Code	Description
200 OK	Indicates that the request has succeeded.
400 Invalid Format	The server cannot understand the information that you are trying to send because it is not in the correct format. This could be due to a number of reasons, such as incorrect data types, missing or incomplete fields, or an issue with the way the data is being formatted. To resolve this issue, double-check the data that you are sending and ensure that it is in the correct format.
401 Access Denied	You do not have the necessary permissions to access the information or perform the action you requested. This could be due to several reasons, such as an expired session, invalid credentials, or insufficient privileges. To resolve this error, you should verify that you have entered the correct credentials and try again.
403 Authentication Failure	You do not have the necessary permissions to access the requested resource. To resolve this error, you should verify that you are using the correct authentication credentials and that your user account has the necessary permissions to access the resource.
404 Job or Application data does not exist	This job / application does not exist. Please verify that you have entered the correct ID and that the job / application still exists in Jobtrain.
408 Request Timeout	The server did not receive a complete request from the client within the time frame allowed for the request to be completed. This could happen due to a slow network connection, high traffic on the server, or a long processing time required for the request. Try resending the request to the server. If the issue persists, you may need to check your network connection or contact the server administrator or support team for further assistance in resolving the issue.
409 Duplicate Data	Your request included data that already exists in the database. To resolve this error, you should verify that the data you are submitting is unique and does not conflict with existing data on the server. Candidate data must have a unique email address AND first name + surname + postcode must be unique.
410 Job Closed	The job you are trying to access or perform an action against is now closed.
413 Files are too large	The payload (i.e., the data being sent) is too large. Try reducing the size of the payload by compressing files or reducing the amount of data being sent. CVs and files must be less than 1MB.
418 I’m a Teapot	This is not a valid HTTP status code and is intended as a joke or for testing purposes only. Please check your request and try again with a valid HTTP status code.
422 Mandatory field missing	The server was unable to process the request because a mandatory field is missing or contains invalid data. This error typically occurs when a required field is left blank or contains data that does not meet requirements, such as an invalid data type or format. It can also occur if a client tries to submit a request without providing all the necessary data or with data that does not meet the validation rules. To resolve this error, you should review the data you are trying to submit and ensure that all mandatory fields are present and contain valid data. You may also need to review Jobtrain’s validation rules and ensure that your data meets those requirements.
429 Too Many Requests	The client has sent too many requests in a given period and the server is temporarily unable to handle additional requests. The client should reduce the rate of requests and try again later.
500 Internal Server Error	There may be a problem with the server's configuration (this could be a misconfigured setting or insufficient system resources caused by a high volume of traffic). To resolve this error, you should try repeating the action that caused the error. If the error persists, you may need to wait and try again later, as the issue may be temporary and resolved by the server automatically. If the issue continues, you may need to contact the support team for further assistance in resolving the issue.
503 Service Unavailable	The server is temporarily unable to handle the request due to maintenance or overload. To resolve this error, you should try repeating the action that caused the error after a few minutes or wait for the server to complete maintenance. If the error persists, you may need to contact the support team.

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"28190791","collectionId":"e24e97df-030b-4498-b4bd-5405d429d80a","publishedId":"2s9Y5SV57T","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"177e9c"},"publishDate":"2026-01-19T14:18:50.000Z"},"item":[{"name":"Token","item":[{"name":"/connect/token","id":"ecb797d5-9406-4a14-a97c-1d0871199fbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"username\": \"\",\n \"password\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BaseURL}}/connect/token","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Value	Description
clientID	Provided by Jobtrain. This is unique per client.
clientSecret	Provided by Jobtrain. This is unique per client.
username	Username in Jobtrain of the user who is authenticating. This allows for access controls to be applied.
password	The user's API key from User Settings.

This forms part of the authorisation process, to generate the bearer token needed to authenticate the API calls. Please note that the token expires after 15 minutes.

\n","_postman_id":"0de0d921-ba68-4573-965e-6feec423178b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"e24e97df-030b-4498-b4bd-5405d429d80a","id":"e24e97df-030b-4498-b4bd-5405d429d80a","name":"Jobtrain - OpenAPI","type":"collection"}}},{"name":"Candidate","item":[{"name":"Get a list of applications by Candidate ID","id":"9ee7dec1-f2bf-4cfd-8607-19f551b1acdc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/JSON"}],"url":"{{BaseURL}}/api/v1/Candidate/:Id","description":"

Returns the applications made by a single candidate. By passing the Candidate ID, this will return the core candidate information, along with details of the jobs they have applied for, and the status of those applications.

Request Body description

Field	Type	Description
id	Integer	Candidate ID
firstName	String	Candidate's first name
lastName	String	Candidate's last name
mobile	Integer	Candidate's mobile number
email	String	Candidate's email address
address	Object	Contains the candidate's address information
addressLine1	String	1st line of the candidate's address
addressLine2	String	2nd line of the candidate's address
city	String	Candidate's city
county	String	Candidate's county
country	String	Candidate's country
countryISOCode	String	Country ISO Code (2 or 3 digit)
postcode	String	Candidate's postcode
appliedJobs	Object	Contains information about each of the candidate's applications
applicationID	Integer	ID for this specific application
candidateID	Integer	ID of the candidate
jobID	Integer	ID of the Job
jobReference	String	Unique reference for the Job within the ATS
agreedToTerms	Boolean	Whether the candidate has agreed to the Terms and Conditions
source	String	How the candidate found the job advert (source tracking field).
advertTracking	String	Answer the candidate gave on the application form to where they found the job.
createdOnDate	Date/Time	The Date & Time the candidate started the application
applicationSubmittedOn	Date	The Date & Time the candidate submitted the application
ranking	Integer	Star ranking of the application
applicationStatus	Object	Contains the details of the applications status
id	Integer	ID of the application status
statusName	String	Internal/primary name of the application status
statusNameForCandidates	String	External/candidate facing name of the status

Retrieves detailed application details of a candidate's application against a specific Job, as well as the details of the job, by passing the Candidate ID, and the Job ID.

Request Body Description

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
id	Integer	Candidate ID
firstName	String	Candidate's first name
lastName	String	Candidate's last name
email	String	Candidate's email address
mobile	Integer	Candidate's mobile phone number
address	Object	Contains the candidate's address information
addressLine1	String	1st line of the candidate's address
addressLine2	String	2nd line of the candidate's address
city	String	Candidate's city
county	String	Candidate's county
country	String	Candidate's country
countryISOCode	String	Country ISO Code (2 or 3 digit)
postcode	String	Candidate's postcode
candidateCreatedOn	Date/Time	Candidate created date
candidateAppliedOn	Date/Time	Candidate applied on date
candidateStatusID	Integer	ID of candidate status
candidateStatus	String	Candidate's application status
candidateStatusForCandidates	String	Candidate facing name of the candidate's application status
candidateStatusCreatedDate	Date	Date the candidate was moved to this status.
agreedToTerms	Integer	0 or 1, if the candidate has not, or has agreed to the terms and conditions to submit their application
candidateType	String	Which portal they applied through (Internal/External/Agency)
userAdded	String	Name of theuser who added the candidate (if applicable)
agencySupplier	String	Name of Agency who submitted the candidate (if applicable)
daysFromApplicationToStart	Integer	Number of days from application date to candidate start date
candidateStartDate	Date	Candidate's start date
CV	Object	Object containing the CV
fileName	String	Name of the file
contentType	String	The type of file
data	String	Base64 encoded string. Total file size should be less than 1MB
coverLetter	Object	Object containing the Cover Letter
fileName	String	Name of the file
contentType	String	The type of file
data	String	Base64 encoded string. Total file size should be less than 1MB
equalOps	Object	Object containing the candidate answers to the EqualOps questions
applicationID	Integer	Candidate Application ID
candidateID	Integer	Candidate ID
equalOpsEthnicity	String	Answer to the Equal Ops question
equalOpsSex	String	Answer to the Equal Ops question
equalOpsGender	String	Answer to the Equal Ops question
equalOpsMarital	String	Answer to the Equal Ops question
equalOpsNationality	String	Answer to the Equal Ops question
equalOpsReligion	String	Answer to the Equal Ops question
equalOpsOrientation	String	Answer to the Equal Ops question
equalOpsDisability	String	Candidate's answer to the 'Do you consider yourself to be disabled' standard question in the application form
equalOpsDisabilityDescription	String	Candidate's response to 'If yes, please give more details'
jobDetail	Object	Object containing details of the Job
applicationId	Integer	Candidate Application ID
candidateId	Integer	Candidate ID
jobId	Integer	Job ID
jobReference	String	Unique Job Reference, set by the ATS
jobTitle	String	Internal/Primary job title
jobTitleForCandidates	String	External/Candidate job title
isLiveForCandidates	Yes/No	Whether job is live for candidates
jobLocation	String	Location, set in the Job Details page
locationRegion	String	Job Location/Region
vacancyDepartment	String	Department, set in the Job Details page
vacancySchoolLocation	String	School Location, set in the Job Details page
vacancyDivision	String	Divison, set in the Job Details page
vacancyCampaign	String	Campaign, set in the Job Details page
vacancyCostCentre	String	Cost Centre, set in the Job Details page
jobEmploymentType	String	Employment Type, set in the Job Details page
jobHoursPerWeek	String	Hours per Week, set in the Job Details page
jobNumberVacancies	Integer	No. of Vacancies, set in the Job Details page
jobReportsTo	String	ReportsTo field, set in the Job Details page
userFirstName	String	Name of user who created the job
userLastName	String	Name of user who created the job
jobApprovedDate	Date/Time	Date/Time the job was approved
jobClosingDate	Date/Time	Date/Time the job advert closed
jobCreatedDate	Date/Time	Date/Time the job was created
jobLiveDate	Date/Time	Date/Time the job was moved to the Live status
jobStatusName	Object	Object containing the Job Status details
id	Integer	Job Status ID
name	String	Name of the Job Status

\",\n \"candidateAppliedOn\": \"

\",\n \"candidateStatusId\": \"\",\n \"candidateStatus\": \"\",\n \"candidateStatusForCandidates\": \"\",\n \"candidateStatusCreatedDate\": \"

\",\n \"agreedToTerms\": \"\",\n \"candidateType\": \"\",\n \"userAdded\": \"\",\n \"agencySupplier\": \"\",\n \"daysFromApplicationToStart\": \"\",\n \"candidateStartDate\": \"

\",\n \"cv\": {\n \"fileName\": \"\",\n \"contentType\": \"\",\n \"data\": \"\"\n },\n \"coverLetter\": {\n \"fileName\": \"\",\n \"contentType\": \"\",\n \"data\": \"\"\n },\n \"equalOps\": {\n \"applicationid\": \"\",\n \"candidateid\": \"\",\n \"equalOpsEthnicity\": \"\",\n \"equalOpsSex\": \"\",\n \"equalOpsGender\": \"\",\n \"equalOpsMarital\": \"\",\n \"equalOpsNationality\": \"\",\n \"equalOpsReligion\": \"\",\n \"equalOpsOrientation\": \"\",\n \"equalOpsDisability\": \"\",\n \"equalOpsDisabilityDescription\": \"\"\n },\n \"jobDetails\": {\n \"applicationId\": \"\",\n \"candidateId\": \"\",\n \"jobId\": \"\",\n \"jobReference\": \"\",\n \"jobTitle\": \"\",\n \"jobTitleForCandidate\": \"\",\n \"isliveForCandidates\": \"\",\n \"jobLocation\": \"\",\n \"locationRegion\": \"\",\n \"vacancyDepartment\": \"\",\n \"vacancySchoolLocation\": \"\",\n \"vacancyDivision\": \"\",\n \"vacancyCampaign\": \"\",\n \"vacancyCostCentre\": \"\",\n \"jobEmploymentType\": \"\",\n \"jobHoursPerWeek\": \"\",\n \"jobNumberVacancies\": \"\",\n \"jobReportsTo\": \"\",\n \"userFirstName\": \"\",\n \"userLastName\": \"\",\n \"jobApprovedDate\": \"

\",\n \"jobClosingDate\": \"

\",\n \"jobCreatedDate\": \"

\",\n \"jobLiveDate\": \"

\",\n \"advertisedType\": \"\"\n },\n \"jobStatus\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n}"},{"id":"58e09f41-f866-4c56-a340-2cc1b76393a3","name":"Invalid ID supplied","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/v1/Candidate/GetCandidateApplicationDetailByJobId/:candidateId/:jobId","host":["{{BaseURL}}"],"path":["api","v1","Candidate","GetCandidateApplicationDetailByJobId",":candidateId",":jobId"],"variable":[{"key":"candidateId"},{"key":"jobId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b8ac736d-4cdf-4a94-9be2-7fce84309913","name":"Candidate Application Detail not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/v1/Candidate/GetCandidateApplicationDetailByJobId/:candidateId/:jobId","host":["{{BaseURL}}"],"path":["api","v1","Candidate","GetCandidateApplicationDetailByJobId",":candidateId",":jobId"],"variable":[{"key":"candidateId"},{"key":"jobId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"82f8ceb1-4262-45eb-a6e2-c17e6312766f"},{"name":"Retrieve Candidate Application by Id","id":"d7ab39d5-a6db-46af-a31e-6ed06a46417a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/JSON"}],"url":"{{BaseURL}}/api/v1/Candidate/GetCandidateApplicationById/:Id","description":"

Return a simplified amount of detail of a single candidate application, by passing the application ID

Request Body Description

Field	Type	Description
id	Integer	Candidate ID
firstName	String	Candidate's first name
lastName	String	Candidate's last name
email	String	Candidate's email address
mobile	Integer	Candidate's mobile phone number
address	Object	Contains the candidate's address information
addressLine1	String	1st line of the candidate's address
addressLine2	String	2nd line of the candidate's address
city	String	Candidate's city
county	String	Candidate's county
country	String	Candidate's country
countryISOCode	String	Country ISO Code (2 or 3 digit)
postcode	String	Candidate's postcode
candidateCreatedOn	Date/Time	Candidate created date
candidateAppliedOn	Date/Time	Candidate applied on date
candidateStatusID	Integer	ID of candidate status
candidateStatus	String	Candidate's application status
candidateStatusForCandidates	String	Candidate facing name of the candidate's application status
candidateStatusCreatedDate	Date	Date the candidate was moved to this status.
agreedToTerms	Integer	0 or 1, if the candidate has not, or has agreed to the terms and conditions to submit their application
candidateType	String	Which portal they applied through (Internal/External/Agency)
userAdded	String	Name of theuser who added the candidate (if applicable)
agencySupplier	String	Name of Agency who submitted the candidate (if applicable)
daysFromApplicationToStart	Integer	Number of days from application date to candidate start date
candidateStartDate	Date	Candidate's start date
CV	Object	Object containing the CV
fileName	String	Name of the file
contentType	String	The type of file
data	String	Base64 encoded string. Total file size should be less than 1MB
coverLetter	Object	Object containing the Cover Letter
fileName	String	Name of the file
contentType	String	The type of file
data	String	Base64 encoded string. Total file size should be less than 1MB
equalOps	Object	Object containing the candidate answers to the EqualOps questions
applicationID	Integer	Candidate Application ID
candidateID	Integer	Candidate ID
equalOpsEthnicity	String	Answer to the Equal Ops question
equalOpsSex	String	Answer to the Equal Ops question
equalOpsGender	String	Answer to the Equal Ops question
equalOpsMarital	String	Answer to the Equal Ops question
equalOpsNationality	String	Answer to the Equal Ops question
equalOpsReligion	String	Answer to the Equal Ops question
equalOpsOrientation	String	Answer to the Equal Ops question
equalOpsDisability	String	Candidate's answer to the 'Do you consider yourself to be disabled' standard question in the application form
equalOpsDisabilityDescription	String	Candidate's response to 'If yes, please give more details'
jobDetail	Object	Object containing details of the Job
applicationId	Integer	Candidate Application ID
candidateId	Integer	Candidate ID
jobId	Integer	Job ID
jobReference	String	Unique Job Reference, set by the ATS
jobTitle	String	Internal/Primary job title
jobTitleForCandidates	String	External/Candidate job title
isLiveForCandidates	Yes/No	Whether job is live for candidates
jobLocation	String	Location, set in the Job Details page
locationRegion	String	Job Location/Region
vacancyDepartment	String	Department, set in the Job Details page
vacancySchoolLocation	String	School Location, set in the Job Details page
vacancyDivision	String	Divison, set in the Job Details page
vacancyCampaign	String	Campaign, set in the Job Details page
vacancyCostCentre	String	Cost Centre, set in the Job Details page
jobEmploymentType	String	Employment Type, set in the Job Details page
jobHoursPerWeek	String	Hours per Week, set in the Job Details page
jobNumberVacancies	Integer	No. of Vacancies, set in the Job Details page
jobReportsTo	String	ReportsTo field, set in the Job Details page
userFirstName	String	Name of user who created the job
userLastName	String	Name of user who created the job
jobApprovedDate	Date/Time	Date/Time the job was approved
jobClosingDate	Date/Time	Date/Time the job advert closed
jobCreatedDate	Date/Time	Date/Time the job was created
jobLiveDate	Date/Time	Date/Time the job was moved to the Live status
jobStatusName	Object	Object containing the Job Status details
id	Integer	Job Status ID
name	String	Name of the Job Status

\",\n \"candidateAppliedOn\": \"

\",\n \"candidateStatusId\": \"\",\n \"candidateStatus\": \"\",\n \"candidateStatusForCandidates\": \"\",\n \"candidateStatusCreatedDate\": \"

\",\n \"agreedToTerms\": \"\",\n \"candidateType\": \"\",\n \"userAdded\": \"\",\n \"agencySupplier\": \"\",\n \"daysFromApplicationToStart\": \"\",\n \"candidateStartDate\": \"

\",\n \"jobClosingDate\": \"

\",\n \"jobCreatedDate\": \"

\",\n \"jobLiveDate\": \"

\",\n \"advertisedType\": \"\"\n },\n \"jobStatus\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n}"},{"id":"cedcaa5c-1a61-472b-89e7-04d3d3ec5502","name":"Invalid ID supplied","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/v1/Candidate/GetCandidateApplicationById/:Id","host":["{{BaseURL}}"],"path":["api","v1","Candidate","GetCandidateApplicationById",":Id"],"variable":[{"key":"Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"56d32cc3-ad19-4744-ad21-7d66960b8815","name":"Candidate not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/v1/Candidate/GetCandidateApplicationById/:Id","host":["{{BaseURL}}"],"path":["api","v1","Candidate","GetCandidateApplicationById",":Id"],"variable":[{"key":"Id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d7ab39d5-a6db-46af-a31e-6ed06a46417a"},{"name":"Get Recently Updated Candidate Application Details","id":"5580a89a-b9f6-4ed1-a8ec-805698a14d4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/JSON"}],"url":"{{BaseURL}}/api/v1/Candidate/GetRecentUpdatedApplications","description":"

Returns a list of candidates whose status has changed in the last 24 hours. Requires that the user who has authenticated for this call have ListAllJobs access rights.

Field	Type	Description
candidateApplicationId	Integer	ID of the specific application
candidateId	Integer	Candidate ID number
firstName	String	Candidate's first name
lastName	String	Candidate's last name
emailAddress	String	Candidate's email address
applicationStatusCreatedDate	Date/Time	Date & time the candidate was moved to this status
daysFromApplicationDateToStartDate	Integer	Number of days between the candidate's start date, and their application date.
jobDetail	Object	Contains information about the job
jobID	Integer	Unique ID for the job, created by the ATS
jobTitle	String	Internal/Primary job title
jobReference	String	Unique string to identify the job, created with the ATS
noOfVacancies	Integer	Number of vacancies specified in the JobDetails page in the ATS
startDate	Date/Time	Start date & time specified in the JobDetails page in the ATS
closingDate	Date/Time	Closing Date & time specified in the PostTheJob page in the ATS
hours	Integer	Number of hours specified in the JobDetails page in the ATS
employmentType	String	Type of employment specified in the JobDetails page in the ATS
divisionName	String	Division specified in the JobDetails page in the ATS
jobStatus	String	Status of the Job
Location	Object	Contains information about the job location
locationName	String	Name of the Location
fax	String	Fax field of the Location. Often repurposed.
applicationStatus	Object	Contains information about the status of the candidate's application
applicationId	Integer	ID of the application status
applicationStatus	String	Name of the application status
systemUser	Object	Contains details of the user who updated the candidate to this status
firstName	String	First name of the user
lastName	String	Last name of the user

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"e24e97df-030b-4498-b4bd-5405d429d80a","id":"e24e97df-030b-4498-b4bd-5405d429d80a","name":"Jobtrain - OpenAPI","type":"collection"}},"urlObject":{"path":["api","v1","Candidate","GetRecentUpdatedApplications"],"host":["{{BaseURL}}"],"query":[{"disabled":true,"key":"PageNo","value":""},{"disabled":true,"key":"TextToSearch","value":""},{"disabled":true,"key":"SortColumn","value":""},{"disabled":true,"key":"SortDirection","value":""},{"disabled":true,"key":"PageSize","value":""},{"disabled":true,"key":"ApplicationStatusId","value":""}],"variable":[]}},"response":[{"id":"0896da90-caa5-4138-914c-bd0b1ac7dd4e","name":"Successful Operation","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/JSON"}],"url":{"raw":"{{BaseURL}}/api/v1/Candidate/GetRecentlyUpdatedApplications","host":["{{BaseURL}}"],"path":["api","v1","Candidate","GetRecentlyUpdatedApplications"],"query":[{"key":"PageNo","value":"","disabled":true},{"key":"TextToSearch","value":"","disabled":true},{"key":"SortColumn","value":"","disabled":true},{"key":"SortDirection","value":"","disabled":true},{"key":"PageSize","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/JSON"}],"cookie":[],"responseTime":null,"body":"{\n \"candidateApplicationId\": \"\",\n \"candidateId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"emailAddress\": \"\",\n \"applicationStatusCreatedDate\": \"DD/MM/YYYY HH:MM:SS\",\n \"daysFromApplicationDateToStartDate\": \"\",\n \"jobDetail\": {\n \"jobId\": \"\",\n \"jobTitle\": \"\",\n \"jobReference\": \"\",\n \"noOfVacancies\": \"\",\n \"startDate\": \"DD/MM/YYYY HH:MM:SS\",\n \"closingDate\": \"DD/MM/YYYY HH:MM:SS\",\n \"hours\": \"\",\n \"employmentType\": \"\",\n \"divisionName\": \"\",\n \"jobStatus\": \"\",\n \"location\": {\n \"locationName\": \"\",\n \"fax\": \"\"\n }\n },\n \"applicationStatus\": {\n \"applicationStatusId\": \"\",\n \"applicationStatus\": \"\"\n },\n \"systemUser\": {\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n}"},{"id":"a84722be-792a-4bd3-8dc6-75e1c7f51f0f","name":"Invalid ID supplied","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/v1/Candidate/GetRecentlyUpdatedApplications?PageNo=&TextToSearch=&SortColumn=&SortDirection=&PageSize=","host":["{{BaseURL}}"],"path":["api","v1","Candidate","GetRecentlyUpdatedApplications"],"query":[{"key":"PageNo","value":""},{"key":"TextToSearch","value":""},{"key":"SortColumn","value":""},{"key":"SortDirection","value":""},{"key":"PageSize","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"96826e7d-8fd6-4a8b-846f-b51adafceb09","name":"Candidate not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/v1/Candidate/GetRecentlyUpdatedApplications?PageNo=&TextToSearch=&SortColumn=&SortDirection=&PageSize=","host":["{{BaseURL}}"],"path":["api","v1","Candidate","GetRecentlyUpdatedApplications"],"query":[{"key":"PageNo","value":""},{"key":"TextToSearch","value":""},{"key":"SortColumn","value":""},{"key":"SortDirection","value":""},{"key":"PageSize","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5580a89a-b9f6-4ed1-a8ec-805698a14d4b"},{"name":"Direct Apply Integrations","id":"9710ec90-cc7a-456d-b8a2-25863ad8ddf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/JSON"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"job\": {\n \"id\": \"\"\n },\n \"applicant\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"address\": {\n \"addressline1\": \"\",\n \"addressline2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"countryISOCode\": \"\",\n \"postcode\": \"\"\n },\n \"resume\": {\n \"filename\": \"\",,\n \"data\": \"\"\n },\n \"coverLetter\": {\n \"filename\": \"\",\n \"data\": \"\"\n }\n },\n \"utm_Source\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BaseURL}}/api/v1/Candidate/DirectApplyData","description":"

Post a Direct-Apply candidate into the system. This is for third parties who want to push a candidate into the system without redirecting the candidate to Jobtrain. Will always take the fields shown, but more can be accepted into the system by modifying the Direct Apply template within the client site.

Please note: Country must be the ISO recognised name and code for that country.

Field	Type	Description
id	String	Unique reference no of third party integrator
job	Object	Contains details of the Job the candidate is to be posted to
id	Integer	ID of the job within the ATS
applicant	Object	Contains the details of the candidate
firstName	String	Candidate's first name
lastName	String	Candidate's last name
email	String	Candidate's email address
mobile	String	Candidate's mobile number
address	Object	Contains the candidate's address
addressLine1	String	First line of the address
addressLine2	String	Second line of the address
city	String	City the candidate lives in
county	String	County the candidate lives in
country	String	Country the candidate lives in (must be recognised ISO country name)
countryISOCode	String	Two or three letter ISO code
postcode	String	Candidate's postcode
resume	Object	Contains the candidate's CV. Accepts .doc, .docx, .pdf, .xlsx, and .xls formats
filename	String	Name of the file
data	String	Base64 encoded string. Size of the file should be less then 1MB
coverLetter	Object	Contains the candidate's cover letter
filename	String	Name of the file
data	String	Base64 encoded string. Size of the file should be less then 1MB
utm_source	String	Source token to track applicants origin

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"e24e97df-030b-4498-b4bd-5405d429d80a","id":"e24e97df-030b-4498-b4bd-5405d429d80a","name":"Jobtrain - OpenAPI","type":"collection"}},"urlObject":{"path":["api","v1","Candidate","DirectApplyData"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"a18763e7-77b8-4b97-ae71-f3ee56fd61ac","name":"Successful Operation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"job\": {\n \"id\": \"\"\n },\n \"applicant\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"address\": {\n \"addressline1\": \"\",\n \"addressline2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"countryISOCode\": \"\",\n \"postcode\": \"\"\n },\n \"resume\": {\n \"filename\": \"\",\n \"data\": \"\"\n },\n \"coverLetter\": {\n \"filename\": \"\",\n \"data\": \"\"\n }\n },\n \"utm_Source\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BaseURL}}/api/v1/Candidate/DirectApplyData"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"message\": \"Successfully saved\",\r\n \"resultData\": {\r\n \"applicationId\": ,\r\n \"candidateId\": ,\r\n \"jobId\": \r\n }\r\n}"},{"id":"f663028d-47bd-4490-8d97-a69d872703e2","name":"Invalid ID supplied","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/JSON"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"job\": {\n \"id\": \"\"\n },\n \"applicant\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"address\": {\n \"addressline1\": \"\",\n \"addressline2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"postcode\": \"\"\n },\n \"resume\": {\n \"filename\": \"\",\n \"contentType\": \"\",\n \"data\": \"\"\n },\n \"coverLetter\": {\n \"filename\": \"\",\n \"contentType\": \"\",\n \"data\": \"\"\n }\n },\n \"utm_Source\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BaseURL}}/api/v1/Candidate/DirectApplyData"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"35b498e6-4724-4aac-af40-1e8ba0a8abf7","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/JSON"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"job\": {\n \"id\": \"\"\n },\n \"applicant\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"address\": {\n \"addressline1\": \"\",\n \"addressline2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"postcode\": \"\"\n },\n \"resume\": {\n \"filename\": \"\",\n \"contentType\": \"\",\n \"data\": \"\"\n },\n \"coverLetter\": {\n \"filename\": \"\",\n \"contentType\": \"\",\n \"data\": \"\"\n }\n },\n \"utm_Source\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BaseURL}}/api/v1/Candidate/DirectApplyData"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"04e479d1-44e9-477d-841f-f63fb45f49dd","name":"Candidate not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/JSON"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"job\": {\n \"id\": \"\"\n },\n \"applicant\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"address\": {\n \"addressline1\": \"\",\n \"addressline2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"postcode\": \"\"\n },\n \"resume\": {\n \"filename\": \"\",\n \"contentType\": \"\",\n \"data\": \"\"\n },\n \"coverLetter\": {\n \"filename\": \"\",\n \"contentType\": \"\",\n \"data\": \"\"\n }\n },\n \"utm_Source\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BaseURL}}/api/v1/Candidate/DirectApplyData"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9710ec90-cc7a-456d-b8a2-25863ad8ddf0"},{"name":"Direct Apply Integration V2","id":"f6eef404-b5f0-4236-be23-836f02e4a8ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/JSON"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"jobId\": \"\",\n \"source\": \"\",\n \"answers\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"questionAnswers\": [\n {\n \"id\": \"\",\n \"value\": \"\",\n \"values\": null\n },\n {\n \"id\": \"\",\n \"value\": null,\n \"values\": [\"\", \"\"]\n }\n ],\n \"CV\": {\n \"fileName\": \"\",\n \"contentType\": \"\",\n \"data\": \"\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BaseURL}}/api/v1/Candidate/DirectApplyData","description":"

Post a Direct-Apply candidate into the system. This is for third parties who want to push a candidate into the system without redirecting the candidate to Jobtrain. This version requires the candidate answer questions against the job, and therefore the third party must display these to the candidate.

As this is the enhanced variant, and the version type passed with this call needs to be 2, rather than current version 1 used for all other endpoints. This is how to pick between using this enhanced version, and the base Direct Apply endpoint.

To use this endpoint, you must first get the DirectApplyQuestions URL from the job the candidate is applying for. This will contain the required fields for the job, as well as indicating whether a CV is required or not.

Each question consists of the following characteristics:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
id	String	Unique identifier for the question. EQ means it comes from Equal Ops, STND from the default standard questions at the start of the application form, AF from the Application Form, PRE from the Pre-Assessment Form
type	String	Question type. Can be a text question, select, or multiselect. Use this field to determine how to display the question to the candidate in the third party system.
question	String	Question text
required	Boolean	Yes/No
format	String	Defaults to null, unless otherwise specified
options	Array	For select and multiselect, it returns an array of options available for the candidate to select. This consists of a value and label pair. Value is the identifier that must be returned with the POST, label is the candidate friendly name.

Once the candidate responses have been gathered, the details should be consolidated and POSTed to the endpoint using the below structure:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
id	String	Unique reference no of third party integrator
job	Object	Contains details of the Job the candidate is to be posted to
id	Integer	ID of the job within the ATS
answers	Object	Contains the application details
firstName	String	Candidate's first name
lastName	String	Candidate's last name
email	String	Candidate's email address
mobile	Integer	Candidate's mobile number
questionAnswers	Object	Contains the answers to the required questions
id	String	Unique identifier of the question
value	String	For select questions, the single ID of the chosen option should go here. Otherwise should be null
values	String	For multiselect questions, an array of the chosen options should go here. Otherwise should be null
CV	Object	Contains the candidate's CV. Accepts .doc, .docx, .pdf, .xlsx, and .xls formats
filename	String	Name of the file
contentType	String	MIMEtype of the file
data	String	Base64 encoded string. Size of the file should be less then 1MB

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"e24e97df-030b-4498-b4bd-5405d429d80a","id":"e24e97df-030b-4498-b4bd-5405d429d80a","name":"Jobtrain - OpenAPI","type":"collection"}},"urlObject":{"path":["api","v1","Candidate","DirectApplyData"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"bfe1a98c-0388-4c7f-a689-cdced4fb810e","name":"Successful Operation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"job\": {\n \"id\": \"\"\n },\n \"applicant\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"address\": {\n \"addressline1\": \"\",\n \"addressline2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"countryISOCode\": \"\",\n \"postcode\": \"\"\n },\n \"resume\": {\n \"filename\": \"\",\n \"data\": \"\"\n },\n \"coverLetter\": {\n \"filename\": \"\",\n \"data\": \"\"\n }\n },\n \"utm_Source\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BaseURL}}/api/v1/Candidate/DirectApplyData"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"message\": \"Successfully saved\",\r\n \"resultData\": {\r\n \"applicationId\": ,\r\n \"candidateId\": ,\r\n \"jobId\": \r\n }\r\n}"},{"id":"4c35183b-d1d8-4b3f-9475-8fc1d4ce8abe","name":"Invalid ID supplied","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/JSON"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"job\": {\n \"id\": \"\"\n },\n \"applicant\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"address\": {\n \"addressline1\": \"\",\n \"addressline2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"postcode\": \"\"\n },\n \"resume\": {\n \"filename\": \"\",\n \"contentType\": \"\",\n \"data\": \"\"\n },\n \"coverLetter\": {\n \"filename\": \"\",\n \"contentType\": \"\",\n \"data\": \"\"\n }\n },\n \"utm_Source\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BaseURL}}/api/v1/Candidate/DirectApplyData"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"fc221db5-fcc9-4136-95c9-cb646a819fe7","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/JSON"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"job\": {\n \"id\": \"\"\n },\n \"applicant\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"address\": {\n \"addressline1\": \"\",\n \"addressline2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"postcode\": \"\"\n },\n \"resume\": {\n \"filename\": \"\",\n \"contentType\": \"\",\n \"data\": \"\"\n },\n \"coverLetter\": {\n \"filename\": \"\",\n \"contentType\": \"\",\n \"data\": \"\"\n }\n },\n \"utm_Source\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BaseURL}}/api/v1/Candidate/DirectApplyData"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c3612dfe-890d-420c-8a80-b4b908863aad","name":"Candidate not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/JSON"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"job\": {\n \"id\": \"\"\n },\n \"applicant\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"address\": {\n \"addressline1\": \"\",\n \"addressline2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"postcode\": \"\"\n },\n \"resume\": {\n \"filename\": \"\",\n \"contentType\": \"\",\n \"data\": \"\"\n },\n \"coverLetter\": {\n \"filename\": \"\",\n \"contentType\": \"\",\n \"data\": \"\"\n }\n },\n \"utm_Source\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BaseURL}}/api/v1/Candidate/DirectApplyData"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f6eef404-b5f0-4236-be23-836f02e4a8ea"}],"id":"b8e62861-ce50-41b8-ae42-cba28eb8afbc","description":"

These are the API calls to retrieve candidate data. In these calls, we make a distinction between the candidate (the core information for that candidate's account) and their applications (with job-specific information).

Date/Time format is as follows: DD/MM/YYYY HH:MM:SS

Date format is as follows: DD/MM/YYYY

\n","_postman_id":"b8e62861-ce50-41b8-ae42-cba28eb8afbc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"e24e97df-030b-4498-b4bd-5405d429d80a","id":"e24e97df-030b-4498-b4bd-5405d429d80a","name":"Jobtrain - OpenAPI","type":"collection"}}},{"name":"StarterForm","item":[{"name":"Get New Starter Form Details","id":"f2480e86-5ad8-4e8e-8ee1-9f9da4ed7599","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/JSON"}],"url":"{{BaseURL}}/api/v1/StarterForm/GetNewStarterFormDetail?candidateApplicationID=","description":"

This returns the Starter Form details of a specific application.

Field	Type	Description
candidateApplicationId	Integer	Candidate application ID
candidateId	Integer	Candidate ID
starterDataCreatedDate	Date/Time	Date the Starter Form was saved
lastModifiedOn	Date/Time	Date/Time the Starter Form was last saved
jobDetail	Object	Contains the job information
jobId	Integer	ID of the job
jobTitle	String	Internal/main job title
jobTitleForCandidates	String	External/candidate job title
vacancyDivision	String	Job Division
jobReference	String	Job Reference generated by the ATS
vacancyDepartment	String	Job Department
vacancySchoolLocation	String	Job School Location
vacancyCostCentre	String	Job Cost Centre
vacancyCampaign	String	Job Campaign
vacancyJobLevel	String	Job Level
reportsTo	String	Individual identified in Job Details
serviceManagerEmail	String	Individual identified in the New Starter Form
applicationStatus	Object	Contains data about the application status
applicationStatusId	Integer	ID number of the Application Status
applicationStatus	String	Application Status
systemUser	Object	Contains data about the system user who last saved the form
firstName	String	User's first name
lastName	String	User's last name
application	Object	Contains data about the application
title	String	Candidate title
firstName	String	Candidate's first name
lastName	String	Candidate's last name
addressLine1	String	1st line of the address
addressLine2	String	2nd line of the address
city	String	Candidate's city
county	String	Candidate's county
countryISOCode	String	2/3 digit ISO Code of the candidate's country
country	String	Candidate country
postCode	String	Candidate's postcode
emailAddress	String	Candidate's email address
mobile	Integer	Candidate's mobile number
gender	String	Candidate's gender
maritalStatus	String	Candidate's marital status
nationality	String	Candidate's nationality
Date of Birth	String	DD/MM/YYYY
bankDetail	Object	Contains the bank details form information
gender	String	Candidate's gender
bankName	String	Name of the bank
branch	String	Name of the branch
accountNumber	Integer	Candidate bank account number
sortCode	Integer	Candidate bank account sort code, no hyphens.
payeeName	String	Payee name
buildingSocietyRollNumber	Integer	Roll number of building society
nationalInsuranceNumber	String	Candidate's national insurance number
birthDate	Date	Candidate's birth date.
data	Object	Contains the fields from the starter form
id	Integer	ID of the field in the starter form
name	String	Name of the field in the starter form
caption	String	Caption that shows agains thefield in the starter form
value	String	Data entered into the field, in the starter form

This returns the candidates who have recently had their new starter form completed or updated, within the last day.

Field	Type	Description
candidateApplicationId	Integer	Candidate application ID
candidateId	Integer	Candidate ID
starterDataCreatedDate	Date/Time	Date the Starter Form was saved
lastModifiedOn	Date/Time	Date/Time the Starter Form was last saved
jobDetail	Object	Contains the job information
jobId	Integer	ID of the job
jobTitle	String	Internal/main job title
jobTitleForCandidates	String	External/candidate job title
vacancyDivision	String	Job Division
jobReference	String	Job Reference generated by the ATS
vacancyDepartment	String	Job Department
vacancySchoolLocation	String	Job School Location
vacancyCostCentre	String	Job Cost Centre
vacancyCampaign	String	Job Campaign
vacancyJobLevel	String	Job Level
reportsTo	String	Individual identified in Job Details
serviceManagerEmail	String	Individual identified in the New Starter Form
applicationStatus	Object	Contains data about the application status
applicationStatusId	Integer	ID number of the Application Status
applicationStatus	String	Application Status
systemUser	Object	Contains data about the system user who last saved the form
firstName	String	User's first name
lastName	String	User's last name
application	Object	Contains data about the application
title	String	Candidate title
firstName	String	Candidate's first name
lastName	String	Candidate's last name
addressLine1	String	1st line of the address
addressLine2	String	2nd line of the address
city	String	Candidate's city
county	String	Candidate's county
countryISOCode	String	2/3 digit ISO Code of the candidate's country
country	String	Candidate country
postCode	String	Candidate's postcode
emailAddress	String	Candidate's email address
mobile	Integer	Candidate's mobile number
gender	String	Candidate's gender
maritalStatus	String	Candidate's marital status
nationality	String	Candidate's nationality
Date of Birth	String	DD/MM/YYYY
bankDetail	Object	Contains the bank details form information
gender	String	Candidate's gender
bankName	String	Name of the bank
branch	String	Name of the branch
accountNumber	Integer	Candidate bank account number
sortCode	Integer	Candidate bank account sort code, no hyphens.
payeeName	String	Payee name
buildingSocietyRollNumber	Integer	Roll number of building society
nationalInsuranceNumber	String	Candidate's national insurance number
birthDate	Date	Candidate's birth date.
data	Object	Contains the fields from the starter form
id	Integer	ID of the field in the starter form
name	String	Name of the field in the starter form
caption	String	Caption that shows agains thefield in the starter form
value	String	Data entered into the field, in the starter form

\",\n \"lastModifiedOn\": \"

\",\n \"jobDetail\": {\n \"jobId\": \"\",\n \"jobTitle\": \"\",\n \"jobTitleforCandidates\": \"\",\n \"jobReference\": \"\"\n },\n \"applicationStatus\": {\n \"applicationStatusId\": \"\",\n \"applicationStatus\": \"\"\n },\n \"systemUser\": {\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"newStarterData\": {\n \"field\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"caption\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"caption\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}"}],"_postman_id":"19fb52f3-2f47-4b2d-a0d3-44d7a5c331ab"}],"id":"dbe9590f-58ab-4ab1-80ae-8010f7b02d72","_postman_id":"dbe9590f-58ab-4ab1-80ae-8010f7b02d72","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"e24e97df-030b-4498-b4bd-5405d429d80a","id":"e24e97df-030b-4498-b4bd-5405d429d80a","name":"Jobtrain - OpenAPI","type":"collection"}}},{"name":"Onboarding","item":[{"name":"GetOnboardingProgress","id":"3986bf71-06fd-44f1-98c8-b8a03730e5f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/JSON"}],"url":"{{BaseURL}}/api/v1/OnBoarding/GetOnboardingProgress?candidateApplicationId=","description":"

This returns the current status of the candidate's Onboarding, Compliance, and References as a % complete, as well as the status of each item in those three categories.

Field	Type	Description
candidateApplicationId	Integer	Candidate application ID
candidateId	Integer	Candidate ID
firstName	String	Candidate's first name
lastName	String	Candidate's last name
mobile	Integer	Candidate's mobile number
email	String	Candidate's email
jobDetail	Object	Contrains the job information
jobID	Integer	ID of the job
jobTitle	String	Internal/main job title
jobTitleForCandidates	String	External/candidate job title
jobReference	String	Job Reference generated by the ATS
applicationStatus	Object	Contains application status information
applicationStatusID	Integer	ID of the application status
applicationStatus	String	Name of application status
systemUser	Object	Contains information about the system user hwo moved them to this status
firstName	String	User's first name
lastName	String	User's last name
newStarter	Object	Contains data about the application status
applicationStatusId	Integer	ID number of the Application Status
applicationStatus	String	Application Status
systemUser	Object	Contains data about the system user who last saved the form
firstName	String	User's first name
lastName	String	User's last name
onboardingProgress	Object	Contains data about the progress of the candidate's onboarding.
onboarding	Object	Contrains onboarding detail
onboardingStartedDate	Date/Time	Date/Time onboarding was started
onboardingSubStatus	String	Onboarding Status name
onboardingPercentageComplete	Integer	Percentage completion of onboarding items
onboardingAdmin	Object	Contains details about the onboarding admin
firstName	String	Admin's first name
lastName	String	Admin's last name
onboardingItems	Object	Array containing details of items within Onboarding
itemType	String	Document/Form/Contract etc
itemID	Integer	ID of item
itemName	String	Name of item
dateCompleted	Date/Time	Date/Time item was completed/saved
dateVerified	Date/Time	Date/Time item was marked as complete
verifiedBy	String	Name of user who marked the item complete
complianceProgress	Object	Contains Compiance information
compliance	Object	Details about Compliance
complianceStartedDate	Date/Time	Date/Time compliance was started
complianePercentageComplete	Integer	Percentage completion of compliance items
complianceAdmin	Object	Details of the Compliance Admin
firstName	String	Admin's first name
lastName	String	Admin's last name
complianceItems	Object	Array containing details of items within Compliance
itemType	String	Document/Contract/Form etc
itemID	Integer	ID of the item
itemName	String	Name of the item
dateCompleted	Date/Time	Date/Time item was completed/saved
dateVerified	Date/Time	Date/Time item was marked complete
verifiedBy	String	Name of user who marked the item as complete.
referenceProgress	Object	Contains information about References
referencePercentageComplete	Integer	Percentage completion of references
references	Object	Contains details about references
refereeName	String	Name of referee
refereeEmail	String	Email address of referee
refereePosition	String	Referee's position/role
employerName	String	Name of employer
dateRefStarted	Date/Time	Date/Time reference was started
dateRefCompleted	Date/Time	Date/Time reference was completed
refFormID	Integer	ID of the reference form used

\",\n \"onboardingSubStatus\": \"\",\n \"onboardingPercentageComplete\": \"\"\n },\n \"onboardingAdmin\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n ],\n \"onboardingItems\": [\n {\n \"itemType\": \"\",\n \"itemId\": \"\",\n \"itemName\": \"\",\n \"dateCompleted\": \"

\",\n \"dateVerified\": \"

\",\n \"verifiedBy\": \"\"\n },\n {\n \"itemType\": \"\",\n \"itemId\": \"\",\n \"itemName\": \"\",\n \"dateCompleted\": \"

\",\n \"dateVerified\": \"

\",\n \"verifiedBy\": \"\"\n }\n ]\n },\n \"complianceProgress\": {\n \"compliance\": {\n \"complianceStartedDate\": \"

\",\n \"compliancePercentageComplete\": \"\"\n },\n \"complianceAdmin\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n ],\n \"complianceItems\": [\n {\n \"itemType\": \"\",\n \"itemId\": \"\",\n \"itemName\": \"\",\n \"dateCompleted\": \"

\",\n \"dateVerified\": \"

\",\n \"verifiedBy\": \"\"\n },\n {\n \"itemType\": \"\",\n \"itemId\": \"\",\n \"itemName\": \"\",\n \"dateCompleted\": \"

\",\n \"dateVerified\": \"

\",\n \"verifiedBy\": \"\"\n }\n ]\n },\n \"referenceProgress\": {\n \"referencesPercentageComplete\": \"\",\n \"references\": [\n {\n \"refereeName\": \"\",\n \"refereeEmail\": \"\",\n \"refereePosition\": \"\",\n \"employerName\": \"\",\n \"dateRefStarted\": \"

\",\n \"dateRefCompleted\": \"

\",\n \"refFormId\": \"\"\n },\n {\n {\n \"refereeName\": \"\",\n \"refereeEmail\": \"\",\n \"refereePosition\": \"\",\n \"employerName\": \"\",\n \"dateRefStarted\": \"

\",\n \"dateRefCompleted\": \"

\",\n \"refFormId\": \"\"\n },\n ]\n }\n }"}],"_postman_id":"3986bf71-06fd-44f1-98c8-b8a03730e5f4"},{"name":"GetOnboardingForms","id":"82938061-2cf6-49f4-9afa-bff5c55565f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/JSON"}],"url":"{{BaseURL}}/api/v1/Onboarding/GetOnboardingForms?CandidateApplicationId=","description":"

This returns the information about the status of each Form within Onboarding.

Field	Type	Description
candidateApplicationId	Integer	Candidate application ID
candidateId	Integer	Candidate ID
jobDetail	Object	Contrains the job information
jobID	Integer	ID of the job
jobTitle	String	Internal/main job title
jobTitleForCandidates	String	External/candidate job title
jobReference	String	Job Reference generated by the ATS
applicationStatus	Object	Contains application status information
applicationStatusID	Integer	ID of the application status
applicationStatus	String	Name of application status
items	Object	An array of each form, it's details, the fields, and candidate's answers
itemName	String	Name of the Form
itemID	Integer	Form ID
fields	Object	Contains the questions and answers of the form
questionID	Integer	ID of the question
questionText	String	Question Text
answer	String	Response to the question
questionType	String	Multiple choice, text etc
mandatory	String	Yes/No whether the question was mandatory
signature	Object	Contains details about the signature, if applicable
signatureType	String	Text, or esignature
signature	Varies	If a text signature, then shows the text, if drawn, then shows the image encoded as Base64
agreedOn	Date/Time	When the form was answered
dateCompleted	Date/Time	Date/Time the form was completed
verifiedBy	String	Name of user who marked it complete
dateVerified	Date/Time	Date/Time it was marked as complete

\"\n },\n \"dateCompleted\": \"

\",\n \"verifiedBy\": \"\",\n \"dateVerified\": \"

\"\n }\n ]\n}"}],"_postman_id":"82938061-2cf6-49f4-9afa-bff5c55565f1"},{"name":"GetOnboardingDocuments","id":"24215bb8-d7a8-4752-8570-c4e74ceda95b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/JSON"}],"url":"{{BaseURL}}/api/v1/Onboarding/GetOnboardingDocuments?CandidateApplicationId=","description":"

This returns the information about the status of each Document within Onboarding, as well as the document itself.

Field	Type	Description
candidateApplicationId	Integer	Candidate application ID
candidateId	Integer	Candidate ID
jobDetail	Object	Contrains the job information
jobID	Integer	ID of the job
jobTitle	String	Internal/main job title
jobTitleForCandidates	String	External/candidate job title
jobReference	String	Job Reference generated by the ATS
applicationStatus	Object	Contains application status information
applicationStatusID	Integer	ID of the application status
applicationStatus	String	Name of application status
documentItems	Object	An array of each document and it's details
itemName	String	Name of the Document
itemID	Integer	Document ID
contentType	String	MIME type of document
itemData	String	Base64 encoded data of the document
dateCompleted	Date/Time	Date/Time the document was completed
verifiedBy	String	Name of user who marked it complete
dateVerified	Date/Time	Date/Time the document was marked as complete
signatures	Object	Contains details about the signature, if applicable
signatureType	String	Text, or esignature
signature	Varies	If a text signature, then shows the text, if esignature, then shows the image encoded as Base64
agreedOn	Date/Time	When the document was signed

\",\n \"verifiedBy\": \"\",\n \"dateVerified\": \"

\",\n \"signatures\": {\n \"signatureType\": \"\",\n \"signature\": \"\",\n \"agreedOn\": \"

\"\n }\n }\n ]\n}"}],"_postman_id":"24215bb8-d7a8-4752-8570-c4e74ceda95b"},{"name":"GetOnboardingContracts","id":"ab197a0d-76df-40f6-916b-f427d01d0470","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/JSON"}],"url":"{{BaseURL}}/api/v1/Onboarding/GetOnboardingContracts?CandidateApplicationId=","description":"

This returns the information about the status of each Contract within Onboarding, and the contract itself.

Field	Type	Description
candidateApplicationId	Integer	Candidate application ID
candidateId	Integer	Candidate ID
jobDetail	Object	Contrains the job information
jobID	Integer	ID of the job
jobTitle	String	Internal/main job title
jobTitleForCandidates	String	External/candidate job title
jobReference	String	Job Reference generated by the ATS
applicationStatus	Object	Contains application status information
applicationStatusID	Integer	ID of the application status
applicationStatus	String	Name of application status
contractItems	Object	An array of each contract and it's details
itemName	String	Name of the Contract
itemID	Integer	Contract ID
contentType	String	MIME type of contract
itemData	String	Base64 encoded data of the contract
dateCompleted	Date/Time	Date/Time the contract was completed
verifiedBy	String	Name of user who marked it complete
dateVerified	Date/Time	Date/Time the contract was marked as complete
signatures	Object	Contains details about the signature, if applicable
signatureType	String	Text, or esignature
signature	Varies	If a text signature, then shows the text, if esignature, then shows the image encoded as Base64
agreedOn	Date/Time	When the contract was signed

\",\n \"verifiedBy\": \"\",\n \"dateVerified\": \"

\",\n \"signatures\": {\n \"signatureType\": \"\",\n \"signature\": \"\",\n \"agreedOn\": \"

\"\n }\n }\n ]\n}"}],"_postman_id":"ab197a0d-76df-40f6-916b-f427d01d0470"},{"name":"GetComplianceForms","id":"2888afb6-268b-4ae5-9824-9905eb797b12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/JSON"}],"url":"{{BaseURL}}/api/v1/Onboarding/GetComplianceForms?CandidateApplicationId=","description":"

This returns the information about the status of each Form within Compliance.

Field	Type	Description
candidateApplicationId	Integer	Candidate application ID
candidateId	Integer	Candidate ID
jobDetail	Object	Contrains the job information
jobID	Integer	ID of the job
jobTitle	String	Internal/main job title
jobTitleForCandidates	String	External/candidate job title
jobReference	String	Job Reference generated by the ATS
applicationStatus	Object	Contains application status information
applicationStatusID	Integer	ID of the application status
applicationStatus	String	Name of application status
items	Object	An array of each form, it's details, the fields, and candidate's answers
itemName	String	Name of the Form
itemID	Integer	Form ID
fields	Object	Contains the questions and answers of the form
questionID	Integer	ID of the question
questionText	String	Question Text
answer	String	Response to the question
questionType	String	Multiple choice, text etc
mandatory	String	Yes/No whether the question was mandatory
signature	Object	Contains details about the signature, if applicable
signatureType	String	Text, or esignature
signature	Varies	If a text signature, then shows the text, if drawn, then shows the image encoded as Base64
agreedOn	Date/Time	When the form was answered
dateCompleted	Date/Time	Date/Time the form was completed
verifiedBy	String	Name of user who marked it complete
dateVerified	Date/Time	Date/Time it was marked as complete

This returns the information about the status of each Document within Compliance, as well as the document itself.

Field	Type	Description
candidateApplicationId	Integer	Candidate application ID
candidateId	Integer	Candidate ID
jobDetail	Object	Contrains the job information
jobID	Integer	ID of the job
jobTitle	String	Internal/main job title
jobTitleForCandidates	String	External/candidate job title
jobReference	String	Job Reference generated by the ATS
applicationStatus	Object	Contains application status information
applicationStatusID	Integer	ID of the application status
applicationStatus	String	Name of application status
documentItems	Object	An array of each document and it's details
itemName	String	Name of the Document
itemID	Integer	Document ID
contentType	String	MIME type of document
itemData	String	Base64 encoded data of the document
dateCompleted	Date/Time	Date/Time the document was completed
verifiedBy	String	Name of user who marked it complete
dateVerified	Date/Time	Date/Time the document was marked as complete
signatures	Object	Contains details about the signature, if applicable
signatureType	String	Text, or esignature
signature	Varies	If a text signature, then shows the text, if esignature, then shows the image encoded as Base64
agreedOn	Date/Time	When the document was signed

This returns the information about the status of each Contract within Compliance, and the contract itself.

Field	Type	Description
candidateApplicationId	Integer	Candidate application ID
candidateId	Integer	Candidate ID
jobDetail	Object	Contrains the job information
jobID	Integer	ID of the job
jobTitle	String	Internal/main job title
jobTitleForCandidates	String	External/candidate job title
jobReference	String	Job Reference generated by the ATS
applicationStatus	Object	Contains application status information
applicationStatusID	Integer	ID of the application status
applicationStatus	String	Name of application status
contractItems	Object	An array of each contract and it's details
itemName	String	Name of the Contract
itemID	Integer	Contract ID
contentType	String	MIME type of contract
itemData	String	Base64 encoded data of the contract
dateCompleted	Date/Time	Date/Time the contract was completed
verifiedBy	String	Name of user who marked it complete
dateVerified	Date/Time	Date/Time the contract was marked as complete
signatures	Object	Contains details about the signature, if applicable
signatureType	String	Text, or esignature
signature	Varies	If a text signature, then shows the text, if esignature, then shows the image encoded as Base64
agreedOn	Date/Time	When the contract was signed

This returns the reference forms started against this application.

Field	Type	Description
candidateApplicationId	Integer	Candidate application ID
candidateId	Integer	Candidate ID
jobDetail	Object	Contrains the job information
jobID	Integer	ID of the job
jobTitle	String	Internal/main job title
jobTitleForCandidates	String	External/candidate job title
jobReference	String	Job Reference generated by the ATS
applicationStatus	Object	Contains application status information
applicationStatusID	Integer	ID of the application status
applicationStatus	String	Name of application status
referenceDetails	Object	An array of each reference and it's details

refereeName	String	Name of the referee
refereeEmail	String	Referee's email address
refereePosition	String	Referee's position/job
employerName	String	Name of the employer
dateRefStarted	Date/Time	Date/Time the reference was started
dateRefCompleted	Date/Time	Date/Time the reference was completed
signatures	Object	Contains details about the signature, if applicable
signatureType	String	Text, or esignature
signature	Varies	If a text signature, then shows the text, if esignature, then shows the image encoded as Base64
agreedOn	Date/Time	When the contract was signed

\",\n \"dateRefCompleted\": \"

\",\n \"refFormId\": \"\",\n \"fields\": [\n {\n \"questionId\": \"\",\n \"questionText\": \"\",\n \"answer\": \"\",\n \"questionType\": \"\",\n \"mandatory\": \"\"\n },\n {\n \"questionId\": \"\",\n \"questionText\": \"\",\n \"answer\": \"\",\n \"questionType\": \"\",\n \"mandatory\": \"\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"2da73bd4-0aaa-4640-adfb-64a635b713de"},{"name":"GetReferenceDocuments","id":"96855464-0cce-4bce-a904-72815863f965","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/JSON"}],"url":"{{BaseURL}}/api/v1/Onboarding/GetReferenceDocument?CandidateApplicationId=","description":"

This returns the candidates who have recently had their new starter form completed or updated, within the last day.

Field	Type	Description
candidateApplicationId	Integer	Candidate application ID
candidateId	Integer	Candidate ID
starterDataCreatedDate	Date/Time	Date the Starter Form was saved
lastModifiedOn	Date/Time	Date/Time the Starter Form was last saved
jobDetail	Object	Contains the job information
jobId	Integer	ID of the job
jobTitle	String	Internal/main job title
jobTitleForCandidates	String	External/candidate job title
vacancyDivision	String	Job Division
jobReference	String	Job Reference generated by the ATS
vacancyDepartment	String	Job Department
vacancySchoolLocation	String	Job School Location
vacancyCostCentre	String	Job Cost Centre
vacancyCampaign	String	Job Campaign
vacancyJobLevel	String	Job Level
reportsTo	String	Individual identified in Job Details
serviceManagerEmail	String	Individual identified in the New Starter Form
applicationStatus	Object	Contains data about the application status
applicationStatusId	Integer	ID number of the Application Status
applicationStatus	String	Application Status
systemUser	Object	Contains data about the system user who last saved the form
firstName	String	User's first name
lastName	String	User's last name
application	Object	Contains data about the application
title	String	Candidate title
firstName	String	Candidate's first name
lastName	String	Candidate's last name
addressLine1	String	1st line of the address
addressLine2	String	2nd line of the address
city	String	Candidate's city
county	String	Candidate's county
countryISOCode	String	2/3 digit ISO Code of the candidate's country
country	String	Candidate country
postCode	String	Candidate's postcode
emailAddress	String	Candidate's email address
mobile	Integer	Candidate's mobile number
gender	String	Candidate's gender
maritalStatus	String	Candidate's marital status
nationality	String	Candidate's nationality
Date of Birth	String	DD/MM/YYYY
bankDetail	Object	Contains the bank details form information
gender	String	Candidate's gender
bankName	String	Name of the bank
branch	String	Name of the branch
accountNumber	Integer	Candidate bank account number
sortCode	Integer	Candidate bank account sort code, no hyphens.
payeeName	String	Payee name
buildingSocietyRollNumber	Integer	Roll number of building society
nationalInsuranceNumber	String	Candidate's national insurance number
birthDate	Date	Candidate's birth date.
data	Object	Contains the fields from the starter form
id	Integer	ID of the field in the starter form
name	String	Name of the field in the starter form
caption	String	Caption that shows agains thefield in the starter form
value	String	Data entered into the field, in the starter form

\",\n \"dateRefCompleted\": \"

These API calls have been developed to assist with retrieving Onboarding/Compliance/Reference information.

Date/Time format is as follows: DD/MM/YYYY HH:MM:SS

Date format is as follows: DD/MM/YYYY

\n","_postman_id":"386bf328-18bc-4a66-b74e-cd973c64bda7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"e24e97df-030b-4498-b4bd-5405d429d80a","id":"e24e97df-030b-4498-b4bd-5405d429d80a","name":"Jobtrain - OpenAPI","type":"collection"}}},{"name":"Jobs","item":[{"name":"Retrieve a list of jobs","id":"14ea7d4f-10d9-4119-99b4-25844a2901e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseURL}}/api/v1/Job","description":"

Returns a list of jobs, that the authenticated user can see. For a list of all jobs, ensure that the user has ListAllJobs access rights within Jobtrain.

Field	Type	Description
id	String	JobID from the ATS
jobReference	String	Unique reference for the Job within the ATS
jobTitle	String	Internal/Primary job title
jobTitleForCandidate	String	External/candidate facing job title
advertisedType	String	Which portals the job is advertised on
replyToEmail	String	Email set in the JobDetails page in the ATS
vacancyType	String	Type of Vacancy
vacancyDepartment	String	Department of the job
vacancyDivision	String	Division of the job
applyURL	String	URL where the candidates would apply
directApplyQuestionsURL	String	URL containing JSON of the questions needed for Direct Apply. See Direct Apply V2 for more details.
vacancyReason	String	Reason for vacancy
isLiveForCandidates	String	Whether or not the job is currently live for candidates
location	Object	Contains location detail
id	Integer	ID of the location
locationName	String	Name of the location
city	String	Location city
county	String	Location county
postCode	String	Location postcode
jobStatus	Object	Contains information about the job status
id	Integer	ID of the job status
name	String	Status name
createdOnDate	String	Date the job was created on
startDate	String	Start date set in JobDetails page in the ATS
closingDate	String	Closing date of the job advert
advertLiveDate	String	Date the advert goes live for candidates

Return a list of applications for the specified job.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
applicationId	Integer	ID of the application
candidateId	Integer	ID of the candidate
jobId	integer	ID of the Job
createdOnDate	Date/Time	Date & Time the candidate started the application
agreedToTerms	String	Whether the candidate has agreed to the terms and conditions (will be Yes/No)
applicationSubmittedOn	Date/Time	Date & Time the candidate submitted the application.
source	String	How the candidate found the job
applicationStatus	Object	Contains details of the application status
id	Integer	ID of the application status
statusName	String	Name of the status
statusNameForCandidates	String	Status name visible in the candidate portal
ranking	Integer	Star ranking number for the candidate

Returns the details for a particular job. Includes advert copies for different portals.

Field	Type	Description
jobDescriptionExternal	String	Copy of the job advert on the external portal
jobDescriptionInternal	String	Copy of the job advert on the internal portal
jobDescriptionAgency	String	Copy of the job advert on the agency portal
createdOnDate	Date/Time	Date & Time the candidate started the application
startDate	Date/Time	Start Date specified in the JobDetails page in the ATS
closingDate	Date/Time	When the job closes for applications
reasonForVacancy	Object	Contains reason for vacancy details
id	Integer	Vacancy Reason ID
name	String	Vacancy Reason
id	Integer	Job ID
jobReference	String	Unique Job Reference within the ATS
jobTitle	String	Internal/Primary Job title
jobTitleForCandidates	String	External/Candidate facing job title
advertisedType	String	Portals where the job is being advertised
replyToEmail	String	Email set in JobDetails
vacancyType	String	Type of vacancy
vacancyDepartment	String	Department of the job
vacancyDivision	String	Division of the job
applyURL	String	URL where candidates would apply
directApplyQuestionsURL	String	URL containing JSON of the questions needed for Direct Apply. See Direct Apply V2 for more details.
vacancyReason	String	Reason for vacancy
isLiveForCandidates	String	Whether the job is currently advertised on one of the portals
location	Object	Contains information about the location of the job
id	Integer	Location ID
locationName	String	Name of location
city	String	Which city the location is in
county	String	Which county the location is in
postCode	String	Location's postcode
jobStatus	Object	Contains information about the job status
id	Integer	Job Status ID
name	String	Name of the Job Status

These are the calls relating to Job information. Retrieving a list of jobs, retrieving candidates who have applied to a job, as well as details of a job by Job ID

Date/Time format is as follows: DD/MM/YYYY HH:MM:SS

Date format is as follows: DD/MM/YYYY

Parameters:

TextToSearch will search Job Reference, and Job Title.

sortDirection accepts Ascending or Descending

\n","_postman_id":"f51dd678-8928-4bc7-af8c-be0c7f0ae027","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"e24e97df-030b-4498-b4bd-5405d429d80a","id":"e24e97df-030b-4498-b4bd-5405d429d80a","name":"Jobtrain - OpenAPI","type":"collection"}}},{"name":"DBS","item":[{"name":"Retrive list of candidates that have applied for this job and ready for DBS checks by ID","id":"685c508b-bc2f-468f-b0fb-9f2c04a4175a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/JSON"}],"url":"{{BaseURL}}/api/v1/Job/GetDBSReadyCandidateByJobId?JobId=","description":"

Return a list of applications ready for DBS check. DBS provider will use this end point to retrieve the list to facilitate registering candidates on their platform.

Field	Type	Description
applicationId	Integer	ID of the Application
candidateId	Integer	ID of the candidate
jobID	Integer	ID of the Job
createdOnDate	Date/Time	Date & Time the candidate started the application
agreedToTerms	String	Whether the candidate has agreed to the terms & conditions
applicationSubmittedOn	Date/Time	When the candidate submitted the application
source	String	How the candidate found the job
applicationStatus	Object	Contains information about the candidate's application status
id	Integer	ID of the application
statusName	String	Name of the status
statusNameForCandidates	String	Name of the status visible to candidates
displayOrder	Integer	What order the status is displayed in on the client side
candidate	Object	Contains information about the candidate
firstName	String	Candidate's first name
lastName	String	Candidate's last name
email	String	Candidate's email
mobile	Integer	Candidate's mobile number
ranking	Integer	Star ranking score for the candidate

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"e24e97df-030b-4498-b4bd-5405d429d80a","id":"e24e97df-030b-4498-b4bd-5405d429d80a","name":"Jobtrain - OpenAPI","type":"collection"}},"urlObject":{"path":["api","v1","Job","GetDBSReadyCandidateByJobId"],"host":["{{BaseURL}}"],"query":[{"disabled":true,"key":"PageNo","value":""},{"disabled":true,"key":"TextToSearch","value":""},{"disabled":true,"key":"SortColumn","value":""},{"disabled":true,"key":"SortDirection","value":""},{"disabled":true,"key":"PageSize","value":""},{"key":"JobId","value":""}],"variable":[]}},"response":[{"id":"435e1666-61a1-4442-bea1-f98d6ab16665","name":"Successful Operation","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/JSON"}],"url":{"raw":"{{BaseURL}}/api/v1/Jobs/GetDBSReadyCandidateByJobId?JobId","host":["{{BaseURL}}"],"path":["api","v1","Jobs","GetDBSReadyCandidateByJobId"],"query":[{"key":"PageNo","value":"","disabled":true},{"key":"TextToSearch","value":"","disabled":true},{"key":"SortColumn","value":"","disabled":true},{"key":"SortDirection","value":"","disabled":true},{"key":"PageSize","value":"","disabled":true},{"key":"JobId","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/JSON"}],"cookie":[],"responseTime":null,"body":"{\n \"applicationId\": \"\",\n \"candidateId\": \"\", \n \"jobId\": \"\",\n \"createdOnDate\": \"DD/MM/YYYY HH:MM:SS\",\n \"agreedToTerms\": \"Yes/No\",\n \"applicationSubmitedOn\": \"DD/MM/YYYY HH:MM:SS\",\n \"source\": \"\",\n \"applicationStatus\": {\n \"id\": \"\",\n \"statusName\": \"\",\n \"statusNameForCandidates\": \"\",\n \"displayOrder\": \"\"\n },\n \"candidate\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"mobile\": \"\"\n },\n \"ranking\": \"\"\n}"},{"id":"e4896755-5346-488a-9f0a-df50c6e88699","name":"Invalid ID supplied","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/v1/Jobs/GetDBSReadyCandidateByJobId/:Id?PageNo=&TextToSearch=&SortColumn=&SortDirection=&PageSize=","host":["{{BaseURL}}"],"path":["api","v1","Jobs","GetDBSReadyCandidateByJobId",":Id"],"query":[{"key":"PageNo","value":""},{"key":"TextToSearch","value":""},{"key":"SortColumn","value":""},{"key":"SortDirection","value":""},{"key":"PageSize","value":""}],"variable":[{"key":"Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ccf4392b-4499-4850-83ab-aa468124d4c3","name":"Candidate not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/v1/Jobs/GetDBSReadyCandidateByJobId/:Id?PageNo=&TextToSearch=&SortColumn=&SortDirection=&PageSize=","host":["{{BaseURL}}"],"path":["api","v1","Jobs","GetDBSReadyCandidateByJobId",":Id"],"query":[{"key":"PageNo","value":""},{"key":"TextToSearch","value":""},{"key":"SortColumn","value":""},{"key":"SortDirection","value":""},{"key":"PageSize","value":""}],"variable":[{"key":"Id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"685c508b-bc2f-468f-b0fb-9f2c04a4175a"},{"name":"DBS provider should post the unique reference ID back to Jobtrain after successful registeration","id":"5c6a7d7c-9917-46f1-a6ab-9ed2af312b4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/JSON"}],"body":{"mode":"raw","raw":"{\n \"applicationId\": \"\",\n \"applicationShortCode\": \"\",\n \"orgid\": \"\",\n \"personId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BaseURL}}/api/v1/Job/UpdateDBSUniqueId","description":"

This is the call to register the candidate with a DBS provider.

A unique reference is required after successful registeration, to be passed back to Jobtrain for identification.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
applicationId	Integer	ID of the Application
applicationShortCode	String	Shortcode of the DBS check
orgid	String	ID of the organisation
personID	String	Candidate's ID from the DBS provider

Unique reference is required after successful registeration, and is then used to update the Status/Stage of the DBS check in the candidate record.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
applicationId	Integer	ID of the Application
applicationStage	String	Stage of the DBS check
applicationStatus	String	Status of the DBS Check

This section relates to our DBS Integrations. It allows finding candidates who are ready for DBS checks (at the status set by the client in System Customisation), as well as posting those candidates to a DBS provider, and then updating the candidate record with the DBS check status (so the progress can be seen within Jobtrain, against the candidate).

Date/Time format is as follows: DD/MM/YYYY HH:MM:SS

Date format is as follows: DD/MM/YYYY

\n","_postman_id":"8d754655-e59d-4f01-8ce0-d3e53a3acda0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"e24e97df-030b-4498-b4bd-5405d429d80a","id":"e24e97df-030b-4498-b4bd-5405d429d80a","name":"Jobtrain - OpenAPI","type":"collection"}}},{"name":"Divisions","item":[{"name":"list of all divisions","id":"821cff2a-526e-475e-91a2-ea03ef1d8dbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseURL}}/api/v1/Divisions","description":"

Returns a list of all divisions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
id	Integer	ID of the division
divisionName	String	Name of the division

Returns the information of a specfic division

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
id	Integer	ID of the division
divisionName	String	Name of the division

Parameters:

TextToSearch will search Division Name

sortColumn accepts Division ID or Division Name

sortDirection accepts Ascending or Descending

\n","_postman_id":"663adf43-cb7e-4896-8681-825505800e31","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"e24e97df-030b-4498-b4bd-5405d429d80a","id":"e24e97df-030b-4498-b4bd-5405d429d80a","name":"Jobtrain - OpenAPI","type":"collection"}}},{"name":"Departments","item":[{"name":"list of all departments","id":"d37c8b1e-9ff2-48bf-a01b-9fb0ff3be3e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"graphql","graphql":{"query":"","variables":""}},"url":"{{BaseURL}}/api/v1/Department","description":"

Returns a list of all departments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
id	Integer	ID of the department
departmentName	String	Name of the department

Returns details of a specific department

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
id	Integer	ID of the department
departmentName	String	Name of the department

Returns a list of all locations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
id	Integer	ID of the location
locationName	String	Name of the location
addressLine1	String	1st line of the address
addressLine2	String	2nd line of the address
city	String	Location's city
county	String	Location's county
postcode	String	Location's postcode
latitude	double	GPS coordinates of the location
longitude	double	GPS coordinates of the location

Returns the specifics of a particular Location

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
id	Integer	ID of the location
locationName	String	Name of the location
addressLine1	String	1st line of the address
addressLine2	String	2nd line of the address
city	String	Location's city
county	String	Location's county
postcode	String	Location's postcode
latitude	double	GPS coordinates of the location
longitude	double	GPS coordinates of the location

Field	Type	Description
salaryBandId	Integer	ID of the salary band
bandLabel	String	Name of the salary band
salaryFrom	String	Value from
salaryTo	String	Value to

Field	Type	Description
salaryBandId	Integer	ID of the salary band
bandLabel	String	Name of the salary band
salaryFrom	String	Value from
salaryTo	String	Value to

Field	Type	Description
id	Integer	ID of the job category
name	String	Name of the job category

Field	Type	Description
employmentTypeId	Integer	ID of the employment type
employmentTypeLabel	String	Name of the employment type

Field	Type	Description
id	Integer	ID of the school location
name	String	Name of the school location
departmentName	Integer	Name of the department associated with the school location

Field	Type	Description
id	Integer	ID of the job level/grade
name	String	Name of the job level/grade
displayOrder	Integer	Order the job level/grade is displayed in the client side

Field	Type	Description
id	Integer	ID of the country
countryName	String	Name of the country
countryISOCode	String	ISO Code for the country