Career Website Configuration

Modified on Thu, 2 Feb, 2023 at 5:01 PM

To access the career website configuration go to the portal and follow the steps below to build your Career Website


login > Setup Circle > eRecruitment & Onboarding > Career Theme Settings


Given to specific role only


Once the Career Theme Settings page is opened, it will allow you to change the theme color, logo, banner image, and banner title. After that to get your Career Website Link click on Career Website Embed Code. 


You can use this embed code in your website to display career job openings




API Integration


You can also use our Rest API for getting Job Listing and its details.



 

 ZingHR Career Integration    API

API Details:

API Name

Get Career Jobs Postings 

Method

GET

URL

https://mservices.zinghr.com/recruitment/api/v1/CareerConfig/GetCareerJobPostings

Description

API to Get all the career jobs from ZingHR system. 

Input format

Query String

Output format

JSON


 
Input Parameters :

All fields marked with are mandatory fields :

                                                         Request Parameters

Property Name

Data Type

Description

Mandatory

CareerClientKey*

String

Career Client Key to access jobs

Yes

PageIndex*

Int

Start Index of your career pagination

Yes

PageSize*

Int

Total Jobs in current career page

Yes

SearchText

String

To Search based on Job Title

No

 

Sample URL with QueryString Parameter as :

https://mservices.zinghr.com/recruitment/api/v1/CareerConfig/GetCareerJobPostings?careerClientKey=<<CareerClientKey>>&pageIndex=1&pageSize=5&searchText=<<if any>>

Response : 

Property Name

Description

code

Integer (1 for success and 0 for any validation or failure)

message

String (Success, Validation, or Failure Message)

data

Code is 1 then returns JSON object in data with career job details with Requisition Id from Zinghr system.

 

Success Response -

{

            "code": 1,

            "data": {

                        "totalCount": 1,

                        "careerJobPostings": [{

                                    "requisitionId": xxxx,

                                    "requisitionNumber": 10,

                                    "jobTitle": "Sample job title",

                                    "minExp": 0,

                                    "maxExp": 50,

                                    "eT_Desc": "Employment Type like full time, contract, etc",

                                    "minAge": 18,

                                    "maxAge": 50,

                                    "description": "entire job description as text as well as HTML format",

                                    "minSalary": 1,

                                    "maxSalary": 100,

                                    "startDate": "2023-01-06T00:00:00",

                                    "endDate": "2024-01-04T00:00:00",

                                    "careerAttribute": "attributes which are selected at the time of posting on career"

                        }]

            },

            "message": "Success"

}


 

Validation Error : 

{

     "code": 0,

    "message": "Error Message or Validation message"

}

API Details:

API Name

Get specific career job entire details 

Method

GET

URL

https://mservices.zinghr.com/recruitment/api/v1/CareerConfig/GetJobDescriptionByRequisitionId

Description

API to Get career job details based on requisition id from ZingHR system. 

Input format

Query String

Output format

JSON


 
Input Parameters :

All fields marked with are mandatory fields :

                                                         Request Parameters

Property Name

Data Type

Description

Mandatory

CareerClientKey*

String

Career Client Key to access jobs

Yes

RequisitionId*

Int

RequisitionId for getting a job with details

Yes

 

Sample URL with QueryString Parameter as :

https://mservices.zinghr.com/recruitment/api/v1/CareerConfig/GetJobDescriptionByRequisitionId?careerClientKey=<<CareerClientKey>>&RequisitionId=xxxx

Response : 

Property Name

Description

Code

Integer (1 for success and 0 for any validation or failure)

Message

String (Success, Validation, or Failure Message)

Data

Code is 1 then returns JSON object in data with career job with details for provided Requisition Id from Zinghr system.

 

Success Response -

{

            "code": 1,

            "data": {

                        "requisitionID": xxxx,

                        "requisitionTitle": "requisition name",

                        "employementType": "Full Time",

                        "jobTitle": "Job title",

                        "jobDescription": " entire job description as text as well as HTML format",

                        "requisitionNumber": 10,

                        "department": "Sales",

                        "designation": "A.G.M",

                        "location": "Mumbai",

                        "gender": "Male and Female",

                        "rulesAndResponsibility": "Rules and Responsibility for this requisition",

                        "krAs": "KRAs for this requisition",

                        "skillsAndCompetencies": “Skill and Competencies details for this requisition”,

                        "endDate": "2024-01-04T00:00:00",

                        "country": "India",

                        "signUpId": 1749,

                        "jdVideo": “VideoURL”,

                        "companyLogo": "URL",

                        "qrCodeDetails": {

                                    "isQrCodeExist": true,

                                    "qrCodeImage": "URL",

                                    "shortUrl": "URL",

                                    "longUrl": "URL"

                        },

                        "candidateApplyLink": "candidate application form URL"

            },

            "message": "Success"

}

 

Validation Error : 

{

     "code": 0,

     "message": "Error Message or Validation message"

}



For Custom Candidate Application Form use candidate post API as given in below atta







Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article