Jump to

• Request
• Response

Get all basic information details for a candidate

get

/hcmRestApi/resources/11.13.18.05/recruitingCECandidateDetails

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 candidate basic information based on the primary key.
    Finder Variables
    • CandidateNumber; string; Candidate number used to identify a specific candidate.
• 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:
  

  • EmailPreferredFlag; boolean; Indicates whether the candidate prefers communication via email. Valid values are Y and N. Default is N.
  • EmailVerifiedFlag; boolean; Indicates whether the candidate's email is verified. Valid values are Y and N. Default is N.
  • PhoneChannelType; string; Indicates the type of phone channel used by the candidate. Valid values are Mobile, Home, and Work. Default is Mobile.
  • PhonePreferredFlag; boolean; Indicates whether the phone number is the preferred contact method. Valid values are Y and N. Default is N.
  • PhoneVerifiedFlag; boolean; Indicates whether the candidate's phone number is verified. Valid values are Y and N. Default is N.
  • ResumeText; string; Text content of the candidate's resume extracted from the uploaded file.
• 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: string
  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: string
  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 Top

Response

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.

Body ()

Root Schema : recruitingCECandidateDetails

Type: object

Show Source

• 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: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidateDetails-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object recruitingCECandidateDetails-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidateDetails-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingCECandidateDetails-item-response

Type: object

Show Source

• AddressLine1: string
  Maximum Length: 240

  Primary address line of the candidate's location. This field captures the first line of the street address as provided by the candidate.
• AddressLine2: string
  Maximum Length: 240

  Secondary address line for the candidate's location.
• AddressLine3: string
  Maximum Length: 255

  Third line of the candidate's address. This field captures additional address information if needed.
• CandidateNumber: string
  Maximum Length: 240

  Unique identifier for the candidate in the recruiting process. This number helps track and manage candidate information throughout the hiring lifecycle.
• CandidateType: string
  Read Only: true

  Maximum Length: 255

  Indicates the type of candidate, such as internal or external. Valid values are defined in the system.
• City: string
  Maximum Length: 60

  City where the candidate resides. This field captures the candidate's current location.
• Country: string
  Maximum Length: 60

  Country where the candidate is located. This field helps in identifying the candidate's geographical location for recruitment purposes.
• educations: array Candidate Educational Backgrounds
  Title: Candidate Educational Backgrounds

  The CandidateSummaryEducationItemVO resource provides details about a candidate's education.
• Email: string
  Maximum Length: 240

  Email address of the candidate. Used for communication and identification purposes.
• EmailPreferredFlag: boolean
  Maximum Length: 255

  Indicates whether the candidate prefers communication via email. Valid values are Y and N. Default is N.
• EmailVerifiedFlag: boolean
  Maximum Length: 255

  Indicates whether the candidate's email is verified. Valid values are Y and N. Default is N.
• FirstName: string
  Maximum Length: 150

  First name of the candidate. This field captures the given name of the individual applying for a position.
• languages: array Candidate Language Proficiencies
  Title: Candidate Language Proficiencies

  The languages resource provides details about a candidate's language proficiencies.
• LastName: string
  Maximum Length: 150

  Last name of the candidate. This field captures the family name or surname of the individual applying for a position.
• licensesAndCertifications: array Candidate Certification Details
  Title: Candidate Certification Details

  The CandidateSummaryCertificationItemVO resource provides details about a candidate's certifications.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MiddleNames: string
  Maximum Length: 80

  Middle name or names of the candidate.
• MobilePhoneAreaCode: string
  Maximum Length: 30

  Mobile phone area code for the candidate. This field specifies the area code associated with the candidate's mobile phone number.
• MobilePhoneCountryCode: string
  Maximum Length: 30

  Mobile phone country code for the candidate's contact information.
• MobilePhoneLegislationCode: string
  Maximum Length: 30

  Mobile phone legislation code for the candidate's contact information. It specifies the country or region associated with the mobile phone number.
• MobilePhoneNumber: string
  Maximum Length: 60

  Mobile phone number of the candidate. This is used for communication and verification purposes.
• PhoneChannelType: string
  Maximum Length: 30

  Indicates the type of phone channel used by the candidate. Valid values are Mobile, Home, and Work. Default is Mobile.
• PhonePreferredFlag: boolean
  Maximum Length: 255

  Indicates whether the phone number is the preferred contact method. Valid values are Y and N. Default is N.
• PhoneVerifiedFlag: boolean
  Maximum Length: 255

  Indicates whether the candidate's phone number is verified. Valid values are Y and N. Default is N.
• PostalCode: string
  Maximum Length: 30

  Postal code of the candidate's address. This field identifies the specific postal or ZIP code associated with the candidate's location.
• Region1: string
  Maximum Length: 120

  Region associated with the candidate's basic information.
• Region2: string
  Maximum Length: 120

  Region or area associated with the candidate's location. This field helps categorize candidates based on geographical data.
• Region3: string
  Maximum Length: 120

  Region or area associated with the candidate's location. This field helps in categorizing candidates based on geographical data.
• ResumeText: string
  Read Only: true

  Maximum Length: 255

  Text content of the candidate's resume extracted from the uploaded file.
• skills: array Candidate Skills
  Title: Candidate Skills

  The CandidateSummarySkillItemVO resource provides details about a candidate's skills.
• Title: string
  Maximum Length: 30

  Title of the candidate's profile or resume. This field captures the primary title associated with the candidate's information.
• workExperiences: array Candidate Previous Experiences
  Title: Candidate Previous Experiences

  The CandidateSummaryPreviousExpItemVO resource provides details about a candidate's previous work experiences.

{
    "type":"object",
    "properties":{
        "AddressLine1":{
            "maxLength":240,
            "type":"string",
            "description":"Primary address line of the candidate's location. This field captures the first line of the street address as provided by the candidate.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressLine2":{
            "maxLength":240,
            "type":"string",
            "description":"Secondary address line for the candidate's location.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressLine3":{
            "maxLength":255,
            "type":"string",
            "description":"Third line of the candidate's address. This field captures additional address information if needed.",
            "nullable":true,
            "x-queryable":false
        },
        "CandidateNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Unique identifier for the candidate in the recruiting process. This number helps track and manage candidate information throughout the hiring lifecycle.",
            "nullable":true,
            "x-queryable":false
        },
        "CandidateType":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the type of candidate, such as internal or external. Valid values are defined in the system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"City where the candidate resides. This field captures the candidate's current location.",
            "nullable":true,
            "x-queryable":false
        },
        "Country":{
            "maxLength":60,
            "type":"string",
            "description":"Country where the candidate is located. This field helps in identifying the candidate's geographical location for recruitment purposes.",
            "nullable":true,
            "x-queryable":false
        },
        "Email":{
            "maxLength":240,
            "type":"string",
            "description":"Email address of the candidate. Used for communication and identification purposes.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailPreferredFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the candidate prefers communication via email. Valid values are Y and N. Default is N.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailVerifiedFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the candidate's email is verified. Valid values are Y and N. Default is N.",
            "nullable":true,
            "x-queryable":true
        },
        "FirstName":{
            "maxLength":150,
            "type":"string",
            "description":"First name of the candidate. This field captures the given name of the individual applying for a position.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "maxLength":150,
            "type":"string",
            "description":"Last name of the candidate. This field captures the family name or surname of the individual applying for a position.",
            "nullable":true,
            "x-queryable":false
        },
        "MiddleNames":{
            "maxLength":80,
            "type":"string",
            "description":"Middle name or names of the candidate.",
            "nullable":true,
            "x-queryable":false
        },
        "MobilePhoneAreaCode":{
            "maxLength":30,
            "type":"string",
            "description":"Mobile phone area code for the candidate. This field specifies the area code associated with the candidate's mobile phone number.",
            "nullable":true,
            "x-queryable":false
        },
        "MobilePhoneCountryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Mobile phone country code for the candidate's contact information.",
            "nullable":true,
            "x-queryable":false
        },
        "MobilePhoneLegislationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Mobile phone legislation code for the candidate's contact information. It specifies the country or region associated with the mobile phone number.",
            "nullable":true,
            "x-queryable":false
        },
        "MobilePhoneNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Mobile phone number of the candidate. This is used for communication and verification purposes.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneChannelType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of phone channel used by the candidate. Valid values are Mobile, Home, and Work. Default is Mobile.",
            "nullable":true,
            "x-queryable":true
        },
        "PhonePreferredFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the phone number is the preferred contact method. Valid values are Y and N. Default is N.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneVerifiedFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the candidate's phone number is verified. Valid values are Y and N. Default is N.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":30,
            "type":"string",
            "description":"Postal code of the candidate's address. This field identifies the specific postal or ZIP code associated with the candidate's location.",
            "nullable":true,
            "x-queryable":false
        },
        "Region1":{
            "maxLength":120,
            "type":"string",
            "description":"Region associated with the candidate's basic information.",
            "nullable":true,
            "x-queryable":false
        },
        "Region2":{
            "maxLength":120,
            "type":"string",
            "description":"Region or area associated with the candidate's location. This field helps categorize candidates based on geographical data.",
            "nullable":true,
            "x-queryable":false
        },
        "Region3":{
            "maxLength":120,
            "type":"string",
            "description":"Region or area associated with the candidate's location. This field helps in categorizing candidates based on geographical data.",
            "nullable":true,
            "x-queryable":false
        },
        "ResumeText":{
            "maxLength":255,
            "type":"string",
            "description":"Text content of the candidate's resume extracted from the uploaded file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Title":{
            "maxLength":30,
            "type":"string",
            "description":"Title of the candidate's profile or resume. This field captures the primary title associated with the candidate's information.",
            "nullable":true,
            "x-queryable":false
        },
        "educations":{
            "title":"Candidate Educational Backgrounds",
            "type":"array",
            "description":"The CandidateSummaryEducationItemVO resource provides details about a candidate's education.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidateDetails-educations-item-response"
            }
        },
        "languages":{
            "title":"Candidate Language Proficiencies",
            "type":"array",
            "description":"The languages resource provides details about a candidate's language proficiencies.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidateDetails-languages-item-response"
            }
        },
        "licensesAndCertifications":{
            "title":"Candidate Certification Details",
            "type":"array",
            "description":"The CandidateSummaryCertificationItemVO resource provides details about a candidate's certifications.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidateDetails-licensesAndCertifications-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "skills":{
            "title":"Candidate Skills",
            "type":"array",
            "description":"The CandidateSummarySkillItemVO resource provides details about a candidate's skills.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidateDetails-skills-item-response"
            }
        },
        "workExperiences":{
            "title":"Candidate Previous Experiences",
            "type":"array",
            "description":"The CandidateSummaryPreviousExpItemVO resource provides details about a candidate's previous work experiences.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidateDetails-workExperiences-item-response"
            }
        }
    }
}

Nested Schema : Candidate Educational Backgrounds

Type: array

Title: Candidate Educational Backgrounds

The CandidateSummaryEducationItemVO resource provides details about a candidate's education.

Show Source

• Array of: object recruitingCECandidateDetails-educations-item-response

{
    "title":"Candidate Educational Backgrounds",
    "type":"array",
    "description":"The CandidateSummaryEducationItemVO resource provides details about a candidate's education.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidateDetails-educations-item-response"
    }
}

Nested Schema : Candidate Language Proficiencies

Type: array

Title: Candidate Language Proficiencies

The languages resource provides details about a candidate's language proficiencies.

Show Source

• Array of: object recruitingCECandidateDetails-languages-item-response

{
    "title":"Candidate Language Proficiencies",
    "type":"array",
    "description":"The languages resource provides details about a candidate's language proficiencies.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidateDetails-languages-item-response"
    }
}

Nested Schema : Candidate Certification Details

Type: array

Title: Candidate Certification Details

The CandidateSummaryCertificationItemVO resource provides details about a candidate's certifications.

Show Source

• Array of: object recruitingCECandidateDetails-licensesAndCertifications-item-response

{
    "title":"Candidate Certification Details",
    "type":"array",
    "description":"The CandidateSummaryCertificationItemVO resource provides details about a candidate's certifications.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidateDetails-licensesAndCertifications-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Candidate Skills

Type: array

Title: Candidate Skills

The CandidateSummarySkillItemVO resource provides details about a candidate's skills.

Show Source

• Array of: object recruitingCECandidateDetails-skills-item-response

{
    "title":"Candidate Skills",
    "type":"array",
    "description":"The CandidateSummarySkillItemVO resource provides details about a candidate's skills.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidateDetails-skills-item-response"
    }
}

Nested Schema : Candidate Previous Experiences

Type: array

Title: Candidate Previous Experiences

The CandidateSummaryPreviousExpItemVO resource provides details about a candidate's previous work experiences.

Show Source

• Array of: object recruitingCECandidateDetails-workExperiences-item-response

{
    "title":"Candidate Previous Experiences",
    "type":"array",
    "description":"The CandidateSummaryPreviousExpItemVO resource provides details about a candidate's previous work experiences.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidateDetails-workExperiences-item-response"
    }
}

Nested Schema : recruitingCECandidateDetails-educations-item-response

Type: object

Show Source

• DegreeId: integer (int64)
  Read Only: true

  Unique identifier for the degree associated with the candidate's education.
• DegreeName: string
  Read Only: true

  Maximum Length: 240

  Name of the degree or certification obtained by the candidate.
• EndDate: string (date)
  Read Only: true

  End date of the candidate's education period.
• GraduatedFlag: boolean
  Read Only: true

  Maximum Length: 30

  Indicates whether the candidate has graduated. Valid values are Y and N. Default is N.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Major: string
  Read Only: true

  Maximum Length: 240

  Major field of study for the candidate's education.
• SchoolId: integer (int64)
  Read Only: true

  Unique identifier for the school or educational institution.
• SchoolName: string
  Read Only: true

  Maximum Length: 2000

  Name of the school or educational institution attended by the candidate.
• StartDate: string (date)
  Read Only: true

  Start date of the candidate's education. This date indicates when the education program or course began.

{
    "type":"object",
    "properties":{
        "DegreeId":{
            "type":"integer",
            "description":"Unique identifier for the degree associated with the candidate's education.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DegreeName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the degree or certification obtained by the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date of the candidate's education period.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GraduatedFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the candidate has graduated. Valid values are Y and N. Default is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Major":{
            "maxLength":240,
            "type":"string",
            "description":"Major field of study for the candidate's education.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SchoolId":{
            "type":"integer",
            "description":"Unique identifier for the school or educational institution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SchoolName":{
            "maxLength":2000,
            "type":"string",
            "description":"Name of the school or educational institution attended by the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the candidate's education. This date indicates when the education program or course began.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : recruitingCECandidateDetails-languages-item-response

Type: object

Show Source

• LanguageId: integer (int64)
  Read Only: true

  Unique identifier for the language associated with the candidate's summary.
• LanguageName: string
  Read Only: true

  Maximum Length: 240

  Name of the language known by the candidate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LanguageId":{
            "type":"integer",
            "description":"Unique identifier for the language associated with the candidate's summary.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LanguageName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the language known by the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingCECandidateDetails-licensesAndCertifications-item-response

Type: object

Show Source

• CertificationId: integer (int64)
  Read Only: true

  Unique identifier for the candidate's certification.
• CertificationName: string
  Read Only: true

  Maximum Length: 700

  Name of the certification held by the candidate.
• ExpirationDate: string (date)
  Read Only: true

  Expiration date for the candidate's certification. Indicates when the certification is no longer valid.
• IssueDate: string (date)
  Read Only: true

  Date when the certification was issued.
• IssuedBy: string
  Read Only: true

  Maximum Length: 240

  Name of the organization or authority that issued the certification.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CertificationId":{
            "type":"integer",
            "description":"Unique identifier for the candidate's certification.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CertificationName":{
            "maxLength":700,
            "type":"string",
            "description":"Name of the certification held by the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Expiration date for the candidate's certification. Indicates when the certification is no longer valid.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDate":{
            "type":"string",
            "description":"Date when the certification was issued.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssuedBy":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization or authority that issued the certification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingCECandidateDetails-skills-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SkillId: integer (int64)
  Read Only: true

  Unique identifier for the skill associated with the candidate.
• SkillName: string
  Read Only: true

  Maximum Length: 700

  Name of the skill associated with the candidate's profile.

{
    "type":"object",
    "properties":{
        "SkillId":{
            "type":"integer",
            "description":"Unique identifier for the skill associated with the candidate.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SkillName":{
            "maxLength":700,
            "type":"string",
            "description":"Name of the skill associated with the candidate's profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingCECandidateDetails-workExperiences-item-response

Type: object

Show Source

• Achievements: string (byte)
  Title: Achievements

  Summary of key achievements during the candidate's previous work experience. This field captures notable accomplishments or contributions made by the candidate in their past roles.
• CurrentJobFlag: boolean
  Title: Current Job

  Maximum Length: 30

  Indicates whether the job is the candidate's current position. Valid values are Y and N. Default is N.
• EmployerName: string
  Title: Employer Name

  Maximum Length: 240

  Name of the employer from the candidate's previous work experience.
• EndDate: string (date)
  Title: End Date

  End date of the candidate's previous work experience. This date marks the conclusion of the specified employment period.
• JobTitle: string
  Title: Job Title

  Maximum Length: 240

  Job title held by the candidate in a previous role.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Responsibilities: string (byte)
  Title: Responsibilities

  Details about the candidate's responsibilities in a previous job. This field captures key duties and tasks performed in the role.
• StartDate: string (date)
  Title: Start Date

  Start date of the candidate's previous work experience.

{
    "type":"object",
    "properties":{
        "Achievements":{
            "title":"Achievements",
            "type":"string",
            "description":"Summary of key achievements during the candidate's previous work experience. This field captures notable accomplishments or contributions made by the candidate in their past roles.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CurrentJobFlag":{
            "title":"Current Job",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the job is the candidate's current position. Valid values are Y and N. Default is N.",
            "nullable":true,
            "x-queryable":true
        },
        "EmployerName":{
            "title":"Employer Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the employer from the candidate's previous work experience.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date of the candidate's previous work experience. This date marks the conclusion of the specified employment period.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":240,
            "type":"string",
            "description":"Job title held by the candidate in a previous role.",
            "nullable":true,
            "x-queryable":true
        },
        "Responsibilities":{
            "title":"Responsibilities",
            "type":"string",
            "description":"Details about the candidate's responsibilities in a previous job. This field captures key duties and tasks performed in the role.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the candidate's previous work experience.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top