1 Explanation

• The submitted parameters are in the data format of key-value pairs (application/x-www-form-urlencoded), and web browsers will package this data and populate into the http body.

• Authentication Method (/hrm/websevice/hrm_webservice_config.jsp will provide authentication methods configurations)

  • IP Address: Allow to configure multiple client IP in /WEB-INF/prop/HrmWebserviceIP.properties, separate by comma.

  • Token Authentications: Extra parameter in submitted parameters

• Example:

• key generate methods, java sample:

• Sample: There are two methods to configure the token, select either one

  • Token Method 1: Use the header method, insert key, ts parameters.

  • Token Method 2: Insert the parameters in the body:

2 Get Divisions List

Request URL

• /api/hrm/resful/getHrmsubcompanyWithPage

Request Method:

• POST

Parameters:

• Request Parameter - Sample:

Exnample:

jsReturn Sample:

3 Get Departments List

Request URL:

• /api/hrm/resful/getHrmdepartmentWithPage

Request Method:

• POST

Parameters:

• json Parameters Explanation:

Sample

Return Sample:

4 Get Positions List

Request URL:

• /api/hrm/resful/getJobtitleInfoWithPage

Request Method:

• POST

Parameters:

json Parameters Explanation:

Sample

Return Sample:

5 Get Users List

Request URL:

• /api/hrm/resful/getHrmUserInfoWithPage

Request Method:

• POST

Parameters:

json Parameters Explanation:

Sample

Return Sample:

6 Sync Division

Explanation: During the synchronization, if the data requested does not exist in OA, the record will be created automatically.

Request URL:

• /api/hrm/resful/synSubcompany

Request Method:

• POST

Parameters:

Sample

Return Sample:

7 Sync Department

Explanation: During the synchronization, if the data requested does not exist in OA, the record will be created in OA automatically.

Request URL:

• /api/hrm/resful/synDepartment

Request Method:

• POST

Parameters:

Sample

Return Sample:

8 Sync Positions

Explanation: During the synchronization, if the data requested does not exist in OA, the record will be created automatically.

Request URL:

• /api/hrm/resful/synJobtitle

Request Method:

• POST

Parameters:

Sample

Return Sample:

9 Sync Users

Explanation: During the synchronization, if the data requested does not exist in OA, the record will be created automatically.

For this interface, validation is against to the workcode, if the workcode exists in the OA system, the interface will take it as update function, if the workcode does not exist in OA, will insert as a new employee.

Request URL:

• /api/hrm/resful/synHrmresource

Request Method:

• POST

Parameters:

Sample

Return Sample: