Job Edit
  • 02 Dec 2020
  • 2 Minutes to read
  • PDF

Job Edit

  • PDF

Article summary

Edit existing Job

To edit a job, perform a PUT request to below URL and JSON request body example 

https://api.daynurseries .co.uk/index.cfm/jobs/{jobid}/

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 job provider this is the API Key of the member posting the job 

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 address (please note job_contact_email & job_contact_url cannot be passed together)

job_contact_urlYes if job_contact_email blank1000 Character String On 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.

partner_key

No


Unique identification key of Partner

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

Please use api_key from page-2 for each domain

job_salary

No (*see note regarding salary fields)

60 character stringe.g. "Negotiable"
job_salary_to

No (*see note regarding salary fields)

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

No (*see note regarding salary fields)

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

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

  

Example API Request Body

{
    "api_key":"00000",
    "partner_key":"000",
    "job_contact_name":"Name Lastname",
    "job_contact_email":"name@domain.com",
    "job_contact_url":"",
    "job_admin_email":"admin@domain.com",
    "job_pay_type_id":1,
    "job_salary_from":"10000",
    "job_salary_to":"25000",
    "job_salary":""
}


API Response

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

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


Was this article helpful?

What's Next