POST v1/ApplicantTracking/AddApplicantByApplicantJobID

Add a new applicant to an existing job opening. Some fields may be required based on existing job opening configuration.

Request Information

URI Parameters

None.

Body Parameters

ApplicantPersonData
NameDescriptionTypeAdditional information
JobOpeningGuid

A valid Job Opening Guid of an existing ApplicantJobOpening (required)

globally unique identifier

Required

FirstName

Applicant's first name (required)

string

Required

MiddleInitial

Applicant's middle initial

character

None.

LastName

Applicant's last name (required)

string

Required

Gender

Applicant's gender

Gender

None.

DateOfBirth

Applicant's date of birth

date

None.

Address1

Applicant's address line 1

string

None.

Address2

Applicant's address line 2

string

None.

City

Applicant's city

string

None.

State

Applicant's state (use 2 letter abbreviation, ex: NY)

string

None.

ZipCode

Applicant's zip code

string

None.

County

Applicant's county

string

None.

Country

Applicant's country

string

None.

PhoneNumber

Applicant's phone number

string

None.

Email

Applicant's email

string

None.

AvailableDate

Applicant's available date

date

None.

DesiredPay

Applicant's desired pay

string

None.

WhoReferred

Applicant's referral by

string

None.

SSN

Applicant's social security number

string

None.

IdentificationNumber

Applicant's identification number (ex: driver's license)

string

None.

HighestEducation

Applicant's highest education type

ApplicantTrackingHighestEducation

None.

CollegeOrUniversity

Applicant's attended college or university

string

None.

References

Applicant's contact references

string

None.

Request Formats

application/json, text/json

Sample:
{
  "JobOpeningGuid": "d6a7ff3c-9c68-40cd-b74d-37c45bba8bdc",
  "FirstName": "sample string 1",
  "MiddleInitial": "A",
  "LastName": "sample string 3",
  "Gender": 0,
  "DateOfBirth": "2026-05-14T09:29:24.4558518-04:00",
  "Address1": "sample string 4",
  "Address2": "sample string 5",
  "City": "sample string 6",
  "State": "sample string 7",
  "ZipCode": "sample string 8",
  "County": "sample string 9",
  "Country": "sample string 10",
  "PhoneNumber": "sample string 11",
  "Email": "sample string 12",
  "AvailableDate": "2026-05-14T09:29:24.4558518-04:00",
  "DesiredPay": "sample string 13",
  "WhoReferred": "sample string 14",
  "SSN": "sample string 15",
  "IdentificationNumber": "sample string 16",
  "HighestEducation": 0,
  "CollegeOrUniversity": "sample string 17",
  "References": "sample string 18"
}

application/xml, text/xml

Sample:
<ApplicantPersonData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">
  <Address1>sample string 4</Address1>
  <Address2>sample string 5</Address2>
  <AvailableDate>2026-05-14T09:29:24.4558518-04:00</AvailableDate>
  <City>sample string 6</City>
  <CollegeOrUniversity>sample string 17</CollegeOrUniversity>
  <Country>sample string 10</Country>
  <County>sample string 9</County>
  <DateOfBirth>2026-05-14T09:29:24.4558518-04:00</DateOfBirth>
  <DesiredPay>sample string 13</DesiredPay>
  <Email>sample string 12</Email>
  <FirstName>sample string 1</FirstName>
  <Gender>Male</Gender>
  <HighestEducation>HighSchool</HighestEducation>
  <IdentificationNumber>sample string 16</IdentificationNumber>
  <JobOpeningGuid>d6a7ff3c-9c68-40cd-b74d-37c45bba8bdc</JobOpeningGuid>
  <LastName>sample string 3</LastName>
  <MiddleInitial>65</MiddleInitial>
  <PhoneNumber>sample string 11</PhoneNumber>
  <References>sample string 18</References>
  <SSN>sample string 15</SSN>
  <State>sample string 7</State>
  <WhoReferred>sample string 14</WhoReferred>
  <ZipCode>sample string 8</ZipCode>
</ApplicantPersonData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.