Posting a Job
  • 02 Dec 2020
  • 5 Minutes to read
  • PDF

Posting a Job

  • PDF

Article summary

Posting a Job

To insert a job, perform a POST request to 

https://api.daynurseries.co.uk/index.cfm/jobs/

with the following fields in a JSON encoded string, making sure to observe an "application/json" content header as part of your request.

Key

Required

Data Type  

Description  

api_key

Yes 

40 character string

Member API Key / If you are a Partner this is the API Key of the member posting the job 

job_category_id 

Yes 

Integer

e.g. Manager / Chef. All data available from the categories api:

http://api.daynurseries .co.uk/index.cfm/jobs/categories?api_key=0000

Please use api_key from page-2 for each domain

job_referenceNo255 character stringA reference for the Job "Test Job CP1234"

job_description 

Yes 

8000 character string

Description of your job. HTML filter in place as follows

p,i,b,u,strong,em,ol,ul,li,br allowed but attributes stripped (exception align on p tags)

small,big,center,font,div,span will be removed but the content will stay e.g. '<center>hello</center>' would be replaced with 'hello'

all other tags and their content will be removed

job_skills 

No 

8000 character string 

Comma separated list of Skills/Qualifications 

job_pay_type_id

No (*see note regarding salary fields)

Integer

e.g. "Salary", "Wage". All data available from the pay types  api:

http://api.daynurseries .co.uk/index.cfm/jobs/pay_types?api_key=0000

Please use api_key from page-2 for each domain

job_salary_from

No (*see note regarding salary fields)

Decimal (9,2)e.g. "20000.00"
job_salary_to

No (*see note regarding salary fields)

Decimal (9,2)e.g. "50000.00"

job_salary

No (*see note regarding salary fields)

60 character stringe.g. "Negotiable"

job_title 

Yes 

60 character string

e.g. Head of Technical Support 

job_setting_id 

Yes 

Integer

e.g. Charity or Head Office. All data available from the settings api:

https://api.daynurseries .co.uk/index.cfm/jobs/settings?api_key=0000

Please use api_key from page-2 for each domain

job_type_id 

Yes 

Integer 

e.g. Full Time or Part Time. All data available from the type api:

https://api.daynurseries .co.uk/index.cfm/jobs/types?api_key=0000

Please use api_key from page-2 for each domain

job_processed_by 

Yes 

255 Character String

The name of the person entering the job - for logging purposes (Not displayed to user)


EITHER an 'Application Email' (job_contact_email) OR an 'Application URL' (job_contact_url) is required

  • If an 'Application Email' is entered the job application details will be sent to this email address.

  • If an 'Application URL' is entered the applicant will be redirected to this URL to complete the application.

  • If an ‘Application URL' is entered, ’1-Click Apply' will not be available for this Job and will likely result in less applications for this job.

job_contact_email 

Yes if job_contact_url blank

500 Character String 

Not displayed but applications are sent to this email address (please note job_contact_email & job_contact_url cannot be passed together) 

job_contact_url Yes if job_contact_email blank1000 Character StringOn a click of 'Apply for this Job' button the user will be forwarded to this URL (please note  job_contact_url & job_contact_email cannot be passed together) 
please note the url must be the url for the application page for this job, not a generic job search or application page




job_contact_name 

Yes 

255 Character String 

Displayed with job details

job_admin_email 

Yes 

500 Character String 

A reminder will be sent to this email address before the job expires, to alert them if they wish to extend the job. (Email Not sent if the job is posted by a Partner )

job_member_id 

No 

big integer / long (This or job_town_id is
  required – not both)

 

The Nursery / Recruitment Agency the job should be branded as.

Passing this attribute as an empty string or NULL will result in the job not having any branding but is an acceptable request. Please note from 1st July 2018 all empty strings will Job will be changed to the member ID of the job posting account, see branding Notes below.

Valid member id's can be obtained from the jobs/members API (please note the response provided will vary between api key as different users have different permissions)

Search with words

http://api.daynurseries .co.uk/index.cfm/jobs/members?api_key=0000&search_term=lac

All members data when using with partner_key

http://api.daynurseries .co.uk/index.cfm/jobs/members?api_key=0000&partner_key=0000

Please use api_key from page-2 for each domain

Note: Further explanation of this field is provided beneath this table

job_town_id 

Yes ( and no -see description )

integer

The town where the job is located. All data  available from the towns api: 

https://api.daynurseries .co.uk/index.cfm/jobs/towns?api_key=0000&partner_key=0000

If you do not pass a job_town_id but do pass a member_id we will attempt to set the town via the location of the member_id - For the vast majority of members
this is fine but there are a few locations in london where this fails and you will recieve a validation error.

partner_key

No (if Member), Yes (if Partner)


Unique identification key

Further information regarding API Parameters

Job_member_id  ( Branding Options )

We offer three different branding options on our website:

1: Self branding

As expected this brands the job as the member posting the job and is achieved by passing the member_id associated with the api_key in question

2: Branding as other allowed member

Some members have permission to post on behalf of other members and thus the branding would be of the selected meber e.g. care home groups can post on behalf of their members or recruitment agencies can post on behalf of any care home

These 'other' members can be accessed via the jobs/members api and the amount returned could be anything from 2 records for a small group to thousands for a supplier so we suggest caching this data and updating daily or more frequently.

3: Anonymous branding - This Option is no Longer Available as of 1st July 2018 as no longer compatible with Google's Job Listing Guidelines

By not passing the parameter job_member_id, passing NULL or passing an empty string we will not associate any branding with the job.

Job Salary Fields

Note the following validation:

job_pay_type_id is not submitted (pre 23 Feb 2017 API Integration/ Upgrade)
this presumes you are submitting just field job_salary which is required

job_pay_type_id is not submitted or not of value '1', '2' or 5' (post 23 Feb 2017 API Integration/ Upgrade)
If job_salary_from or job_salary_to or job_salary is submitted then it will error as a valid job_pay_type_id is required

If job_pay_type_id is '5' (Non Specific Salary)
job_salary is required
job_salary_from - should not be submitted (will error if submitted)
job_salary_to - should not be provided (will error if submitted)

If job_pay_type_id is '1' (per annum) or '2' (per hour)
job_salary_from - should be submitted
job_salary_to - should be submitted (if the same value as job_salary_to then still needs to be submitted)
job_salary is optional

Fields with their own API's

The content of these fields may be subject to change in the future so we have an API for each.

When using the /members/ api with a provider key to get all members the request is very large and may take some time to generate and recieve. We provide this api as the applicable members on our system are updated hourly (though we recommend updating your system daily!). We have provided the search_term parameter for the /members/ api so that job providers or other third party integrations may could use it for a live auto suggest style input.


Example API Request Body

{
   "api_key":"00000",
   "job_title":"Test job",
   "job_category_id":4,
   "job_setting_id":10,
   "job_type_id":2,
   "job_name":"full name of job poster",
   "job_contact_name":"Name Lastname",
   "job_contact_email":"name@domain.com",
   "job_contact_url":"",
   "job_admin_email":"admin@domain.com",
   "job_description":"Lorem ipsum dolor sit amet..",
   "job_skills":"bookkeeping,caring approach,reliability and flexibility",
   "job_town_id":275,
   "job_reference":"Test Job CP1234",
   "partner_key":"000",
   "job_pay_type_id":1,
   "job_salary_from":"10000",
   "job_salary_to":"25000",
   "job_salary":"Neg, DOE"
}

API Response

The API will return a '201 Job (#000) successfully added.' on success and 4xx on validation failure.

The response body will contain a JSON object of the job created in the data key.

 


Was this article helpful?

What's Next