Get a candidate
get
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}
Request
Path Parameters
-
CandidateNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : recruitingCandidates-item-response
Type:
Show Source
object
-
attachments: array
Attachments of the Candidates
Title:
Attachments of the Candidates
The attachments resource is a child of the recruitingCandidates resource and provides details about attachments provided by the candidate. -
CampaignOptIn: string
Maximum Length:
1
Campaign opt-in feature to recruit candidates. -
candidateAddress: array
Address of the Recruiting Candidates
Title:
Address of the Recruiting Candidates
The candidateAddress resource is a child of the recruitingCandidates resource and provides details about the address of the candidate. -
CandidateNumber: string
Read Only:
true
Candidate number in recruiting candidates. -
candidatePhones: array
Phone of the Recruiting Candidates
Title:
Phone of the Recruiting Candidates
The candidatePhones resource is a child of the recruitingCandidates resource and provides details about the phone numbers of the candidate. -
CandidateType: string
Read Only:
true
Candidate type in recruiting candidates. -
CandLastModifiedDate: string
(date-time)
Candidate last modified date.
-
CreatedBy: string
Created using in recruiting candidates.
-
CreationDate: string
(date-time)
Creation date in recruiting candidates.
-
DisplayName: string
Read Only:
true
Display name in recruiting candidates. -
education: array
Education of the Recruiting Candidates
Title:
Education of the Recruiting Candidates
The education resource is a child of the recruitingCandidates resource and provides details about the education of the candidate. -
Email: string
Maximum Length:
240
Email in recruiting candidates. -
experience: array
Experience of the Recruiting Candidates
Title:
Experience of the Recruiting Candidates
The experience resource is a child of the recruitingCandidates resource and provides details about the work experience of the candidate. -
FirstName: string
Maximum Length:
150
First name in recruiting candidates. -
FullName: string
Read Only:
true
Full name in recruiting candidates. -
Honors: string
Maximum Length:
80
Honors in recruiting candidates. -
KnownAs: string
Maximum Length:
80
Known as in recruiting candidates. -
languages: array
Languages of the Recruiting Candidates
Title:
Languages of the Recruiting Candidates
The languages resource is a child of the recruitingCandidates resource and provides details about the languages of the candidate. -
LastName: string
Maximum Length:
150
Last name in recruiting candidates. -
LastUpdateDate: string
(date-time)
Last update date in recruiting candidates.
-
LastUpdatedBy: string
Last update using in recruiting candidates.
-
licensesAndCertificates: array
Licenses and Certifications of the Recruiting Candidates
Title:
Licenses and Certifications of the Recruiting Candidates
The licensesAndCertificates resource is a child of the recruitingCandidates resource and provides details about the licenses and certificates of the candidate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListName: string
Read Only:
true
List name in recruiting candidates. -
MiddleNames: string
Maximum Length:
80
Middle names in recruiting candidates. -
MilitaryRank: string
Maximum Length:
80
Military rank in recruiting candidates. -
PersonId: integer
Read Only:
true
Person ID in recruiting candidates. -
PreferredLanguage: string
Maximum Length:
4
Preferred language in recruiting candidates. -
PreferredTimezone: string
Maximum Length:
255
Preferred time zone of the candidate. -
PreNameAdjunct: string
Maximum Length:
150
Previous name adjunct in recruiting candidates. -
PreviousLastName: string
Maximum Length:
150
Previous last name in recruiting candidates. -
skills: array
Skills of the Recruiting Candidates
Title:
Skills of the Recruiting Candidates
The skills resource is a child of the recruitingCandidates resource and provides details about the skills of the candidate. -
SourceMedium: string
Maximum Length:
32
Source medium in recruiting candidates. -
SourceName: string
Maximum Length:
2000
Source name in recruiting candidates. -
Suffix: string
Maximum Length:
80
Suffix in recruiting candidates. -
Title: string
Maximum Length:
30
Title in recruiting candidates. -
workPreferences: array
Work Preferences of the Recruiting Candidates
Title:
Work Preferences of the Recruiting Candidates
The workPreferences resource is a child of the recruitingCandidates resource and provides details about the work preferences of the candidate.
Nested Schema : Attachments of the Candidates
Type:
array
Title:
Attachments of the Candidates
The attachments resource is a child of the recruitingCandidates resource and provides details about attachments provided by the candidate.
Show Source
Nested Schema : Address of the Recruiting Candidates
Type:
array
Title:
Address of the Recruiting Candidates
The candidateAddress resource is a child of the recruitingCandidates resource and provides details about the address of the candidate.
Show Source
Nested Schema : Phone of the Recruiting Candidates
Type:
array
Title:
Phone of the Recruiting Candidates
The candidatePhones resource is a child of the recruitingCandidates resource and provides details about the phone numbers of the candidate.
Show Source
Nested Schema : Education of the Recruiting Candidates
Type:
array
Title:
Education of the Recruiting Candidates
The education resource is a child of the recruitingCandidates resource and provides details about the education of the candidate.
Show Source
Nested Schema : Experience of the Recruiting Candidates
Type:
array
Title:
Experience of the Recruiting Candidates
The experience resource is a child of the recruitingCandidates resource and provides details about the work experience of the candidate.
Show Source
Nested Schema : Languages of the Recruiting Candidates
Type:
array
Title:
Languages of the Recruiting Candidates
The languages resource is a child of the recruitingCandidates resource and provides details about the languages of the candidate.
Show Source
Nested Schema : Licenses and Certifications of the Recruiting Candidates
Type:
array
Title:
Licenses and Certifications of the Recruiting Candidates
The licensesAndCertificates resource is a child of the recruitingCandidates resource and provides details about the licenses and certificates of the candidate.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Skills of the Recruiting Candidates
Type:
array
Title:
Skills of the Recruiting Candidates
The skills resource is a child of the recruitingCandidates resource and provides details about the skills of the candidate.
Show Source
Nested Schema : Work Preferences of the Recruiting Candidates
Type:
array
Title:
Work Preferences of the Recruiting Candidates
The workPreferences resource is a child of the recruitingCandidates resource and provides details about the work preferences of the candidate.
Show Source
Nested Schema : recruitingCandidates-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the person who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error code for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
User name of the person who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
Name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Size of the attachment. -
UploadedFileName: string
Title:
Uploaded File Name
Name to assign to a new attachment. -
UploadedText: string
Title:
Uploaded Text
Text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of a topology manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : recruitingCandidates-candidateAddress-item-response
Type:
Show Source
object
-
AddlAddressAttribute1: string
Maximum Length:
150
Link Relations -
AddlAddressAttribute2: string
Maximum Length:
150
Add Address Attribute 2 in recruiting candidate address. -
AddlAddressAttribute3: string
Maximum Length:
150
Add Address Attribute 3 in recruiting candidate address. -
AddlAddressAttribute4: string
Maximum Length:
150
Add Address Attribute 4 in recruiting candidate address. -
AddlAddressAttribute5: string
Maximum Length:
150
Add Address Attribute 5 in recruiting candidate address. -
AddressId: string
Read Only:
true
ID assigned to each recruiting candidate address. -
AddressLine1: string
Maximum Length:
240
Address Line 1 in recruiting candidate address. -
AddressLine2: string
Maximum Length:
240
Address Line 2 in recruiting candidate address. -
AddressLine3: string
Maximum Length:
240
Address Line 3 in recruiting candidate address. -
Building: string
Maximum Length:
240
Building in recruiting candidate address. -
City: string
Maximum Length:
60
City in recruiting candidate address. -
Country: string
Maximum Length:
60
Country in recruiting candidate address. -
CreatedBy: string
Read Only:
true
Created using in recruiting candidate address. -
CreationDate: string
(date-time)
Read Only:
true
Creation date in recruiting candidate address. -
FloorNumber: string
Maximum Length:
40
Floor number in recruiting candidate address. -
LastUpdateDate: string
(date-time)
Read Only:
true
Last update date in recruiting candidate address. -
LastUpdatedBy: string
Read Only:
true
Last update using in recruiting candidate address. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LongPostalCode: string
Maximum Length:
30
Long postal code in recruiting candidate address. -
PostalCode: string
Maximum Length:
30
Postal code in recruiting candidate address. -
Region1: string
Maximum Length:
120
Region 1 in recruiting candidate address. -
Region2: string
Maximum Length:
120
Region 2 in recruiting candidate address. -
Region3: string
Maximum Length:
120
Region 3 in recruiting candidate address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidates-candidatePhones-item-response
Type:
Show Source
object
-
AreaCode: string
Maximum Length:
30
Area code in recruiting candidate phone. -
CountryCodeNumber: string
Maximum Length:
30
Country code number in recruiting candidate phone. -
CreatedBy: string
Read Only:
true
Created using in recruiting candidate phone. -
CreationDate: string
(date-time)
Read Only:
true
Creation date in recruiting candidate phone. -
LastUpdateDate: string
(date-time)
Read Only:
true
Last update date in recruiting candidate phone. -
LastUpdatedBy: string
Read Only:
true
Last update using in recruiting candidate phone. -
LegislationCode: string
Maximum Length:
4
Legislation code in recruiting candidate phone. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhoneId: string
Read Only:
true
ID assigned to each recruiting candidate phone number. -
PhoneNumber: string
Maximum Length:
60
Phone number in recruiting candidate phone. -
PhoneType: string
Read Only:
true
Phone type in recruiting candidate phone.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidates-education-item-response
Type:
Show Source
object
-
AcademicStanding: string
Title:
Academic Standing
Maximum Length:30
Academic standing in recruiting candidate education. -
ActivitySummary: string
(byte)
Title:
Summary of Activities
Activity summary in recruiting candidate education. -
AreaOfStudy: string
Title:
Area of Study
Maximum Length:240
Area of study in recruiting candidate education. -
AverageGrade: string
Title:
Average Grade
Maximum Length:240
Average grade in recruiting candidate education. -
AwardingBody: string
Title:
Awarding Body
Maximum Length:240
Awarding body in recruiting candidate education. -
City: string
Title:
City
Maximum Length:240
City in recruiting candidate education. -
Comments: string
(byte)
Title:
Comments
Comments in recruiting candidate education. -
CompletedAmount: integer
(int64)
Title:
Completed Amount
Completed amount in recruiting candidate education. -
CompletedTraningUnits: string
Title:
Training Completed Units
Maximum Length:240
Completed training units in recruiting candidate education. -
ContentItemId: integer
(int64)
Title:
Degree
Content item ID in recruiting candidate education. -
CountryCode: string
Title:
Country
Maximum Length:30
Country code number in recruiting candidate education. -
CountryId: integer
(int64)
Title:
Country
Country ID in recruiting candidate education. -
DateAcquired: string
(date)
Title:
Date Acquired
Date acquired in recruiting candidate education. -
DegreeName: string
Title:
Degree
Maximum Length:240
Degree name in recruiting candidate education. -
Department: string
Title:
Faculty or Department
Maximum Length:240
Department in recruiting candidate education. -
Description: string
(byte)
Title:
Description
Description in recruiting candidate education. -
Duration: string
Title:
Duration
Maximum Length:240
Duration in recruiting candidate education. -
DurationUnits: string
Title:
Duration Units
Maximum Length:30
Duration units in recruiting candidate education. -
EducationalEstablishment: string
Title:
School Name
Maximum Length:2000
Education establishment in recruiting candidate education. -
EducationalEstablishmentId: integer
(int64)
Title:
School
Education establishment ID in recruiting candidate education. -
EducationId: integer
(int64)
Education ID in recruiting candidate education.
-
EducationLevel: string
Title:
Education Level
Maximum Length:30
Education level in recruiting candidate education. -
EducationURL: string
Title:
Education URL
Maximum Length:2000
Education URL in recruiting candidate education. -
Educator: string
Title:
Educator
Maximum Length:240
Educator in recruiting candidate education. -
EduLevelCompletedFlag: boolean
Title:
Education Level Completed
Maximum Length:30
Education level completed indicator in recruiting candidate education. -
EndDate: string
(date)
Title:
End Date
End date in recruiting candidate education. -
Fee: integer
(int64)
Title:
Fee
Fee in recruiting candidate education. -
FeeCurrency: string
Title:
Fee Currency
Maximum Length:30
Fee currency in recruiting candidate education. -
GPA: number
Title:
GPA
GPA in recruiting candidate education. -
GraduatedFlag: boolean
Title:
Graduated
Maximum Length:30
Graduated indicator in recruiting candidate education. -
HighestEduLevel: string
Title:
Highest Education Level
Maximum Length:30
Highest education level in recruiting candidate education. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Major: string
Title:
Major
Maximum Length:240
Major in recruiting candidate education. -
Minor: string
Title:
Minor
Maximum Length:240
Minor in recruiting candidate education. -
PartTimeFlag: boolean
Title:
Part Time
Maximum Length:30
Part time indicator in recruiting candidate education. -
ProjectedCompletionDate: string
(date)
Title:
Projected Completion Date
Projected completion in recruiting candidate education. -
Reimbursements: string
(byte)
Title:
Reimbursement Arrangements
Reimbursements in recruiting candidate education. -
RequiredFlag: boolean
Title:
Required
Maximum Length:30
Required indicator in recruiting candidate education. -
SectionId: integer
(int64)
Section ID in recruiting candidate education.
-
StartDate: string
(date)
Title:
Start Date
Start date in recruiting candidate education. -
StateProvinceCode: string
Title:
State
Maximum Length:360
State province code in recruiting candidate education. -
StateProvinceId: integer
(int64)
Title:
State
State province ID in recruiting candidate education. -
Status: string
Title:
Status
Maximum Length:30
Status in recruiting candidate education. -
Title: string
Title:
Title
Maximum Length:240
Title in recruiting candidate education. -
TotalAmount: integer
(int64)
Title:
Total Amount
Total amount in recruiting candidate education. -
TrmnlDegDiscpFlag: boolean
Title:
Terminal Degree for Discipline
Maximum Length:30
Terminal degree discipline indicator indicating the last degree obtained in recruiting candidate education. -
TuitionMethod: string
Title:
Tuition Method
Maximum Length:30
Tuition method in recruiting candidate education. -
YearAcquired: integer
(int64)
Title:
Year Acquired
Year acquired in recruiting candidate education.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidates-experience-item-response
Type:
Show Source
object
-
Achievements: string
(byte)
Title:
Achievements
Achievements in recruiting candidate experience. -
AdditionalInformation: string
(byte)
Title:
Additional Information
Additional Information in recruiting candidate experience. -
BusinessType: string
Title:
Type of Business
Maximum Length:240
Business type in recruiting candidate experience. -
CompanyURL: string
Title:
Company URL
Maximum Length:2000
Company URL in recruiting candidate experience. -
ContactSupervisorFlag: boolean
Title:
OK to Contact Supervisor
Maximum Length:30
Contact supervisor indicator in the recruiting candidate experience. -
CountryCode: string
Title:
Employer Country
Maximum Length:30
Country code number in recruiting candidate experience. -
CurrentJobFlag: boolean
Title:
Current Job
Maximum Length:30
Current job indicator in recruiting candidate experience. -
Department: string
Title:
Department or Division or Post
Maximum Length:240
Department in recruiting candidate experience. -
DirectReports: integer
(int64)
Title:
Direct Reports
Direct reports in recruiting candidate experience. -
EmployerCity: string
Title:
Employer City
Maximum Length:240
Employer city in recruiting candidate experience. -
EmployerCountryId: integer
(int64)
Title:
Employer Country
Employer country ID in recruiting candidate experience. -
EmployerName: string
Title:
Employer Name
Maximum Length:240
Employer name in recruiting candidate experience. -
EmployerPhone: string
Title:
Employer Phone
Maximum Length:240
Employer phone in recruiting candidate experience. -
EmployerStateId: integer
(int64)
Title:
Employer State or Province
Employer state ID in recruiting candidate experience. -
EndCompensation: number
Title:
Ending Compensation
End compensation in recruiting candidate experience. -
EndDate: string
(date)
Title:
End Date
End date in recruiting candidate experience. -
ExperienceInYears: number
Read Only:
true
Experience in years in recruiting candidate experience. -
FullTimeCode: string
Title:
Part Time
Maximum Length:30
Full time code in recruiting candidate experience. -
InternalFlag: boolean
Title:
Internal
Maximum Length:30
Internal indicator in the recruiting candidate experience. -
JobFamilyId: integer
(int64)
Title:
Job Family
Job family ID in recruiting candidate experience. -
JobFunction: string
Title:
Job Function
Maximum Length:30
Job function in recruiting candidate experience. -
JobTitle: string
Title:
Job Title
Maximum Length:240
Job title in recruiting candidate experience. -
LeavingReason: string
(byte)
Title:
Reason for Leaving
Leaving reason in recruiting candidate experience. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OtherCompensation: string
Title:
Other Compensation
Maximum Length:240
Other compensation in recruiting candidate experience. -
OtherJobFunction: string
Title:
Other Job Function
Maximum Length:240
Other job function in recruiting candidate experience. -
PreviousEmploymentId: integer
(int64)
Previous employment ID in recruiting candidate experience.
-
Responsibilities: string
(byte)
Title:
Responsibilities
Responsibilities in recruiting candidate experience. -
SectionId: integer
(int64)
Section ID in recruiting candidate experience.
-
StartCompensation: number
Title:
Starting Compensation
Start compensation in recruiting candidate experience. -
StartDate: string
(date)
Title:
Start Date
Start date in recruiting candidate experience. -
StartingPosition: string
Title:
Starting Position
Maximum Length:240
Starting position in recruiting candidate experience. -
StateProvinceCode: string
Title:
Employer State or Province
Maximum Length:360
State province code in recruiting candidate experience. -
SupervisorEmail: string
Title:
Supervisor Email
Maximum Length:240
Supervisor email in recruiting candidate experience. -
SupervisorName: string
Title:
Supervisor Name
Maximum Length:240
Supervisor name in recruiting candidate experience. -
SupervisorPhone: string
Title:
Supervisor Phone
Maximum Length:240
Supervisor phone in recruiting candidate experience. -
SupervisorTitle: string
Title:
Supervisor Title
Maximum Length:240
Supervisor title in recruiting candidate experience.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidates-languages-item-response
Type:
Show Source
object
-
AbleToTeachFlag: boolean
Title:
Able to Teach
Maximum Length:30
Able to teach indicator in recruiting candidate languages. -
AbleToTranslateFlag: boolean
Title:
Able to Translate
Maximum Length:30
Able to translate indicator in recruiting candidate languages. -
Comments: string
(byte)
Title:
Comments
Comments in recruiting candidate languages. -
ContentItemId: integer
(int64)
Title:
Language
Content item ID in recruiting candidate languages. -
EvaluatedOn: string
(date)
Title:
Evaluated On
Evaluated on in recruiting candidate languages. -
EvaluationLocation: string
Title:
Evaluation Location
Maximum Length:240
Evaluation location in recruiting candidate languages. -
Language: string
Maximum Length:
240
Language in recruiting candidate languages. -
LanguageId: integer
(int64)
Language ID in recruiting candidate languages.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NativeSpeakerFlag: boolean
Title:
Native
Maximum Length:30
Native speaker indicator in recruiting candidate languages. -
ReadingLevelId: integer
(int64)
Title:
Reading
Reading level ID in recruiting candidate languages. -
ReadingModelId: integer
(int64)
Title:
Reading Rating Model
Reading model ID in recruiting candidate languages. -
SectionId: integer
(int64)
Section ID in recruiting candidate languages.
-
SpeakingLevelId: integer
(int64)
Title:
Speaking
Speaking level ID in recruiting candidate languages. -
SpeakingModelId: integer
(int64)
Title:
Speaking Rating Model
Speaking model ID in recruiting candidate languages. -
WritingLevelId: integer
(int64)
Title:
Writing
Writing level ID in recruiting candidate languages. -
WritingModelId: integer
(int64)
Title:
Writing Rating Model
Writing model ID in recruiting candidate languages.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidates-licensesAndCertificates-item-response
Type:
Show Source
object
-
ActualCompletionDate: string
(date)
Title:
Actual Completion Date
Actual completion date in recruiting candidate licenses and certificates. -
CertificationId: integer
(int64)
Certification ID in recruiting candidate licenses and certificates.
-
CertificationName: string
Title:
License or Certificate
Maximum Length:240
Certification name in recruiting candidate licenses and certificates. -
CertificationNumber: string
Title:
Certificate Number
Maximum Length:240
Certification number in recruiting candidate licenses and certificates. -
CertificationURL: string
Title:
Certification URL
Maximum Length:2000
Certification URL in recruiting candidate licenses and certificates. -
Comments: string
(byte)
Title:
Comments
Comments in recruiting candidate licenses and certificates. -
CompletedAmount: integer
(int64)
Title:
Completed Amount
Completed amount in recruiting candidate licenses and certificates. -
CompletedTrainingUnits: string
Title:
Training Completed Units
Maximum Length:240
Completed training units in recruiting candidate licenses and certificates. -
ContentItemId: integer
(int64)
Title:
License or Certificate
Content item ID in recruiting candidate licenses and certificates. -
CountryCode: string
Title:
Country
Maximum Length:30
Country code number in recruiting candidate licenses and certificates. -
CountryId: integer
(int64)
Title:
Country
Country ID in recruiting candidate licenses and certificates. -
EducationalEstablishment: string
Title:
Educational Establishment
Maximum Length:2000
Educational establishment in recruiting candidate licenses and certificates. -
EducationalEstablishmentId: integer
(int64)
Title:
Establishment
Educational establishment ID in recruiting candidate licenses and certificates. -
ExpirationDate: string
(date)
Title:
Expiration Date
Expiration date in recruiting candidate licenses and certificates. -
IssueDate: string
(date)
Title:
Issue Date
Issue date in recruiting candidate licenses and certificates. -
IssuedBy: string
Title:
Issued By
Maximum Length:240
Issued using in recruiting candidate licenses and certificates. -
LastRenewalDate: string
(date)
Title:
Last Renewal Date
Last renewal date in recruiting candidate licenses and certificates. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalIssueYear: integer
(int64)
Title:
Original Issue Year
Original issue year in recruiting candidate licenses and certificates. -
RenewalDate: string
(date)
Title:
Renewal Date
Renewal date in recruiting candidate licenses and certificates. -
RenewalInprogressFlag: boolean
Title:
Renewal In Progress
Maximum Length:30
Renewal in progress indicator in recruiting candidate licenses and certificates. -
RenewalRequiredFlag: boolean
Title:
Renewal Required
Maximum Length:30
Renewal required indicator in recruiting candidate licenses and certificates. -
Restrictions: string
(byte)
Title:
Restrictions
Restrictions in recruiting candidate licenses and certificates. -
SectionId: integer
(int64)
Section ID in recruiting candidate licenses and certificates.
-
StateProvinceCode: string
Title:
State
Maximum Length:360
State province code in recruiting candidate licenses and certificates. -
StateProvinceId: integer
(int64)
Title:
State
State province ID in recruiting candidate licenses and certificates. -
Status: string
Title:
Status
Maximum Length:30
Status in recruiting candidate licenses and certificates. -
Title: string
Title:
Title
Maximum Length:240
Title in recruiting candidate licenses and certificates. -
TotalAmount: integer
(int64)
Title:
Total Amount
Total amount in recruiting candidate licenses and certificates. -
VerifiedFlag: boolean
Title:
Verified
Maximum Length:30
Verified indicator in recruiting candidate licenses and certificates.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidates-skills-item-response
Type:
Show Source
object
-
Comments: string
(byte)
Title:
Comments
Comments in recruiting candidate skills. -
DateAchieved: string
(date)
Title:
Date Achieved
Date when the skills were achieved in recruiting candidate skills. -
Description: string
(byte)
Title:
Description
Description of recruiting candidate skills. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectName: string
Title:
Project Name or Activities
Maximum Length:2000
Project name or activities in recruiting candidate skills. -
SectionId: integer
(int64)
Section ID in recruiting candidate skills.
-
Skill: string
Title:
Skill
Maximum Length:240
Skills described in recruiting candidate skills. -
SkillId: integer
(int64)
ID assigned to each skill described in recruiting candidate skills.
-
Speciality: string
Title:
Skill Type
Maximum Length:30
Specialty or skill type in recruiting candidate skills. -
YearsOfExperience: integer
(int64)
Title:
Years of Experience
Years of experience in recruiting candidate skills.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidates-workPreferences-item-response
Type:
Show Source
object
-
AllLocationsFlag: boolean
Title:
All Locations
Maximum Length:30
All locations preferred indicator in recruiting candidate work preferences. -
Comments: string
(byte)
Title:
Comments
Comments in recruiting candidate work preferences. -
ContentItemId: integer
(int64)
Content item ID in recruiting candidate work preferences.
-
CurrencyCode: string
Title:
Currency Code
Maximum Length:30
Currency code in recruiting candidate work preferences. -
DateFrom: string
(date)
Date from in recruiting candidate work preferences.
-
DateTo: string
(date)
Date to in recruiting candidate work preferences.
-
ExcludedLocationFourId: integer
(int64)
Title:
Fourth Excluded Location
Excluded location four ID in recruiting candidate work preferences. -
ExcludedLocationOneId: integer
(int64)
Title:
First Excluded Location
Excluded location one ID in recruiting candidate work preferences. -
ExcludedLocationThreeId: integer
(int64)
Title:
Third Excluded Location
Excluded location three ID in recruiting candidate work preferences. -
ExcludedLocationTwoId: integer
(int64)
Title:
Second Excluded Location
Excluded location two ID in recruiting candidate work preferences. -
FlexibleWorkFlag: boolean
Title:
Work a Flexible Schedule
Maximum Length:30
Flexible work required indicator in recruiting candidate work preferences. -
FullTimeEquivalent: number
Title:
Full Time Equivalent
Full time equivalent in recruiting candidate work preferences. -
IntlTravelFlag: boolean
Title:
Travel Internationally
Maximum Length:30
International travel required indicator in recruiting candidate work preferences. -
IntlTravelFrequency: string
Title:
International Travel Frequency
Maximum Length:30
International travel frequency in recruiting candidate work preferences. -
IntlTravelRequiredFlag: boolean
Title:
International Travel Required
Maximum Length:30
International travel required indicator in the recruiting candidate work preferences. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumPay: integer
(int64)
Title:
Minimum Pay
Minimum pay in recruiting candidate work preferences. -
NatTravelFlag: boolean
Title:
Travel Domestically
Maximum Length:30
Domestic travel required indicator in the recruiting candidate work preferences. -
NatTravelFrequency: string
Title:
Domestic Travel Frequency
Maximum Length:30
National travel frequency in recruiting candidate work preferences. -
NatTravelRequiredFlag: boolean
Title:
Travel Required
Maximum Length:30
Domestic travel required indicator in recruiting candidate work preferences. -
PartAssignFlag: boolean
Title:
Consider Part Time Work
Maximum Length:30
Part assign indicator in the recruiting candidate work preferences. -
PayFrequency: string
Title:
Pay Frequency
Maximum Length:30
Pay frequency in recruiting candidate work preferences. -
PayRange: string
Title:
Pay Range
Maximum Length:30
Pay range in recruiting candidate work preferences. -
PreferredLocationFourId: integer
(int64)
Title:
Fourth Preferred Location
Preferred location four ID in recruiting candidate work preferences. -
PreferredLocationOneId: integer
(int64)
Title:
First Preferred Location
Preferred location one ID in recruiting candidate work preferences. -
PreferredLocationThreeId: integer
(int64)
Title:
Third Preferred Location
Preferred location three ID in recruiting candidate work preferences. -
PreferredLocationTwoId: integer
(int64)
Title:
Second Preferred Location
Preferred location two ID in recruiting candidate work preferences. -
RelocateDuration: integer
(int64)
Title:
Length of Willing to Relocate
Relocate duration in recruiting candidate work preferences. -
RelocateFlag: boolean
Title:
Willing to Relocate
Maximum Length:30
Relocate indicator in the recruiting candidate work preferences. -
RelocationReason: string
Title:
Relocation Reason
Maximum Length:240
Relocation reason in recruiting candidate work preferences. -
SectionId: integer
(int64)
Section ID in recruiting candidate work preferences.
-
TempAssignFlag: boolean
Title:
Consider Temporary Assignment
Maximum Length:30
Temp assign indicator in recruiting candidate work preferences. -
WorkDays: string
Title:
Workdays
Maximum Length:30
Workdays in recruiting candidate work preferences. -
WorkHours: string
Title:
Work Hours
Maximum Length:30
Work hours in recruiting candidate work preferences. -
WorkMonths: integer
(int64)
Title:
Work Duration Months
Work months in recruiting candidate work preferences. -
WorkPreferenceId: integer
(int64)
Work preference ID in recruiting candidate work preferences.
-
WorkYears: integer
(int64)
Title:
Work Duration Years
Work years in recruiting candidate work preferences.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- attachments
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachmentsParameters:
- CandidateNumber:
$request.path.CandidateNumber
The attachments resource is a child of the recruitingCandidates resource and provides details about attachments provided by the candidate. - CandidateNumber:
- candidateAddress
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddressParameters:
- CandidateNumber:
$request.path.CandidateNumber
The candidateAddress resource is a child of the recruitingCandidates resource and provides details about the address of the candidate. - CandidateNumber:
- candidatePhones
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhonesParameters:
- CandidateNumber:
$request.path.CandidateNumber
The candidatePhones resource is a child of the recruitingCandidates resource and provides details about the phone numbers of the candidate. - CandidateNumber:
- education
-
Parameters:
- CandidateNumber:
$request.path.CandidateNumber
The education resource is a child of the recruitingCandidates resource and provides details about the education of the candidate. - CandidateNumber:
- experience
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experienceParameters:
- CandidateNumber:
$request.path.CandidateNumber
The experience resource is a child of the recruitingCandidates resource and provides details about the work experience of the candidate. - CandidateNumber:
- languages
-
Parameters:
- CandidateNumber:
$request.path.CandidateNumber
The languages resource is a child of the recruitingCandidates resource and provides details about the languages of the candidate. - CandidateNumber:
- licensesAndCertificates
-
Parameters:
- CandidateNumber:
$request.path.CandidateNumber
The licensesAndCertificates resource is a child of the recruitingCandidates resource and provides details about the licenses and certificates of the candidate. - CandidateNumber:
- skills
-
Parameters:
- CandidateNumber:
$request.path.CandidateNumber
The skills resource is a child of the recruitingCandidates resource and provides details about the skills of the candidate. - CandidateNumber:
- workPreferences
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferencesParameters:
- CandidateNumber:
$request.path.CandidateNumber
The workPreferences resource is a child of the recruitingCandidates resource and provides details about the work preferences of the candidate. - CandidateNumber:
Examples
The following example shows how to view a candidate by submitting a singular GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X GET http://host:port/hcmRestApi/resources/11.13.18.05/recruitingCandidates/92734
Example of Response Header
The following is an example of the response header.
HTTP/1.1 200 OK Content-Type : application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "CandidateNumber" : "92734", "PreferredLanguage" : null, "LastName" : "Mathew", "MiddleNames" : null, "FirstName" : "TAXREGEMP", "Title" : null, "Suffix" : null, "PreNameAdjunct" : null, "KnownAs" : null, "PreviousLastName" : null, "Honors" : null, "MilitaryRank" : null, "FullName" : "Mathew, TAXREGEMP", "DisplayName" : "TAXREGEMP Mathew", "ListName" : "Mathew, TAXREGEMP", "Email" : null, "CampaignOptIn" : null, "SourceMedium" : null, "SourceName" : null, "CandidateType" : "ORA_INTERNAL_CANDIDATE", "PersonId" : 100100055309271, "CreatedBy" : "ZFRCE1301_Duscha", "CreationDate" : "2017-07-26T14:47:35.049+00:00", "LastUpdatedBy" : "ZFRCE1301_Duscha", "LastUpdateDate" : "2017-07-26T14:47:35.057+00:00", "links": [...] }