Ballerina library

peoplehr

Module peoplehr

OverviewPrerequisitesQuickstart

API

Client

Definitions

AdditionalQuestion
AllEmployeesRequest
AllVacancies
ApplicantInformation
AppraisalDetail
AppraisalDetailsByAppraisalIDRequest
AppraisalDetailsRequest
AppraisalDetailsResponse
AuthenticationInfo
AuthenticationResponse
BackgroundDetail
BankDetail
ConnectionConfig
ContactDetail
Customfield
DeductionsOrEntitlements
Document
Employee
EmployeeIdUpdateRequest
EmployeeLeaverStatus
EmployeeRequest
EmployeeResponse
EmployeeScreenDetail
EmployeeScreenDetailResponse
EmployeesResponse
EmployeeUpdateRequest
EmployeeVerification
ExistingCustomScreenTransactionDetails
FieldHistory
FieldHistoryForEffectiveDate
FieldHistoryForJobRole
File
GetVacancyResultRequest
Holiday
HolidayDetail
HolidayGetResponse
HolidayUpdateRequest
InternalQuestion
NewApplicant
NewCustomScreenTransactionDetails
NewDocument
NewEmployeeRequest
NewFile
NewHolidayRequest
NewVacancy
OperationStatus
OtherContact
PeopleHRGenericResponse
QueryDetail
QueryResultGetRequest
RightToWork
Salary
SalaryDetailGetResponse
SalaryDetailRequest
ScreenDetailByEmployeeIDRequest
ScreenDetailByTransactionIDRequest
Vacancy
VacancyGetResponse
ValueDetails

ballerinax/peoplehr Ballerina library

2.2.1

Overview

PeopleHR connector provides the capability to access the operation to manage employee details, holidays and salaries etc.

This module supports 3.1 version.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the people connector in your Ballerina application, update the .bal file as follows: Add steps to create a simple sample

Step 1 - Import connector

Copy
import ballerinax/peoplehr;

Step 2 - Create a new connector instance

Copy
peoplehr:Client baseClient = check new ({apiKey: <API Key>, baseURL: "https://api.peoplehr.net"});

Step 3 - Invoke connector operation

Copy
peoplehr:QueryDetail response = check baseClient->getQueryByName({QueryName: <Query Name>});

Use bal run command to compile and run the Ballerina program.

Clients

peoplehr: Client

Isolated

This connector helps you easily integrate People with other systems and applications, for seamless cross-platform data sharing. The People API accepts and returns JSON data in the request body, with status indicating the outcome of the operation (sucess/failure).

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Follow this guide to obtain token for PeopleHR connector.

init (ConnectionConfig config)

createNewEmployee

Isolated FunctionRemote Function
function createNewEmployee(NewEmployeeRequest|json payload) returns OperationStatus|error

Creates new employee

Parameters
Return Type

getEmployeeById

Isolated FunctionRemote Function
function getEmployeeById(EmployeeRequest payload) returns EmployeeResponse|error

Gets employee detail by id

Parameters
Return Type

updateEmployeeId

Isolated FunctionRemote Function
function updateEmployeeId(EmployeeIdUpdateRequest payload) returns OperationStatus|error

Updates employee id.

Parameters
Return Type

getAllEmployees

Isolated FunctionRemote Function
function getAllEmployees(AllEmployeesRequest payload) returns EmployeesResponse|error

Gets all employees.

Parameters
Return Type

updateEmployee

Isolated FunctionRemote Function
function updateEmployee(EmployeeUpdateRequest|json payload) returns OperationStatus|error

Updates employee details.

Parameters
Return Type

markAsLeaverById

Isolated FunctionRemote Function
function markAsLeaverById(EmployeeLeaverStatus payload) returns OperationStatus|error

Updates/marks employee leaver status by id.

Parameters
Return Type

getSalaryDetail

Isolated FunctionRemote Function
function getSalaryDetail(SalaryDetailRequest payload) returns SalaryDetailGetResponse|error

Gets employee salary details.

Parameters
Return Type

addNewHoliday

Isolated FunctionRemote Function
function addNewHoliday(NewHolidayRequest|json payload) returns OperationStatus|error

Add new holiday.

Parameters
Return Type

getHolidayDetail

Isolated FunctionRemote Function
function getHolidayDetail(HolidayDetail payload) returns HolidayGetResponse|error

Gets holiday detail list

Parameters
Return Type

deleteHoliday

Isolated FunctionRemote Function
function deleteHoliday(HolidayDetail payload) returns OperationStatus|error

Deletes holiday detail

Parameters
Return Type

createNewVacancy

Isolated FunctionRemote Function
function createNewVacancy(NewVacancy payload) returns OperationStatus|error

Create new vacancy

Parameters
  • payload NewVacancy - Request detail on new vacancy
Return Type

getVacancy

Isolated FunctionRemote Function
function getVacancy(GetVacancyResultRequest|json payload) returns VacancyGetResponse|error

Gets vacancy detail

Parameters
Return Type

getAllVacancies

Isolated FunctionRemote Function
function getAllVacancies() returns AllVacancies|error

Gets all vacancy detail

Return Type

createNewApplicant

Isolated FunctionRemote Function
function createNewApplicant(NewApplicant payload) returns OperationStatus|error

Creates New Applicant

Parameters
Return Type

uploadApplicantDocument

Isolated FunctionRemote Function
function uploadApplicantDocument(NewDocument payload) returns OperationStatus|error

Upload applicant document

Parameters
Return Type

checkDuplicateApplicant

Isolated FunctionRemote Function
function checkDuplicateApplicant(ApplicantInformation payload) returns OperationStatus|error

Checks duplicate applicant

Parameters
Return Type

getQueryByName

Isolated FunctionRemote Function
function getQueryByName(QueryResultGetRequest payload) returns QueryDetail|error

Gets query result By query name details.

Parameters
Return Type

checkAuthentication

Isolated FunctionRemote Function
function checkAuthentication(AuthenticationInfo payload) returns AuthenticationResponse|error

Checks if credentials of a given login user is valid.

Parameters
Return Type

getEmployeeScreenDetail

Isolated FunctionRemote Function
function getEmployeeScreenDetail() returns EmployeeScreenDetailResponse|error

Retrieves employee screen detail

Return Type

getEmployeeScreenDetailByEmployeeID

Isolated FunctionRemote Function
function getEmployeeScreenDetailByEmployeeID(ScreenDetailByEmployeeIDRequest payload) returns EmployeeScreenDetailResponse|error

Retrieves employee screen detail by employee ID

Parameters
Return Type

getEmployeeScreenDetailByTransactionID

Isolated FunctionRemote Function
function getEmployeeScreenDetailByTransactionID(ScreenDetailByTransactionIDRequest payload) returns EmployeeScreenDetailResponse|error

Retrieves employee screen detail by transaction ID

Parameters
Return Type

addNewCustomScreenTransaction

Isolated FunctionRemote Function
function addNewCustomScreenTransaction(NewCustomScreenTransactionDetails payload) returns OperationStatus|error

New custom screen transaction details

Parameters
Return Type

updateCustomScreenTransaction

Isolated FunctionRemote Function
function updateCustomScreenTransaction(ExistingCustomScreenTransactionDetails payload) returns OperationStatus|error

Update custom screen transaction details

Parameters
Return Type

DeleteCustomScreenTransaction

Isolated FunctionRemote Function
function DeleteCustomScreenTransaction(ScreenDetailByTransactionIDRequest payload) returns OperationStatus|error

Delete custom screen transaction details

Parameters
Return Type

getAppraisalDetailsByEmployeeID

Isolated FunctionRemote Function
function getAppraisalDetailsByEmployeeID(AppraisalDetailsRequest payload) returns AppraisalDetailsResponse|error

Retrieves By Employee Id Appraisal details

Parameters
Return Type

getAppraisalDetailsByAppraisalID

Isolated FunctionRemote Function
function getAppraisalDetailsByAppraisalID(AppraisalDetailsByAppraisalIDRequest payload) returns AppraisalDetailsResponse|error

Retrieves appraisal details by appraisal Id

Parameters
Return Type

Records

peoplehr: AdditionalQuestion

Represents additional question

Fields
  • QuestionId string - Question ID
  • Value string - Value default value

peoplehr: AllEmployeesRequest

Closed record

Represents the input of getting all employee data operation

Fields
  • IncludeLeavers boolean - Indicates whether to include the leavers or not.
  • anydata... -

peoplehr: AllVacancies

Closed record

Represents the response of GetAllVacancies operation

Fields
  • Result Vacancy[] - The response of the operation

peoplehr: ApplicantInformation

Closed record

Applicant information for duplicate checking

Fields
  • FirstName string - First name for check duplicate applicant(<= 50 characters)
  • LastName string - Last name for check duplicate applicant(<= 50 characters)
  • VacancyReference string - Vacancy reference for check duplicate applicant
  • Email string? - Email for check duplicate applicant
  • anydata... -

peoplehr: AppraisalDetail

Represents appraisal details response results

Fields
  • AppraisalId int - Appraisal ID
  • AppraisalReviewDate string - Appraisal Review Date
  • Reviewer string - Reviewer Details
  • Note string - Note on appraisal
  • ActionPlan string - Action Plan
  • Objectives string - Objective detail
  • Files File[]? - File Details

peoplehr: AppraisalDetailsByAppraisalIDRequest

Represents appraisal details request by appraisal ID

Fields
  • EmployeeId string - Employee id for get by employee id
  • AppraisalId int - Start date for get by employee id

peoplehr: AppraisalDetailsRequest

Represents appraisal details request

Fields
  • EmployeeId string - Employee id for get by employee id
  • StartDate string - Start date for get by employee id
  • EndDate string - EndDate date for get by employee id

peoplehr: AppraisalDetailsResponse

Represents appraisal details response record

Fields

peoplehr: AuthenticationInfo

Closed record

Represents the inputs of checkAuthentication operation

Fields
  • EmailAddress string - Email Address of the user
  • Password string - The password of the user
  • anydata... -

peoplehr: AuthenticationResponse

Closed record

Represents the response type of updateEmployeeDetail operation

Fields

peoplehr: BackgroundDetail

Closed record

Represents the background details

Fields
  • BackgroundDetailComments ValueDetails? - The background detail comments

peoplehr: BankDetail

Closed record

Represents bank details

Fields

peoplehr: ConnectionConfig

Closed record

Client configuration details.

Fields
  • auth never? -
  • apiKey string - PeopleHR API key
  • baseURL string(default "https://api.peoplehr.net") - Base URL

peoplehr: ContactDetail

Represents the contact detail

Fields
  • PersonalPhoneNumber ValueDetails? - The personal phone number

peoplehr: Customfield

Represents the Custom Fields

Fields
  • ColumnName string - The name of the custom field
  • ColumnValue string - The value of the custom field

peoplehr: DeductionsOrEntitlements

Closed record

Represents deductions Or entitlements type record

Fields
  • Deduction string? - deduction value
  • Entitlement string? - entitlement value
  • Percentage string? - The percentage
  • Comments string? - The comments
  • IncludeInTotalSalary string? - Indicates whether includes in total salary
  • DisplayAsAmountOrPercentage string? - The display as amount or percentage

peoplehr: Document

Represents Document detail

Fields
  • DocumentName string - Document name
  • Url string - URL for the document

peoplehr: Employee

Represents an employee type record

Fields
  • LocationEffectiveDate ValueDetails? - The effective date of the location
  • DepartmentEffectiveDate ValueDetails? - The effective date of the department
  • ReportsToEffectiveDate ValueDetails? - Reports to effective date
  • ReportsToEmployeeId ValueDetails? - The ID of the employee whom should be reported
  • ReportsToEmailAddress ValueDetails? - The email address of the employee whom should be reported
  • EmploymentTypeEffectiveDate ValueDetails? - The effective date of employment type
  • HolidayAllowanceDays ValueDetails? - The holiday allowance days
  • HolidayAllowanceMins ValueDetails? - The holiday allowance mins
  • ProbationEndDate ValueDetails? - The end date of the probation
  • LeavingDate string? - The leaving date
  • ReasonForLeaving string? - Reason for leaving
  • EmployeeImage string? - The employee image
  • APIColumn1 string? - API column 1
  • APIColumn2 string? - API column 2
  • APIColumn3 string? - API column 3
  • APIColumn4 string? - API column 4
  • APIColumn5 string? - API column 5

peoplehr: EmployeeIdUpdateRequest

Closed record

Represents the input of UpdateEmployeeId operation

Fields
  • ReasonForChange string - The reason for change
  • OldEmployeeId string - The old employee ID
  • NewEmployeeId string - The new employee ID
  • anydata... -

peoplehr: EmployeeLeaverStatus

Closed record

Represent employee leaver status type record

Fields
  • EmployeeId string - employee ID
  • ReasonforLeaving string - Reason for leaving
  • AdditionalComments string? - Additional comments
  • FinalEmploymentDate string - final employment date
  • FinalWorkingDate string? - Final working date
  • MarkasLeaverImmediately string? - Mark as leaver immediately
  • ReportsTo string? - Reports to
  • ReEmployable string? - Re-employable
  • SupportingComments string? - The supporting comments
  • anydata... -

peoplehr: EmployeeRequest

Closed record

Represents the input of getting employee detail operation

Fields
  • EmployeeId string - The employee ID
  • anydata... -

peoplehr: EmployeeResponse

Closed record

Represents the response type of getEmployeeDetailById operation

Fields
  • Result Employee?|record {} - The response details of the operation

peoplehr: EmployeeScreenDetail

Represents Employee Screen Details

Fields
  • ScreenId int? - ScreenId is the unique identifier of the employee custom screen
  • ScreenName string? - ScreenName is the name of the employee custom screen
  • TxnId int? - Field Description
  • Files File[]? - Files details

peoplehr: EmployeeScreenDetailResponse

Closed record

Represents the response of GetEmployeeScreenDetail operation

Fields

peoplehr: EmployeesResponse

Closed record

Represents the response type of getAllEmployeeDetail operation

Fields

peoplehr: EmployeeUpdateRequest

Closed record

Represents a new employee type record

Fields
  • EmployeeId string - The employee ID
  • Title string? - The title of the employee
  • FirstName string? - The first name of the employee
  • LastName string? - The last name of the employee
  • Email string? - The email address
  • DateOfBirth string? - The date of birth
  • StartDate string? - The start date
  • ReportsTo string? - Employee reports to
  • ReportsToEffectiveDate string? - The reports to effective date
  • CompanyEffectiveDate string? - The company effective date
  • JobRole string? - The job role
  • JobRoleEffectiveDate string? - The job role effective date
  • Location string? - The location
  • LocationEffectiveDate string? - The effective date of location
  • Department string? - The department of the employee
  • DepartmentEffectiveDate string? - The effective date of department
  • NationalInsuranceNumber string? - The national insurance number
  • Nationality string? - The nationality of the employee
  • EmploymentType string? - The type of the employee
  • EmploymentTypeEffectiveDate string? - The effective date of employee type
  • Address string? - The address of the employee
  • PersonalPhoneNumber string? - The personal phone number
  • Performance string? - The performance
  • Benefits string? - The benefits
  • System1\ ID string? - The system1 ID
  • System2\ ID string? - The system2 ID
  • System3\ ID string? - The system3 ID
  • APIColumn1 string? - API column 1
  • APIColumn2 string? - API column 2
  • APIColumn3 string? - API column 3
  • APIColumn4 string? - API column 4
  • APIColumn5 string? - API column 5
  • PersonalEmail string? - Personal email
  • MethodOfRecruitment string? - Method of recruitment
  • ReasonForChange string - Reason For Change
  • anydata... -

peoplehr: EmployeeVerification

The Results of the employee verification

Fields
  • EmployeeId string? - The employee Id of the verified user

peoplehr: ExistingCustomScreenTransactionDetails

Represents Existing custom screen transaction details

Fields
  • CustomScreenTransactionId int
  • EmployeeId string
  • ScreenId int
  • anydata...
  • AddFiles NewFile[] - Field Description

peoplehr: FieldHistory

Represents the field history

Fields
  • OldValue string? - The old value
  • NewValue string? - The new value
  • ChangedOn string? - The changed on
  • ReasonForChange string? - The reason for change

peoplehr: FieldHistoryForEffectiveDate

Closed record

Represents the field history for effective date

Fields
  • FieldData string - The field date
  • EffectiveDate string - The effective date
  • ChangedOn string - The changed on
  • ReasonForChange string - The reason for change

peoplehr: FieldHistoryForJobRole

Closed record

Represents field history for job role type record

Fields
  • EffectiveDate string - The effective date
  • ChangedOn string - The changed on
  • ReasonForChange string - The reason for change

peoplehr: File

Represents Files Details

Fields
  • DocumentName string - Name of the document name
  • Description string - Description of the file
  • FileUrl string - URL of the file
  • Category string - File category
  • SignatureRequired boolean - Whether a signature is required for the document

peoplehr: GetVacancyResultRequest

Closed record

Represents the request payload of GetVacancyResult operation

Fields
  • VacancyReference string - Field Description
  • anydata... -

peoplehr: Holiday

Closed record

Represents holiday type record

Fields
  • StartDate string? - The start date
  • EndDate string? - The end date
  • DurationType int? - The duration type
  • DurationInDays int? - The duration in days
  • DurationInMinutes int? - The duration in minutes
  • DurationInDaysThisPeriod int? - The duration in days this period
  • DurationInMinutesThisPeriod int? - The duration in minutes this period
  • PartOfDay string? - Part of day
  • RequesterComments string? - The requester comments
  • ApproverComments string? - The approver comments
  • Approver string? - Approver detail
  • LastActionDateTime string? - The last action date time
  • IsToilHoliday boolean? - indicates whether isToil Holiday
  • anydata... -

peoplehr: HolidayDetail

Closed record

Represents holiday detail

Fields
  • EmployeeId string - The employee ID
  • StartDate string? - Start date
  • anydata... -

peoplehr: HolidayGetResponse

Closed record

Represents the response type of GetHolidayDetail operation

Fields

peoplehr: HolidayUpdateRequest

Closed record

Represents holiday update type record

Fields
  • EmployeeId string - The employee ID
  • OldStartDate string - The old start date
  • OldEndDate string - The old end date
  • DurationType string - The duration type
  • StartDate string - The start date
  • DurationInDays string - The duration in days
  • DurationInMinutes string - The duration in minutes
  • PartOfDay string? - The part of day
  • anydata... -

peoplehr: InternalQuestion

Internal questions for create new applicant

Fields

peoplehr: NewApplicant

Represents new applicant

Fields
  • VacancyReference string? - Vacancy reference for create new applicant
  • FirstName string - First name for create new applicant
  • LastName string - Last name for create new applicant
  • Email string? - Email for create new applicant
  • Gender string? - Gender for create new applicant
  • DateOfBirth string? - Date of birth for create new applicant
  • PostCode string? - Post code for create new applicant
  • Address string? - Address for create new applicant
  • PhoneNumber string? - PhoneNumber for create new applicant
  • OtherContactDetails string? - Other contact details for create new applicant
  • Source string? - Source for create new applicant
  • InternalQuestions InternalQuestion[]? - Internal questions for create new applicant
  • Documents Document[] - Documents for create new applicant
  • Skills string - Skills for create new applicant
  • RecruitmentCost string? - Recruitment cost for create new applicant
  • DateLastContacted string? - Date last contacted for create new applicant
  • anydata... -
  • json... - Rest field

peoplehr: NewCustomScreenTransactionDetails

Represents new custom screen details

Fields
  • CustomColumns Customfield[] - CustomColumns for add new custom screen transaction
  • AddFiles NewFile[] - AddFiles for add new custom screen transaction

peoplehr: NewDocument

Closed record

Represents document detail

Fields
  • ApplicantId string - ApplicantId for upload applicant document
  • DocumentName string - Document name for upload applicant document(<= 100 characters)
  • Description string - Description for upload applicant document(<= 256 characters)
  • File string - File for upload applicant document
  • anydata... -

peoplehr: NewEmployeeRequest

Closed record

Represents a new employee type record

Fields
  • EmployeeId string - The employee ID
  • Title string? - The title of the employee
  • FirstName string - The first name of the employee
  • LastName string - The last name of the employee
  • Email string? - The email address
  • StartDate string - The start date
  • DateOfBirth string? - The date of birth
  • ReportsTo string? - Employee reports to
  • JobRoleEffectiveDate string - Field Description
  • Location string - The location
  • Department string - The department of the employee
  • NationalInsuranceNumber string? - Field Description
  • Nationality string? - The nationality of the employee
  • EmploymentType string? - The type of the employee
  • EntitlementThisYear string? - The entitlement this year
  • EntitlementNextYear string? - The entitlement next year
  • Address string? - The address of the employee
  • PersonalPhoneNumber string? - The personal phone number
  • Performance string? - The performance
  • Benefits string? - The benefits
  • System1\ ID string? - The system1 ID
  • System2\ ID string? - The system2 ID
  • System3\ ID string? - The system3 ID
  • APIColumn1 string? - API column 1
  • APIColumn2 string? - API column 2
  • APIColumn3 string? - API column 3
  • APIColumn4 string? - API column 4
  • APIColumn5 string? - API column 5
  • PersonalEmail string? - Personal email
  • MethodOfRecruitment string? - Method of recruitment
  • anydata... -

peoplehr: NewFile

Represents Files Details

Fields
  • DocumentName string - Name of the document name
  • Description string - Description of the file
  • File string - The file content in Base64 string
  • DocumentCategory string - File category
  • SignatureRequired boolean - Whether a signature is required for the document

peoplehr: NewHolidayRequest

Closed record

Represents new holiday type record

Fields
  • EmployeeId string - The employee ID
  • DurationType string? - The duration type
  • StartDate string? - The start date
  • EndDate string? - The end date
  • DurationInDays string? - The duration in days
  • DurationInMinutes string? - The duration in minutes
  • PartOfDay string? - The part of day
  • Comments string? - The comments
  • anydata... -

peoplehr: NewVacancy

Closed record

Represents the details of the new vacancy

Fields
  • VacancyName string? - The name of the vacancy
  • VacancyDescription string? - The description of the vacancy
  • Location string? - The location
  • Department string? - The department
  • ClosingDate string? - The closing date
  • Reference string? - The reference
  • SalaryRange string? - The salary range
  • JobDescription string? - The job description
  • IsCoverLetterMandatory boolean? - Indicates whether the cover letter is mandatory or not
  • IsResumeMandatory boolean? - Indicates whether the resume is mandatory or not
  • IsHideSalary boolean? - Indicates whether to hide the salary of the vacancy
  • VacancyType string? - The vacancy type
  • JobTitle string? - The title of the job
  • City string? - The city of the job
  • Country string? - The country of the job
  • Experience string? - The experience expected
  • anydata... -

peoplehr: OperationStatus

Represents the response type of an operation

Fields
  • Result json - The response of the operation

peoplehr: OtherContact

Represents the other contact

Fields
  • OtherContactAddress ValueDetails? - The other contact address

peoplehr: PeopleHRGenericResponse

Represents common fields of the response

Fields
  • isError boolean - Indicates whether the response is an error or not
  • Status int - The status of the error
  • Message string - The message of the response

peoplehr: QueryDetail

Closed record

Represents the response type of getQueryByName operation

Fields
  • Result json - The results as an json array

peoplehr: QueryResultGetRequest

Closed record

Represents the input of GetQueryResult operation

Fields
  • QueryName string - The Query Name
  • anydata... -

peoplehr: RightToWork

Closed record

Represents right to work type record

Fields
  • RightToWorkComments ValueDetails? - The right to work comments

peoplehr: Salary

Closed record

Represents salary detail type record

Fields
  • EffectiveFrom string? - The effective from
  • SalaryType string? - The salary type
  • PaymentFrequency string? - The payment frequency
  • SalaryAmount string? - The salary amount
  • TotalSalaryAmount string? - The total salary amount
  • Currency string? - The currency
  • ChangeReason string? - The change reason
  • Comments string? - The comments

peoplehr: SalaryDetailGetResponse

Closed record

Represents the response of GetSalaryDetail operation

Fields
  • Result Salary[] - Salary Detail

peoplehr: SalaryDetailRequest

Closed record

Represents salary detail request type record

Fields
  • EmployeeId string - The employee ID
  • IsIncludeHistory boolean - Indicates whether to include the history
  • anydata... -

peoplehr: ScreenDetailByEmployeeIDRequest

Represents request details for retrieving screen details by employee ID

Fields
  • EmployeeId string - EmployeeId for employee custom screen
  • ScreenId int - ScreenId for employee custom screen

peoplehr: ScreenDetailByTransactionIDRequest

Represents request details for retrieving screen details by transaction ID

Fields
  • CustomScreenTransactionId int - CustomScreenTransactionId for employee custom screen

peoplehr: Vacancy

Represents a vacancy record

Fields
  • VacancyName string? - The vacancy Name
  • VacancyDescription string? - The vacancy detail
  • Location string? - The location of the vacancy
  • Department string? - The department of the vacancy
  • Status int? - The status of the vacancy
  • ClosingDate string? - The closing date
  • Reference string? - The reference
  • SalaryRange string? - The salary range of the job
  • JobDescription string? - The job detail
  • IsHideSalary boolean? - Indicates whether to hide the salary
  • JobTitle string? - The job title
  • VacancyType string? - The vacancy type
  • City string? - The city of the vacancy
  • Country string? - The country of the vacancy
  • Experience string? - The experience expected
  • JobBordUrl string? - The URL for job details
  • AdditionalQuestions json[]? - Additional questions
  • InternalQuestions json[]? - Internal questions on the vacancy

peoplehr: VacancyGetResponse

Closed record

Represents the response of GetVacancy operation

Fields
  • Result Vacancy - The response of the operation

peoplehr: ValueDetails

Represents valueDetails type

Fields
  • DisplayValue string? - The display value
  • FieldHistoryForJobRole FieldHistory[]? - The field history for job role

Import

import ballerinax/peoplehr;Copy

Metadata

Released date: 10 months ago

Version: 2.2.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

Pull count

Total: 209

Current verison: 3

Weekly downloads

Source repository

Keywords

Human Resources/HRMS

Cost/Paid

Contributors

Other versions

2.2.1

2.2.02.1.02.0.01.1.1
See more...

Dependencies

ballerinax/client.config/1.0.1ballerina/os/1.6.0ballerina/log/2.6.0
See more...

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC