POST api/Candidate/HireCandidate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
HireTypeId	integer	None.
HiredUnderContractId	integer	None.
HiredByContractId	integer	None.
SavedForAssociateId	integer	None.
SavedByResumeAssistant	boolean	None.
GenderId	integer	None.
officeId	integer	None.
OfficeIds	Collection of integer	None.
IsCandidateLiscensed	boolean	None.
LanguageIds	Collection of integer	None.
AccountTypeId	integer	None.
Credit	integer	None.
isBulk	boolean	None.
BulkCandidateIds	Collection of integer	None.
CandidateId	integer	None.
FirstName	string	None.
LastName	string	None.
MiddleInitial	string	None.
AssociateId	integer	None.
PersonallyRecrutedAsssId	integer	None.
AssociateContractId	integer	None.
DateOfBirth	date	None.
AssignmentDate	date	None.
Address	string	None.
Address2	string	None.
GeoAddress	string	None.
Zip	string	None.
Email	string	None.
WorkEmail	string	None.
HomePhone	string	None.
FormattedHomePhone	string	None.
MobilePhone	string	None.
FormattedMobilePhone	string	None.
WorkPhone	string	None.
FormattedWorkPhone	string	None.
StrikeIronPhoneNumber	string	None.
FormattedStrikeIronPhoneNumber	string	None.
MobilePhoneOrHomePhone	string	None.
FomattedMobilePhoneOrHomePhone	string	None.
StateId	integer	None.
CityId	integer	None.
State	string	None.
StateCode	string	None.
City	string	None.
CountryId	integer	None.
Country	string	None.
IsCalled	boolean	None.
HasAppointmentInThePast	boolean	None.
HasAppointment	boolean	None.
HasComment	boolean	None.
CandidateSourceId	integer	None.
CandidateSource	string	None.
CandidateCallStatusId	integer	None.
CandidateCallStatus	string	None.
CandidateIndex	integer	None.
CandidateStatusId	integer	None.
CandidateStatus	string	None.
IsPositiveMarked	boolean	None.
IsPrinted	boolean	None.
ResumeType	string	None.
CreateDate	date	None.
UpcomingAppointmentDateString	string	None.
PassedAppointmentDateString	string	None.
CandidateUserId	integer	None.
CreateDateShortDateString	string	None.
LatestAppointmentShortDateString	string	None.
LatestAppointment	date	None.
FullName	string	None.
DateofBirthShortDateString	string	None.
AssignDateShortDateString	string	None.
ComposedAddress	string	None.
PrimaryCandidateAddressLatitude	decimal number	None.
PrimaryCandidateAddressLongitude	decimal number	None.
IsGeoCodeAttempted	boolean	None.
HasCandidateGeoCoded	boolean	None.
GeoCodeStatus	GeoCodeStatusEnum	None.
LocationCode	string	None.
CityDisplay	string	None.
LatestComment	CommentDTO	None.
RecentActivities	Collection of RecentActivityDTO	None.
FileName	string	None.
S3FileName	string	None.
ContentType	string	None.
UploadedByWeb	boolean	None.
FileBytes	Collection of byte	None.
AssigmentGuid	globally unique identifier	None.
AssignedStatus	string	None.
lastEventId	integer	None.
IsAssigned	boolean	None.
IsFirstInterview	boolean	None.
IsSecondInterview	boolean	None.
IsThirdInterview	boolean	None.
IsFourthInterview	boolean	None.
IsFifthInterview	boolean	None.
ResponseDate	string	None.
isDualContext	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "HireTypeId": 1,
  "HiredUnderContractId": 2,
  "HiredByContractId": 3,
  "SavedForAssociateId": 1,
  "SavedByResumeAssistant": true,
  "GenderId": 1,
  "officeId": 4,
  "OfficeIds": [
    1,
    2
  ],
  "IsCandidateLiscensed": true,
  "LanguageIds": [
    1,
    2
  ],
  "AccountTypeId": 6,
  "Credit": 1,
  "isBulk": true,
  "BulkCandidateIds": [
    1,
    2
  ],
  "CandidateId": 8,
  "FirstName": "sample string 9",
  "LastName": "sample string 10",
  "MiddleInitial": "sample string 11",
  "AssociateId": 1,
  "PersonallyRecrutedAsssId": 1,
  "AssociateContractId": 1,
  "DateOfBirth": "2025-10-14T03:11:24.1712109-07:00",
  "AssignmentDate": "2025-10-14T03:11:24.1712109-07:00",
  "Address": "sample string 12",
  "Address2": "sample string 13",
  "GeoAddress": "sample string 14",
  "Zip": "sample string 15",
  "Email": "sample string 16",
  "WorkEmail": "sample string 17",
  "HomePhone": "sample string 18",
  "FormattedHomePhone": "18",
  "MobilePhone": "sample string 19",
  "FormattedMobilePhone": "19",
  "WorkPhone": "sample string 20",
  "FormattedWorkPhone": "20",
  "StrikeIronPhoneNumber": "sample string 21",
  "FormattedStrikeIronPhoneNumber": "sample string 21",
  "MobilePhoneOrHomePhone": "sample string 19",
  "FomattedMobilePhoneOrHomePhone": "19",
  "StateId": 1,
  "CityId": 1,
  "State": "sample string 22",
  "StateCode": "sample string 23",
  "City": "sample string 24",
  "CountryId": 1,
  "Country": "sample string 25",
  "IsCalled": true,
  "HasAppointmentInThePast": true,
  "HasAppointment": true,
  "HasComment": true,
  "CandidateSourceId": 30,
  "CandidateSource": "sample string 31",
  "CandidateCallStatusId": 1,
  "CandidateCallStatus": "sample string 32",
  "CandidateIndex": 33,
  "CandidateStatusId": 34,
  "CandidateStatus": "sample string 35",
  "IsPositiveMarked": true,
  "IsPrinted": true,
  "ResumeType": "sample string 38",
  "CreateDate": "2025-10-14T03:11:24.1712109-07:00",
  "UpcomingAppointmentDateString": "sample string 40",
  "PassedAppointmentDateString": "sample string 41",
  "CandidateUserId": 1,
  "CreateDateShortDateString": "10/14/2025",
  "LatestAppointmentShortDateString": "sample string 42",
  "LatestAppointment": "2025-10-14T03:11:24.1712109-07:00",
  "FullName": "sample string 10, sample string 9",
  "DateofBirthShortDateString": "10/14/2025",
  "AssignDateShortDateString": "10/14/2025",
  "ComposedAddress": "sample string 12 , sample string 24, sample string 22 sample string 15",
  "PrimaryCandidateAddressLatitude": 43.1,
  "PrimaryCandidateAddressLongitude": 44.1,
  "IsGeoCodeAttempted": true,
  "HasCandidateGeoCoded": true,
  "GeoCodeStatus": 1,
  "LocationCode": "sample string 45",
  "CityDisplay": "sample string 24, sample string 23",
  "LatestComment": {
    "LeadId": 1,
    "CandidateId": 1,
    "CommentId": 1,
    "Comment": "sample string 2",
    "CommentDate": "2025-10-14T03:11:24.1712109-07:00",
    "ManagerAssociateId": 1,
    "AgentName": "sample string 3"
  },
  "RecentActivities": [
    {
      "ActivityShortName": "sample string 1",
      "ActivityName": "sample string 2",
      "ActivityDate": "2025-10-14T03:11:24.1712109-07:00",
      "ActivityTime": "2025-10-14T03:11:24.1712109-07:00",
      "ActivityCategory": "sample string 3",
      "ActivityById": 4,
      "ActivityByName": "sample string 5",
      "ActivityComment": "sample string 6",
      "AppointmentType": 1,
      "CallStatus": 1,
      "PhoneNumber": "sample string 7",
      "LeadId": 1,
      "IsMira": true,
      "ActivityDescription": "sample string 9",
      "ActivityHeading": "sample string 10",
      "AppointmentDate": "2025-10-14T03:11:24.1712109-07:00",
      "HasDateTimePreference": true
    },
    {
      "ActivityShortName": "sample string 1",
      "ActivityName": "sample string 2",
      "ActivityDate": "2025-10-14T03:11:24.1712109-07:00",
      "ActivityTime": "2025-10-14T03:11:24.1712109-07:00",
      "ActivityCategory": "sample string 3",
      "ActivityById": 4,
      "ActivityByName": "sample string 5",
      "ActivityComment": "sample string 6",
      "AppointmentType": 1,
      "CallStatus": 1,
      "PhoneNumber": "sample string 7",
      "LeadId": 1,
      "IsMira": true,
      "ActivityDescription": "sample string 9",
      "ActivityHeading": "sample string 10",
      "AppointmentDate": "2025-10-14T03:11:24.1712109-07:00",
      "HasDateTimePreference": true
    }
  ],
  "FileName": "sample string 46",
  "S3FileName": "sample string 47",
  "ContentType": "sample string 48",
  "UploadedByWeb": true,
  "FileBytes": "QEA=",
  "AssigmentGuid": "b57a9e75-b5b2-46b4-a791-2fd53966978c",
  "AssignedStatus": "sample string 50",
  "lastEventId": 1,
  "IsAssigned": false,
  "IsFirstInterview": false,
  "IsSecondInterview": false,
  "IsThirdInterview": false,
  "IsFourthInterview": false,
  "IsFifthInterview": false,
  "ResponseDate": "sample string 51",
  "isDualContext": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:

true