Get all candidates
get
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds all candidates using a unique ID.
Finder Variables- CandidateNumber; string; Candidate number used to find a candidate.
- PrimaryKey Finds all candidates using a unique ID.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AdditionalSourceInformation; string; Additional source tracking information of a candidate.
- LastName; string; Last name of the candidate.
- PreferredTimezone; string; Preferred time zone of the candidate.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : recruitingJobSiteCandidates
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-item-response
Type:
Show Source
object-
AdditionalSourceInformation: string
Additional source tracking information of a candidate.
-
addresses: array
Addresses of the Candidates
Title:
Addresses of the CandidatesThe addresses resource is a child of the recruitingJobSiteCandidates resource. It provides details about the addresses of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
attachments: array
Attachments of the Candidates
Title:
Attachments of the CandidatesThe attachments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the documents attached by the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
candidateExtraInformation: array
Extra Information of the Candidates
Title:
Extra Information of the CandidatesThe candidateExtraInformation resource is a child of the recruitingJobSiteCandidates resource. It provides extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
CandidateNumber: string
Read Only:
trueMaximum Length:255Candidate number of the candidate. -
CandidateType: string
Read Only:
trueCandidate type of the candidate. -
certifications: array
Certifications of the Candidates
Title:
Certifications of the CandidatesThe certifications resource is a child of the recruitingJobSiteCandidates resource. It provides details about the certifications of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
CreatedBy: string
Person who created the candidate.
-
CreationDate: string
(date-time)
Creation date of the candidate.
-
DateOfBirth: string
(date)
Date of birth of the candidate.
-
DeletionQualifier: string
Read Only:
trueMaximum Length:255Deletion qualifier of the candidate. -
educations: array
Education of the Candidates
Title:
Education of the CandidatesThe educations resource is a child of the recruitingJobSiteCandidates resource. It provides details about the education of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
Email: string
Maximum Length:
240Email of the candidate. -
FirstName: string
Maximum Length:
150First name of the candidate. -
Honors: string
Maximum Length:
80Honors of the candidate. -
KnownAs: string
Maximum Length:
80Known as attribute of the candidate. -
languages: array
Languages of the Candidates
Title:
Languages of the CandidatesThe languages resource is a child of the recruitingJobSiteCandidates resource. It provides details about the languages of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
LastName: string
Maximum Length:
150Last name of the candidate. -
LastUpdateDate: string
(date-time)
Last update date of the candidate.
-
LastUpdatedBy: string
Person who last updated the candidate.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MiddleNames: string
Maximum Length:
80Middle names of the candidate. -
MilitaryRank: string
Maximum Length:
80Military rank of the candidate. -
nationalIdentifiers: array
National Identifiers of the Candidates
Title:
National Identifiers of the CandidatesThe nationalIdentifiers resource is a child of the recruitingJobSiteCandidates resource. It provides details about the national identifiers of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
ObjectStatus: string
Read Only:
trueMaximum Length:255Object status of the candidate. -
phones: array
Phone Numbers of the Candidates
Title:
Phone Numbers of the CandidatesThe phones resource is a child of the recruitingJobSiteCandidates resource. It provides details about the phone numbers of candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
PreferredLanguage: string
Maximum Length:
4Preferred language of the candidate. -
PreferredTimezone: string
Maximum Length:
255Preferred time zone of the candidate. -
PreNameAdjunct: string
Maximum Length:
150Previous name adjunct of the candidate. -
previousEmployments: array
Previous Employments of the Candidates
Title:
Previous Employments of the CandidatesThe previousEmployments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work experience of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
PreviousLastName: string
Maximum Length:
150Previous last name of the candidate. -
skills: array
Skills of the Candidates
Title:
Skills of the CandidatesThe skills resource is a child of the recruitingJobSiteCandidates resource. It provides details about the skills of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
SourceMedium: string
Read Only:
trueMaximum Length:32Source medium of the candidate. -
SourceName: string
Read Only:
trueMaximum Length:2000Source name of the candidate. -
Suffix: string
Maximum Length:
80Suffix of the candidate. -
Title: string
Maximum Length:
30Title of the candidate. -
workPreferences: array
Work Preferences of the Candidates
Title:
Work Preferences of the CandidatesThe workPreferences resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work preferences of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Nested Schema : Addresses of the Candidates
Type:
arrayTitle:
Addresses of the CandidatesThe addresses resource is a child of the recruitingJobSiteCandidates resource. It provides details about the addresses of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Attachments of the Candidates
Type:
arrayTitle:
Attachments of the CandidatesThe attachments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the documents attached by the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Extra Information of the Candidates
Type:
arrayTitle:
Extra Information of the CandidatesThe candidateExtraInformation resource is a child of the recruitingJobSiteCandidates resource. It provides extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Certifications of the Candidates
Type:
arrayTitle:
Certifications of the CandidatesThe certifications resource is a child of the recruitingJobSiteCandidates resource. It provides details about the certifications of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Education of the Candidates
Type:
arrayTitle:
Education of the CandidatesThe educations resource is a child of the recruitingJobSiteCandidates resource. It provides details about the education of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Languages of the Candidates
Type:
arrayTitle:
Languages of the CandidatesThe languages resource is a child of the recruitingJobSiteCandidates resource. It provides details about the languages of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : National Identifiers of the Candidates
Type:
arrayTitle:
National Identifiers of the CandidatesThe nationalIdentifiers resource is a child of the recruitingJobSiteCandidates resource. It provides details about the national identifiers of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Phone Numbers of the Candidates
Type:
arrayTitle:
Phone Numbers of the CandidatesThe phones resource is a child of the recruitingJobSiteCandidates resource. It provides details about the phone numbers of candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Previous Employments of the Candidates
Type:
arrayTitle:
Previous Employments of the CandidatesThe previousEmployments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work experience of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Skills of the Candidates
Type:
arrayTitle:
Skills of the CandidatesThe skills resource is a child of the recruitingJobSiteCandidates resource. It provides details about the skills of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Work Preferences of the Candidates
Type:
arrayTitle:
Work Preferences of the CandidatesThe workPreferences resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work preferences of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : recruitingJobSiteCandidates-addresses-item-response
Type:
Show Source
object-
AddlAddressAttribute1: string
Maximum Length:
150Additional address attribute 1 of the candidate address. -
AddlAddressAttribute2: string
Maximum Length:
150Additional address attribute 2 of the candidate address. -
AddlAddressAttribute3: string
Maximum Length:
150Additional address attribute 3 of the candidate address. -
AddlAddressAttribute4: string
Maximum Length:
150Additional address attribute 4 of the candidate address. -
AddlAddressAttribute5: string
Maximum Length:
150Additional address attribute 5 of the candidate address. -
AddressId: string
Read Only:
trueIdentifier of the candidate address. -
AddressLine1: string
Maximum Length:
240Address line 1 of the candidates address. -
AddressLine2: string
Maximum Length:
240Address line 2 of the candidates address. -
AddressLine3: string
Maximum Length:
240Address line 3 of the candidates address. -
Building: string
Maximum Length:
240Building of the candidate address. -
City: string
Maximum Length:
60City of the candidate address. -
Country: string
Maximum Length:
60Country of the candidate address. -
CreatedBy: string
Read Only:
truePerson who created the candidate address. -
CreationDate: string
(date-time)
Read Only:
trueCreation date of the candidate address. -
FloorNumber: string
Maximum Length:
40Floor number of the candidate address. -
LastUpdateDate: string
(date-time)
Read Only:
trueLast update date of the candidate address. -
LastUpdatedBy: string
Read Only:
truePerson who last updated the candidate address. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LongPostalCode: string
Maximum Length:
30Long postal code of the candidate address. -
PostalCode: string
Maximum Length:
30Postal code of the candidate address. -
Region1: string
Maximum Length:
120Region 1 of the candidate address. -
Region2: string
Maximum Length:
120Region 2 of the candidate address. -
Region3: string
Maximum Length:
120Region 3 of the candidate address.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : recruitingJobSiteCandidates-attachments-item-response
Type:
Show Source
object-
Attachment: string
Information of the candidate attachment.
-
CandidateNumber: string
Candidate number of the candidate attachment.
-
Category: string
Maximum Length:
30Category of the candidate attachment. -
Description: string
Maximum Length:
255Description of the candidate attachment. -
FileContents: string
File contents of the candidate attachment.
-
Id: string
Maximum Length:
255Identifier of the candidate attachment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MimeType: string
Mime type of the candidate attachment.
-
SourceAttachmentId: integer
Source attachment identifier of the candidate attachment.
-
Title: string
Maximum Length:
80Title of the candidate attachment. -
Type: string
Type of the candidate attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-candidateExtraInformation-item-response
Type:
Show Source
object-
CandidateNumber: string
Maximum Length:
255Candidate number of the candidate extra information. -
ContextCode: string
Maximum Length:
255Context code of the candidate extra information. -
ContextLink: string
Maximum Length:
255Context link of the candidate extra information. -
DataId: integer
Data identifier of the candidate extra information.
-
dataRows: array
Extra Information Rows of the Candidates
Title:
Extra Information Rows of the CandidatesThe dataRows resource is a child of the recruitingJobSiteCandidates resource. It provides rows containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Extra Information Rows of the Candidates
Type:
arrayTitle:
Extra Information Rows of the CandidatesThe dataRows resource is a child of the recruitingJobSiteCandidates resource. It provides rows containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-candidateExtraInformation-dataRows-item-response
Type:
Show Source
object-
attributes: array
Extra Information Attributes of the Candidates
Title:
Extra Information Attributes of the CandidatesThe attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
ContextRowId: string
Maximum Length:
255Context row identifier of the candidate extra information data rows. -
ContextRowLink: string
Maximum Length:
255Context row link of the candidate extra information data rows. -
DataId: integer
Data identifier of the candidate extra information data rows.
-
DataRowId: integer
Data row identifier of the candidate extra information data rows.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RowAction: string
Maximum Length:
255Row action that needs to be performed on the candidate extra information data rows.
Nested Schema : Extra Information Attributes of the Candidates
Type:
arrayTitle:
Extra Information Attributes of the CandidatesThe attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-candidateExtraInformation-dataRows-attributes-item-response
Type:
Show Source
object-
AttributeId: integer
Attribute identifier of the candidate extra information data row attribute.
-
DataRowId: integer
Data row identifier of the candidate extra information data row attribute.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Name of the candidate extra information data row attribute.
-
Value: string
Value of the candidate extra information data row attribute.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-certifications-item-response
Type:
Show Source
object-
ActualCompletionDate: string
(date)
Title:
Actual Completion DateActual completion date of the candidate certification. -
CertificationId: integer
(int64)
Identifier of the candidate certification.
-
CertificationName: string
Title:
License or CertificateMaximum Length:240Certification name of the candidate certification. -
CertificationNumber: string
Title:
Certificate NumberMaximum Length:240Certification number of the candidate certification. -
CertificationURL: string
Title:
Certification URLMaximum Length:2000Certification URL of the candidate certification. -
Comments: string
(byte)
Title:
CommentsComments about the candidate certification. -
CompletedAmount: integer
(int64)
Title:
Completed AmountCompleted amount of the candidate certification. -
CompletedTrainingUnits: string
Title:
Training Completed UnitsMaximum Length:240Completed training units of the candidate certification. -
ContentItemId: integer
(int64)
Title:
License or CertificateContent item identifier of the candidate certification. -
CountryCode: string
Title:
CountryMaximum Length:30Country code of the candidate certification. -
EducationalEstablishment: string
Title:
Educational EstablishmentMaximum Length:2000Educational establishment of the candidate certification. -
EducationalEstablishmentId: integer
(int64)
Title:
EstablishmentEducational establishment identifier of the candidate certification. -
ExpirationDate: string
(date)
Title:
Expiration DateExpiration date of the candidate certification. -
IssueDate: string
(date)
Title:
Issue DateIssue date of the candidate certification. -
IssuedBy: string
Title:
Issued ByMaximum Length:240Entity who issued the candidate certification. -
LastRenewalDate: string
(date)
Title:
Last Renewal DateLast renewal date of the candidate certification. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OriginalIssueYear: integer
(int64)
Title:
Original Issue YearOriginal issue year of the candidate certification. -
RenewalDate: string
(date)
Title:
Renewal DateRenewal date of the candidate certification. -
RenewalInprogressFlag: boolean
Title:
Renewal In ProgressMaximum Length:30Indicates the renewal in progress indicator of the candidate certification. -
RenewalRequiredFlag: boolean
Title:
Renewal RequiredMaximum Length:30Indicates whether the renewal indicator is required in the candidate certification. -
Restrictions: string
(byte)
Title:
RestrictionsRestrictions of the candidate certification. -
SectionId: integer
(int64)
Section identifier of the candidate certification.
-
StateProvinceCode: string
Title:
StateMaximum Length:360State province code of the candidate certification. -
Status: string
Title:
StatusMaximum Length:30Status of the candidate certification. -
Title: string
Title:
TitleMaximum Length:240Title of the candidate certification. -
TotalAmount: integer
(int64)
Title:
Total AmountTotal amount of the candidate certification. -
VerifiedFlag: boolean
Title:
VerifiedMaximum Length:30Indicates the verified indicator of the candidate education.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-educations-item-response
Type:
Show Source
object-
AcademicStanding: string
Title:
Academic StandingMaximum Length:30Academic standing of the candidate education. -
ActivitySummary: string
(byte)
Title:
Summary of ActivitiesActivity summary of the candidate education. -
AreaOfStudy: string
Title:
Area of StudyMaximum Length:240Area of study of the candidate education. -
AverageGrade: string
Title:
Average GradeMaximum Length:240Average grade of the candidate education. -
AwardingBody: string
Title:
Awarding BodyMaximum Length:240Awarding body of the candidate education. -
City: string
Title:
CityMaximum Length:240CIty of the candidate education. -
Comments: string
(byte)
Title:
CommentsComments of the candidate education. -
CompletedAmount: integer
(int64)
Title:
Completed AmountCompleted amount of the candidate education. -
CompletedTraningUnits: string
Title:
Training Completed UnitsMaximum Length:240Completed training units of the candidate education. -
ContentItemId: integer
(int64)
Title:
DegreeContent item identifier of the candidate education. -
CountryCode: string
Title:
CountryMaximum Length:30Country code of the candidate education. -
DateAcquired: string
(date)
Title:
Date AcquiredDate acquired of the candidate education. -
DegreeName: string
Title:
DegreeMaximum Length:240Degree name of the candidate education. -
Department: string
Title:
Faculty or DepartmentMaximum Length:240Department of the candidate education. -
Description: string
(byte)
Title:
DescriptionDescription of the candidate education. -
Duration: string
Title:
DurationMaximum Length:240Duration of the candidate education. -
DurationUnits: string
Title:
Duration UnitsMaximum Length:30Duration units of the candidate education. -
EducationalEstablishment: string
Title:
School NameMaximum Length:2000Educational establishment of the candidate education. -
EducationalEstablishmentId: integer
(int64)
Title:
SchoolEducational establishment identifier of the candidate education. -
EducationId: integer
(int64)
Education identifier of the candidate education.
-
EducationLevel: string
Title:
Education LevelMaximum Length:30Education level of the candidate education. -
EducationURL: string
Title:
Education URLMaximum Length:2000Education URL of the candidate education. -
Educator: string
Title:
EducatorMaximum Length:240Educator of the candidate education. -
EduLevelCompletedFlag: boolean
Title:
Education Level CompletedMaximum Length:30Education level completed indicator of the candidate education. -
EndDate: string
(date)
Title:
End DateEnd date of the candidate education. -
Fee: integer
(int64)
Title:
FeeFee of the candidate education. -
FeeCurrency: string
Title:
Fee CurrencyMaximum Length:30Fee currency of the candidate education. -
GPA: number
Title:
GPAGPA of the candidate education. -
GraduatedFlag: boolean
Title:
GraduatedMaximum Length:30Graduated indicator of the candidate education. -
HighestEduLevel: string
Title:
Highest Education LevelMaximum Length:30Highest education level of the candidate education. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Major: string
Title:
MajorMaximum Length:240Major of the candidate education. -
Minor: string
Title:
MinorMaximum Length:240Minor of the candidate education. -
PartTimeFlag: boolean
Title:
Part TimeMaximum Length:30Part time indicator of the candidate education. -
ProjectedCompletionDate: string
(date)
Title:
Projected Completion DateProjected completion date of the candidate education. -
Reimbursements: string
(byte)
Title:
Reimbursement ArrangementsReimbursements of the candidate education. -
RequiredFlag: boolean
Title:
RequiredMaximum Length:30Indicates whether the education is required in the candidate education. -
SectionId: integer
(int64)
Section identifier of the candidate education.
-
StartDate: string
(date)
Title:
Start DateStart date of the candidate education. -
StateProvinceCode: string
Title:
StateMaximum Length:360State province code of the candidate education. -
Status: string
Title:
StatusMaximum Length:30Status of the candidate education. -
Title: string
Title:
TitleMaximum Length:240Title of the candidate education. -
TotalAmount: integer
(int64)
Title:
Total AmountTotal amount of the candidate education. -
TrmnlDegDiscpFlag: boolean
Title:
Terminal Degree for DisciplineMaximum Length:30Terminal degree discipline indicator of the candidate education. -
TuitionMethod: string
Title:
Tuition MethodMaximum Length:30Tuition method of the candidate education. -
YearAcquired: integer
(int64)
Title:
Year AcquiredYear acquired of the candidate education.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-languages-item-response
Type:
Show Source
object-
AbleToTeachFlag: boolean
Title:
Able to TeachMaximum Length:30Indicates whether the candidate can teach in the candidate language. -
AbleToTranslateFlag: boolean
Title:
Able to TranslateMaximum Length:30Indicates whether the candidate can translate in the candidate language. -
Comments: string
(byte)
Title:
CommentsComments in candidate language. -
ContentItemId: integer
(int64)
Title:
LanguageContent item identifier in candidate language. -
EvaluatedOn: string
(date)
Title:
Evaluated OnEvaluated on in candidate language. -
EvaluationLocation: string
Title:
Evaluation LocationMaximum Length:240Evaluation location in candidate language. -
Language: string
Maximum Length:
240Language in candidate language. -
LanguageId: integer
(int64)
Language identifier in candidate language.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NativeSpeakerFlag: boolean
Title:
NativeMaximum Length:30Indicates whether the candidate is a native speaker in the candidate language. -
ReadingLevelId: integer
(int64)
Title:
ReadingReading level identifier in candidate language. -
ReadingModelId: integer
(int64)
Title:
Reading Rating ModelReading model identifier in candidate language. -
SectionId: integer
(int64)
Section identifier in candidate language.
-
SpeakingLevelId: integer
(int64)
Title:
SpeakingSpeaking level identifier in candidate language. -
SpeakingModelId: integer
(int64)
Title:
Speaking Rating ModelSpeaking model identifier in candidate language. -
WritingLevelId: integer
(int64)
Title:
WritingWriting level identifier in candidate language. -
WritingModelId: integer
(int64)
Title:
Writing Rating ModelWriting model identifier in candidate language.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-nationalIdentifiers-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64Person who created the candidate national identifier. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueCreation date of the candidate national identifier. -
ExpirationDate: string
(date)
Title:
Expiration DateExpiration date of the candidate national identifier. -
IssueDate: string
(date)
Title:
Issue DateIssue date of the candidate national identifier. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueLast update date of the candidate national identifier. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64Person who last updated the candidate national identifier. -
LegislationCode: string
Title:
CountryMaximum Length:30Legislation code of the candidate national identifier. -
LegislationName: string
Title:
CountryRead Only:trueMaximum Length:80Legislation name of the candidate national identifier. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NationalIdentifierId: integer
(int64)
Title:
National Identifier IDRead Only:trueNational identifier ID of the candidate national identifier. -
NationalIdentifierNumber: string
Title:
National IDMaximum Length:30National identifier number of the candidate national identifier. -
NationalIdentifierType: string
Title:
National ID TypeMaximum Length:30National identifier type of the candidate national identifier. -
NationalIdentifierTypeMeaning: string
Title:
National ID TypeRead Only:trueMaximum Length:80National identifier type meaning of the candidate national identifier. -
PlaceOfIssue: string
Title:
Place of IssueMaximum Length:30Place of issue of the candidate national identifier.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-phones-item-response
Type:
Show Source
object-
AreaCode: string
Maximum Length:
30Area code of the candidate phone. -
CountryCodeNumber: string
Maximum Length:
30Country code number of the candidate phone. -
CreatedBy: string
Person who created the candidate phone.
-
CreationDate: string
(date-time)
Creation date of the candidate phone.
-
LastUpdateDate: string
(date-time)
Last update date of the candidate phone.
-
LastUpdatedBy: string
Last updated by of the candidate phone.
-
LegislationCode: string
Maximum Length:
4Legislation code of the candidate phone. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PhoneId: string
Phone identifier of the candidate phone.
-
PhoneNumber: string
Maximum Length:
60Phone number of the candidate phone.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-previousEmployments-item-response
Type:
Show Source
object-
Achievements: string
(byte)
Title:
AchievementsAchievements of the candidate previous employment. -
AdditionalInformation: string
(byte)
Title:
Additional InformationAdditional Information of the candidate previous employment. -
BusinessType: string
Title:
Type of BusinessMaximum Length:240Business type of the candidate previous employment. -
CompanyURL: string
Title:
Company URLMaximum Length:2000Company URL of the candidate previous employment. -
ContactSupervisorFlag: boolean
Title:
OK to Contact SupervisorMaximum Length:30Contact supervisor indicator in the candidate experience. -
CountryCode: string
Title:
Employer CountryMaximum Length:30Country code number of the candidate previous employment. -
CurrentJobFlag: boolean
Title:
Current JobMaximum Length:30Indicates whether the job is the current job of the candidate in the previous employment. -
Department: string
Title:
Department or Division or PostMaximum Length:240Department of the candidate previous employment. -
DirectReports: integer
(int64)
Title:
Direct ReportsDirect reports of the candidate previous employment. -
EmployerCity: string
Title:
Employer CityMaximum Length:240Employer city of the candidate previous employment. -
EmployerName: string
Title:
Employer NameMaximum Length:240Employer name of the candidate previous employment. -
EmployerPhone: string
Title:
Employer PhoneMaximum Length:240Employer phone of the candidate previous employment. -
EndCompensation: number
Title:
Ending CompensationEnd compensation of the candidate previous employment. -
EndDate: string
(date)
Title:
End DateEnd date of the candidate previous employment. -
ExperienceInYears: number
Read Only:
trueExperience in years of the candidate previous employment. -
FullTimeCode: string
Title:
Part TimeMaximum Length:30Full time code of the candidate previous employment. -
InternalFlag: boolean
Title:
InternalMaximum Length:30Indicates whether the job is internal in the candidate previous employment. -
JobFamilyId: integer
(int64)
Title:
Job FamilyJob family identifier of the candidate previous employment. -
JobFunction: string
Title:
Job FunctionMaximum Length:30Job function of the candidate previous employment. -
JobTitle: string
Title:
Job TitleMaximum Length:240Job title of the candidate previous employment. -
LeavingReason: string
(byte)
Title:
Reason for LeavingLeaving reason of the candidate previous employment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OtherCompensation: string
Title:
Other CompensationMaximum Length:240Other compensation of the candidate previous employment. -
OtherJobFunction: string
Title:
Other Job FunctionMaximum Length:240Other job function of the candidate previous employment. -
PreviousEmploymentId: integer
(int64)
Previous employment identifier of the candidate previous employment.
-
Responsibilities: string
(byte)
Title:
ResponsibilitiesResponsibilities of the candidate previous employment. -
SectionId: integer
(int64)
Section identifier of the candidate previous employment.
-
StartCompensation: number
Title:
Starting CompensationStart compensation of the candidate previous employment. -
StartDate: string
(date)
Title:
Start DateStart date of the candidate previous employment. -
StartingPosition: string
Title:
Starting PositionMaximum Length:240Starting position of the candidate previous employment. -
StateProvinceCode: string
Title:
Employer State or ProvinceMaximum Length:360State province code of the candidate previous employment. -
SupervisorEmail: string
Title:
Supervisor EmailMaximum Length:240Supervisor email of the candidate previous employment. -
SupervisorName: string
Title:
Supervisor NameMaximum Length:240Supervisor name of the candidate previous employment. -
SupervisorPhone: string
Title:
Supervisor PhoneMaximum Length:240Supervisor phone of the candidate previous employment. -
SupervisorTitle: string
Title:
Supervisor TitleMaximum Length:240Supervisor title of the candidate previous employment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-skills-item-response
Type:
Show Source
object-
Comments: string
(byte)
Title:
CommentsComments of a candidate skill. -
DateAchieved: string
(date)
Title:
Date AchievedDate when the candidate skill was achieved. -
Description: string
(byte)
Title:
DescriptionDescription of a candidate skill. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProjectName: string
Title:
Project Name or ActivitiesMaximum Length:2000Project name of a candidate skill. -
SectionId: integer
(int64)
Section identifier of the candidate skills.
-
Skill: string
Title:
SkillMaximum Length:240Description of a candidate skill. -
SkillId: integer
(int64)
Identifier of a candidate skill.
-
Speciality: string
Title:
Skill TypeMaximum Length:30Specialty or skill type of a candidate skill. -
YearsOfExperience: integer
(int64)
Title:
Years of ExperienceYears of experience of a candidate skill.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-workPreferences-item-response
Type:
Show Source
object-
AllLocationsFlag: boolean
Title:
All LocationsMaximum Length:30Indicates whether all locations are included in the candidate work preferences. -
Comments: string
(byte)
Title:
CommentsComments of the candidate work preferences. -
ContentItemId: integer
(int64)
Content item identifier of the candidate work preferences.
-
CurrencyCode: string
Title:
Currency CodeMaximum Length:30Currency code of the candidate work preferences. -
DateFrom: string
(date)
Date from of the candidate work preferences.
-
DateTo: string
(date)
Date to of the candidate work preferences.
-
ExcludedLocationFourId: integer
(int64)
Title:
Fourth Excluded LocationExcluded location four identifier of the candidate work preferences. -
ExcludedLocationOneId: integer
(int64)
Title:
First Excluded LocationExcluded location one identifier of the candidate work preferences. -
ExcludedLocationThreeId: integer
(int64)
Title:
Third Excluded LocationExcluded location three identifier of the candidate work preferences. -
ExcludedLocationTwoId: integer
(int64)
Title:
Second Excluded LocationExcluded location two identifier of the candidate work preferences. -
FlexibleWorkFlag: boolean
Title:
Work a Flexible ScheduleMaximum Length:30Indicates whether flexible work is required in the candidate work preferences. -
FullTimeEquivalent: number
Title:
Full Time EquivalentFull time equivalent of the candidate work preferences. -
IntlTravelFlag: boolean
Title:
Travel InternationallyMaximum Length:30Indicates whether international travel is in the candidate work preferences. -
IntlTravelFrequency: string
Title:
International Travel FrequencyMaximum Length:30International travel frequency of the candidate work preferences. -
IntlTravelRequiredFlag: boolean
Title:
International Travel RequiredMaximum Length:30Indicates whether international travel is required in the candidate work preferences. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MinimumPay: integer
(int64)
Title:
Minimum PayMinimum pay of the candidate work preferences. -
NatTravelFlag: boolean
Title:
Travel DomesticallyMaximum Length:30Indicates whether domestic travel is in the candidate work preferences. -
NatTravelFrequency: string
Title:
Domestic Travel FrequencyMaximum Length:30National travel frequency of the candidate work preferences. -
NatTravelRequiredFlag: boolean
Title:
Travel RequiredMaximum Length:30Indicates whether domestic travel is required in the candidate work preferences. -
PartAssignFlag: boolean
Title:
Consider Part Time WorkMaximum Length:30Part assign indicator of the candidate work preferences. -
PayFrequency: string
Title:
Pay FrequencyMaximum Length:30Pay frequency of the candidate work preferences. -
PayRange: string
Title:
Pay RangeMaximum Length:30Pay range of the candidate work preferences. -
PreferredLocationFourId: integer
(int64)
Title:
Fourth Preferred LocationPreferred location four identifier of the candidate work preferences. -
PreferredLocationOneId: integer
(int64)
Title:
First Preferred LocationPreferred location one identifier of the candidate work preferences. -
PreferredLocationThreeId: integer
(int64)
Title:
Third Preferred LocationPreferred location three identifier of the candidate work preferences. -
PreferredLocationTwoId: integer
(int64)
Title:
Second Preferred LocationPreferred location two identifier of the candidate work preferences. -
RelocateDuration: integer
(int64)
Title:
Length of Willing to RelocateRelocate duration of the candidate work preferences. -
RelocateFlag: boolean
Title:
Willing to RelocateMaximum Length:30Indicates whether relocation is possible in the candidate work preferences. -
RelocationReason: string
Title:
Relocation ReasonMaximum Length:240Relocation reason of the candidate work preferences. -
SectionId: integer
(int64)
Section identifier of the candidate work preferences.
-
TempAssignFlag: boolean
Title:
Consider Temporary AssignmentMaximum Length:30Indicates whether temporary assignment is in the candidate work preferences. -
WorkDays: string
Title:
WorkdaysMaximum Length:30Workdays of the candidate work preferences. -
WorkHours: string
Title:
Work HoursMaximum Length:30Work hours of the candidate work preferences. -
WorkMonths: integer
(int64)
Title:
Work Duration MonthsWork months of the candidate work preferences. -
WorkPreferenceId: integer
(int64)
Work preference identifier of the candidate work preferences.
-
WorkYears: integer
(int64)
Title:
Work Duration YearsWork years of the candidate work preferences.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source