1. NHSJobs API Guide

NHSJobs Guide

<span class="ephox-cereal-pre-cursor-token ephox-cereal-start-cursor ephox-cereal-finish-cursor ephox-polish-content-eph-extra" data-ephox-cereal-start-offset="0" data-ephox-cereal-finish-offset="0" style="display: none;"></span><span class="ephox-cereal-text-node-wrapper ephox-polish-content-eph-wrapper"><span class="ephox-cereal-pre-cursor-token ephox-cereal-start-cursor ephox-cereal-finish-cursor ephox-polish-content-eph-extra" data-ephox-cereal-start-offset="0" data-ephox-cereal-finish-offset="0" style="display: none;"></span><span class="ephox-cereal-text-node-wrapper ephox-polish-content-eph-wrapper">; </span></span>

Board Overview

Integration Type Automated Job Feed
Delivery Type HTTP
Media Type Differential
eQuest Pipeline ID NHSJobs_API
Board URL https://www.jobs.nhs.uk/
Delivery Times (UTC) every hour
HTML Allowed YES
Known Character Limit N/A
Board Posting Duration 30 days
Has Board Specific Data Fields YES - required
Special Requirements NO
Known Issues/Limitations NO
<span class="ephox-cereal-pre-cursor-token ephox-cereal-start-cursor ephox-cereal-finish-cursor ephox-polish-content-eph-extra" data-ephox-cereal-start-offset="0" data-ephox-cereal-finish-offset="0" style="display: none;"></span><span class="ephox-cereal-text-node-wrapper ephox-polish-content-eph-wrapper"> </span>


Board Configuration (for Admins)

Field Name Field Type Required Description
Account Number open text YES This is provided by NHSJobs
Testing boolean NO If needed to test (use NSHJobs test server) this field needs to be set to true on the board instance
<span class="ephox-cereal-pre-cursor-token ephox-cereal-start-cursor ephox-cereal-finish-cursor ephox-polish-content-eph-extra" data-ephox-cereal-start-offset="0" data-ephox-cereal-finish-offset="0" style="display: none;"></span><span class="ephox-cereal-text-node-wrapper ephox-polish-content-eph-wrapper"> </span>


Board Specific Data (for Users)

Field Name Field Type Required Description
Job Advert Short Description open text YES Job Advert Description, this is like a short description and not the full job description
Job Advert Overview open text YES Job Advert Overview
Organisation Description open text YES Organization Description
Organisation Description open text YES Organization Description
Person desirable skills description open text NO Person desirable skills description. Formatting requirements per NHS: enter an HTML line break tag in between each skill
Person essential skills description open text NO Person essential skills description. Formatting requirements per NHS: enter an HTML line break tag in between each skill
Person desirable experience description open text NO Person desirable experience description. Formatting requirements per NHS: enter an HTML line break tag in between each experience
Person essential experience description open text NO Person essential experience description. Formatting requirements per NHS: enter an HTML line break tag in between each experience
Person desirable qualifications description open text NO Person desirable qualifications description. Formatting requirements per NHS: enter an HTML line break tag in between each qualification
Person essential qualifications description open text NO Person essential qualifications description. Formatting requirements per NHS: enter an HTML line break tag in between each qualifications
PayType picklist YES PayType, select from available values
Contract Type picklist YES Contract Type, select from available values - if selected value is anything but PERMANENT following 2 fields appear and are required to make a selection for: Duration Length and Duration Unit
Duration Length picklist YES Duration Length - this field is required in case Contract Type has a value different than PERMANENT
Duration Unit picklist YES Duration Unit - this field is required in case Contract Type has a value different than PERMANENT
Work Type picklist YES Work Type, select from available values
Contact Name open text YES Contact Name
Recruiter Job Title open text YES Recruiter Job Title
Contact Email open text YES Contact Email
Contact Phone open text NO Contact Phone
Does the job require applicants to be checked for any previous criminal convictions? boolean YES Does the job require applicants to be checked for any previous criminal convictions
Is the job open to applicants outside the EU and EEA? boolean YES Is the job open to applicants outside the EU and EEA
Does the job require current UK professional registration? boolean YES Does the job require current UK professional registration
Convictions boolean YES Convictions
PoliceWarning boolean YES PoliceWarning
StaffGroup picklist YES StaffGroup, select from available values
Area Of Work picklist YES Area Of Work, select from available values
Location Postal Code open text YES Location Postal Code
Location Street Address open text YES Location Street Address
Additional Street Address open text NO Additional Street Address
Salary Unit picklist YES Salary Unit, select from available values
Additional Salary Details open text no Additional Salary Details
Salary Type picklist YES Salary Type, select from available values - in case of value selected is different than "Negotiable" different fields appear and are required: Salary Amount if "Fixed Pay" is selected and Minimum Salary and Maximum Salary if "Ranged Pay" is selected

Integration Updates


This page was:

Helpful | Not Helpful