Human Capital Management REST API Developer Reference

jobapplications

Represents a Job Application REST API structure

GET

URI /services/apexrest/v1.0/jobapplications/*
Description Returns job applications based on job application ID, job application's candidate ID, job application's candidate email, job application's applicant ID, or job application's job opening ID, and optionally custom fields of Job Application object that are passed as parameters in request URL

Input Parameters

ids Comma-separated Salesforce record IDs of job applications
candidateemails Comma-separated email IDs of related candidates
candidateids Comma-separated Salesforce record IDs of related candidates
applicantids Comma-separated applicant IDs of job applications
jobopeningids Comma-separated Salesforce record IDs of related job openings
customfields Comma-separated custom field names of Job_Application__c object

Sample Code


// GET Response
[{
   "ZipPostalCode": "123456",
   "StreetAddress": "Street Address",
   "StateProvince": "State Province",
   "Source": "Magazine",
   "Score": 60,
   "Region": "Region",
   "RecruiterEmail": "ash.howard@mailinator.com",
   "Position": "Position 1",
   "Phone": "989989989989",
   "Name": "Candidate Test1",
   "LastName": "Test1",
   "LastModifiedDate": "2016-04-01T09:07:00.000Z",
   "LastModifiedById": "00515000006AEwwAAG",
   "LastDocuSignStatus": "2015-02-02T11:00:00.000Z",
   "JobOpening": "a2I15000000OXIHEA4",
   "InterviewerEmail": "ash.howard@mailinator.com",
   "Id": "a2G15000001W1WpEAK",
   "HiringManagerEmail": "ash.howard@mailinator.com",
   "FirstName": "Candidate",
   "Email": "test_1@mailinator.com",
   "DocuSignStatus": "Delivered",
   "DocuSignEnvelopeId": "ABCD",
   "Distance": 25,
   "CustomFields": [],
   "CreatedDate": "2016-04-01T09:07:00.000Z",
   "CreatedById": "00515000006AEwwAAG",
   "Country": "United States",
   "CityTown": "City Town",
   "CandidateID": "a1D15000003XxLQEA0",
   "CandidateEmail": "test_1@mailinator.com",
   "Candidate": "a1D15000003XxLQEA0",
   "AverageRating": 4,
   "ApplicationStatus": "New",
   "ApplicantID": "34",
   "CustomFields": [{
      "FieldName": "CustomFieldName",
      "Value": "CustomFieldValue"
   }]
}]

POST

URI /services/apexrest/v1.0/jobapplications/*
Description Insert job application records

Input Parameters

records Job application records that need to be inserted

Sample Code


// POST Request
{
   "records": [{
      "ApplicationStatus": "New",
      "Candidate": "a1D15000003XxLQEA0",
      "Distance": "25",
      "DocuSignEnvelopeId": "ABCD",
      "DocuSignStatus": "Delivered",
      "JobOpening": "a2I15000000OXIHEA4",
      "LastDocuSignStatus": "2015-02-02T11:00:00.000Z",
      "Score": "60",
      "CustomFields": [{
         "FieldName": "CustomFieldName",
         "Value": "CustomFieldValue"
      }]
   }, {
      "ApplicationStatus": "New",
      "Candidate": "a1D15000003XxLQEB0",
      "Distance": "25",
      "DocuSignEnvelopeId": "ABCD",
      "DocuSignStatus": "Delivered",
      "JobOpening": "a2I15000000OXIHEA4",
      "LastDocuSignStatus": "2015-02-02T11:00:00.000Z",
      "Score": "60",
      "CustomFields": [{
         "FieldName": "CustomFieldName",
         "Value": "CustomFieldValue"
      }]
   }]
}

// POST Response
[
   "a2G15000001W1XHEA0",
   "a2G15000001W1XIEA0"
]

PATCH

URI /services/apexrest/v1.0/jobapplications/*
Description Insert or update job application records

Input Parameters

records Job application records that need to inserted or updated

Sample Code


// PATCH Request
{
   "records": [{
      "ApplicationStatus": "New",
      "Candidate": "a1D15000003XxLQEA0",
      "Distance": "25",
      "DocuSignEnvelopeId": "ABCD",
      "DocuSignStatus": "Delivered",
      "JobOpening": "a2I15000000OXIHEA4",
      "LastDocuSignStatus": "2015-02-02T11:00:00.000Z",
      "Score": "60",
      "Id": "a2G15000001W1WpEAK",
      "CustomFields": [{
         "FieldName": "CustomFieldName",
         "Value": "CustomFieldValue"
      }]
   }, {
      "ApplicationStatus": "New",
      "Candidate": "a1D15000003XxLQEB0",
      "Distance": "25",
      "DocuSignEnvelopeId": "ABCD",
      "DocuSignStatus": "Delivered",
      "JobOpening": "a2I15000000OXIHEA4",
      "LastDocuSignStatus": "2015-02-02T11:00:00.000Z",
      "Score": "60",
      "CustomFields": [{
         "FieldName": "CustomFieldName",
         "Value": "CustomFieldValue"
      }]
   }]
}

// PATCH Response
[
   "a2G15000001W1XHEA0",
   "a2G15000001W1XIEA0"
]
© Copyright 2009–2017 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.