schm-external-hr-eapi

(0 reviews)

schm-external-hr-eapi

Application description: HR information, including employee, regional, Department information inquiry, for external use
DEV Environment URL (Development): https://schm-api-dev.shiseido.cn/schm-external-hr-eapi
UAT Environment URL (Testing): https://schm-api-test.shiseido.cn/schm-external-hr-eapi
PROD Environment URL (Production): https://schm-api.shiseido.cn/schm-external-hr-eapi

1.Authentication Information

All request headers must contain the following key-value parameters as authentication information. You need to request this information from your administrator.

client_id: fa98****3452
client_secret: 108b****41f2

2.Interface list:

Request address	description
GET /employee	Query employee information
GET /division	Querying division Information
GET /department	Querying department Information
GET /employee_hk	Querying HK employee Information
GET /division_hk	Querying HK division Information
GET /department_hk	Querying HK department Information

3.Interface description

3.1 Access to employee information

Interface request address: /employee
Interface description: Query employee information。
Request method: GET

Request parameter description:

Field Name	Description	Required
pageSize	Number of data entries per page, default is 100	N
pageNo	Current page number, starting from 0, default is 0	N
hiredate	Hire Date, format: yyyy-MM-dd, e.g., 2024-07-31	N
person_id	Input employee ID to query individual information	N
company_code	Company Code	N
empcode	Employee Code	N
empdistrict	Region	N
quitdate	Resignation Date, format: yyyy-MM-dd, e.g., 2024-07-25	N
mlevel_code	Organization Position (Code)	N
servicestatus	Status	N
update_time	Information Change Time, format: yyyy-MM-dd, e.g., 2024-07-25	N

Request body structure example

https://schm-api.shiseido.cn/schm-external-hr-eapi/employee?pageSize=10&pageNo=0

Return structure specification

Description	Field Name
Company Code	company_code
Company Short Name	company_short_name
Employee Code	empcode
Name	c_name
Name (EN)	e_name
Last Name (EN)	last_name_en
First Name (EN)	first_name_en
Company Name	company_name
Company Name (EN)	company_name_en
Division Code	divisioncode3
Division Name	Division_name
Division Name (EN)	Division_name_en
Department Code	departmentcode4
Department Name	Department_name
Department Name (EN)	Department_name_en
Sub-department Code	sub_departmentcode5
Sub-department Name	Sub_Department_name
Sub-department Name (EN)	Sub_Department_name_en
Group Code	groupcode6
Group Name	Group_name
Group Name (EN)	Group_name_en
BC/BA Code	teamcode7
BC/BA Name	team_name
BC/BA Name (EN)	team_name_en
Company Phone	businessphone
Company Email	email
Nationality	country
Region	empdistrict
Hire Date	hiredate
Resignation Date	quitdate
Organizational Position (Name)	hrlevel
Organizational Position (Code)	mlevel_code
Mobile Phone	mobile
Status	servicestatus
Deletion Flag	del_flag
Deletion Time	del_time
Gender	gender
Information Update Time	update_time
Valid Hire Date	hirevalid
SF Employee Code	sf_empcode
Cost Center	costcenter
Lock Flag	lockflag
Brand	brand
Position	ddposition
Position Qualification	posqual
HR Level (EN)	hrlevel_en
Position Description (EN)	e_title
Date of Birth	birthday
Department Code (SF)	sf_departmentId
Department Name (SF) (EN)	sf_departmentName
Direct Supervisor Employee Code	sup_empcode
Direct Supervisor SF Employee Code	sup_sf_empcode
Direct Supervisor Name	sup_empname
Cost Center Company	company_costcent
store code	description

Return structure example

[
  {
    "company_code": "2",
    "company_short_name": "SZC",
    "empcode": "00000009",
    "c_name": "沈 若慰",
    "e_name": "ruowei shen",
    "last_name_en": "shen",
    "first_name_en": "ruowei",
    "company_name": "资生堂化妆品制造有限公司",
    "company_name_en": "Shiseido Cosmetics Manufacturing Co.,Ltd.",
    "divisioncode3": "",
    "division_name": "",
    "division_name_en": "",
    "departmentcode4": "",
    "department_name": "",
    "department_name_en": "",
    "sub_departmentcode5": "",
    "sub_department_name": "",
    "sub_department_name_en": "",
    "groupcode6": "",
    "group_name": "",
    "group_name_en": "",
    "teamcode": "",
    "team_name7": "",
    "team_name_en": "",
    "businessphone": "021-xxxxxx-xxxx",
    "email": "",
    "country": "中国",
    "empdistrict": "",
    "hiredate": "xxxx-xx-xxT00:00:00",
    "quitdate": "xxxx-xx-xxT00:00:00",
    "hrlevel": "职员",
    "mlevel_code": "A12",
    "mobile": "xxxxxxx",
    "servicestatus": "0",
    "del_flag": 0,
    "del_time": null,
    "gender": "M",
    "update_time": "2023-10-26T02:43:43.473",
    "hirevalid": "xxxx-xx-xxT00:00:00",
    "sf_empcode": "",
    "costcenter": "B1Z22ZZZZZ",
    "lockflag": 0,
    "brand": null,
    "ddposition": null,
    "posqual": null,
    "hrlevel_en": "Director",
    "e_title": null,
    "birthday": null,
    "sf_departmentid": null,
    "sf_departmentname": null,
    "sup_empcode": "",
    "sup_sf_empcode": "",
    "sup_empname": "",
    "company_costcent": "SCS",
    "description": "10200250"
  },
  {
    "company_code": "1",
    "company_short_name": "SCH",
    "empcode": "00000011",
    "c_name": "桂海平",
    "e_name": "Emily GUI",
    "last_name_en": "GUI",
    "first_name_en": "Emily",
    "company_name": "资生堂（中国）投资有限公司",
    "company_name_en": "Shiseido China Co., Ltd.",
    "divisioncode3": null,
    "division_name": "",
    "division_name_en": "",
    "departmentcode4": null,
    "department_name": "",
    "department_name_en": "",
    "sub_departmentcode5": "",
    "sub_department_name": "",
    "sub_department_name_en": "",
    "groupcode6": "",
    "group_name": "",
    "group_name_en": "",
    "teamcode": "",
    "team_name7": "",
    "team_name_en": "",
    "businessphone": "021-xxxxxx/xxxx",
    "email": "guihaiping@shiseido.cn",
    "country": "",
    "empdistrict": "上海",
    "hiredate": "2005-05-01T00:00:00",
    "quitdate": "2022-06-30T00:00:00",
    "hrlevel": "部长",
    "mlevel_code": "A01",
    "mobile": "xxxxxxx",
    "servicestatus": "0离职",
    "del_flag": 0,
    "del_time": null,
    "gender": "F",
    "update_time": "2024-07-13T03:45:26.92",
    "hirevalid": "xxxx-xx-xxT00:00:00",
    "sf_empcode": "10030201",
    "costcenter": "A1143ZZZZZ",
    "lockflag": 0,
    "brand": "Common",
    "ddposition": "NONE",
    "posqual": null,
    "hrlevel_en": "Director",
    "e_title": "Head of Employee Communication Department",
    "birthday": "xxx-xx-xxT00:00:00",
    "sf_departmentid": null,
    "sf_departmentname": null,
    "sup_empcode": "00035924",
    "sup_sf_empcode": "10031424",
    "sup_empname": "崔锐",
    "company_costcent": "SCH",
    "description": null
  }
]

3.2 Regional information query

Interface request address: /division
Interface description: Regional information query
Request method: GET

Request parameter description:

Field Name	Description	Required
pageSize	Number of data entries per page, default is 100	N
pageNo	Current page number, starting from 0, default is 0	N
division_id	division code	N
status	division status	N

Request body structure example

https://schm-api.shiseido.cn/schm-external-hr-eapi/division?pageSize=10&pageNo=0

Return structure specification

SF field	Interface return field	Description	remark
externalCode	division_id	Division ID
startDate	effective_as_of	effective date
name	division_name	name of a department	All use English names
status	status	status	A - Active / I - Inactive
cust_LegalEntityProp	companycode	company code	If you belong to multiple companies, only C0100-SCH is used

Return structure example

[
  {
    "division_id": "60020001",
    "effective_as_of": "2001-12-18T00:00:00",
    "division_name": "Shiseido China Innovation Center",
    "status": "A",
    "companycode": "H0700"
  },
  {
    "division_id": "60020101",
    "effective_as_of": "2024-04-01T00:00:00",
    "division_name": "Luxury Brands Unit",
    "status": "A",
    "companycode": "C0100"
  }
]

3.3 Department information inquiry

Interface request address: /department
Interface description: Department information inquiry
Request method: GET

Request parameter description:

Field Name	Description	Required
pageSize	Number of data entries per page, default is 100	N
pageNo	Current page number, starting from 0, default is 0	N
departmen_id	department code	N
status	department status	N

Request body structure example

https://schm-api.shiseido.cn/schm-external-hr-eapi/department?pageSize=10&pageNo=0

Return structure specification

SF field	Interface return field	Description	remark
externalCode	departmen_id	Department ID
startDate	effective_as_of	effective date
cust_DivisionProp	Division	this department	If parent is empty, it is the parent Division of the department
name	department_name	name of a department	All use English names
parent	parent_department	Superior department code
status	status	status	A - Active , I - Inactive
cust_LegalEntityProp	companycode	company code	If you belong to multiple companies, only C0100-SCH is used

Return structure example

[
  {
    "department_id": "60020001",
    "effective_as_of": "2001-12-18T00:00:00",
    "division": "60020001",
    "department_name": "President & C.O.O.",
    "parent_department": "60020001",
    "status": "A",
    "companycode": "H0700"
  },
  {
    "department_id": "60020002",
    "effective_as_of": "2001-12-18T00:00:00",
    "division": "60020001",
    "department_name": "Vice President",
    "parent_department": "60020001",
    "status": "A",
    "companycode": "H0700"
  }
]

3.4 HongKong employee information

Interface request address: /employee_hk
Interface description: Query HongKong employee information。
Request method: GET

Request parameter description:

The return structure is exactly the same as the original.

Field Name	Description	Required
pageSize	Number of data entries per page, default is 100	N
pageNo	Current page number, starting from 0, default is 0	N
hiredate	Hire Date, format: yyyy-MM-dd, e.g., 2024-07-31	N
company_code	Company Code	N
empcode	Employee Code	N
empdistrict	Region	N
quitdate	Resignation Date, format: yyyy-MM-dd, e.g., 2024-07-25	N
mlevel_code	Organization Position (Code)	N
servicestatus	Status	N
update_time	Information Change Time, format: yyyy-MM-dd, e.g., 2024-07-25	N
company_costcent	company costcent	N

Request body structure example

https://schm-api.shiseido.cn/schm-external-hr-eapi/employee_hk?pageSize=10&pageNo=0

Return structure specification

Description	Field Name
Company Code	company_code
Company Short Name	company_short_name
Employee Code	empcode
Name	c_name
Name (EN)	e_name
Last Name (EN)	last_name_en
First Name (EN)	first_name_en
Company Name	company_name
Company Name (EN)	company_name_en
Division Code	divisioncode3
Division Name	Division_name
Division Name (EN)	Division_name_en
Department Code	departmentcode4
Department Name	Department_name
Department Name (EN)	Department_name_en
Sub-department Code	sub_departmentcode5
Sub-department Name	Sub_Department_name
Sub-department Name (EN)	Sub_Department_name_en
Group Code	groupcode6
Group Name	Group_name
Group Name (EN)	Group_name_en
BC/BA Code	teamcode7
BC/BA Name	team_name
BC/BA Name (EN)	team_name_en
Company Phone	businessphone
Company Email	email
Nationality	country
Region	empdistrict
Hire Date	hiredate
Resignation Date	quitdate
Organizational Position (Name)	hrlevel
Organizational Position (Code)	mlevel_code
Mobile Phone	mobile
Status	servicestatus
Deletion Flag	del_flag
Deletion Time	del_time
Gender	gender
Information Update Time	update_time
Valid Hire Date	hirevalid
SF Employee Code	sf_empcode
Cost Center	costcenter
Lock Flag	lockflag
Brand	brand
Position	ddposition
Position Qualification	posqual
HR Level (EN)	hrlevel_en
Position Description (EN)	e_title
Date of Birth	birthday
Department Code (SF)	sf_departmentId
Department Name (SF) (EN)	sf_departmentName
Direct Supervisor Employee Code	sup_empcode
Direct Supervisor SF Employee Code	sup_sf_empcode
Direct Supervisor Name	sup_empname
Cost Center Company	company_costcent
admin or trade	admin_or_trade

3.5 HongKong Regional information query

Interface request address: /division_hk
Interface description: HK Regional information query
Request method: GET

Request parameter description:

Field Name	Description	Required
pageSize	Number of data entries per page, default is 100	N
pageNo	Current page number, starting from 0, default is 0	N
externalCode	division code	N
status	division status	N

Request body structure example

https://schm-api.shiseido.cn/schm-external-hr-eapi/division_hk?pageSize=10&pageNo=0

Return structure specification

SF field	Interface return field	Description	remark
externalCode	division_id	Division ID
startDate	effective_as_of	effective date
name	division_name	name of a department	All use English names
status	status	status	A - Active / I - Inactive
cust_LegalEntityProp	companycode	company code	If you belong to multiple companies, only C0100-SCH is used

Return structure example

[
  {
    "division_id": "60020001",
    "effective_as_of": "2001-12-18T00:00:00",
    "division_name": "Shiseido China Innovation Center",
    "status": "A",
    "companycode": "H0700"
  },
  {
    "division_id": "60020101",
    "effective_as_of": "2024-04-01T00:00:00",
    "division_name": "Luxury Brands Unit",
    "status": "A",
    "companycode": "C0100"
  }
]

3.6 HongKong Department information inquiry

Interface request address: /department_hk
Interface description: HK Department information inquiry
Request method: GET

Request parameter description:

Field Name	Description	Required
pageSize	Number of data entries per page, default is 100	N
pageNo	Current page number, starting from 0, default is 0	N
externalCode	department code	N
status	department status	N

Request body structure example

https://schm-api.shiseido.cn/schm-external-hr-eapi/department_hk?pageSize=10&pageNo=0

Return structure specification

SF field	Interface return field	Description	remark
externalCode	departmen_id	Department ID
startDate	effective_as_of	effective date
cust_DivisionProp	Division	this department	If parent is empty, it is the parent Division of the department
name	department_name	name of a department	All use English names
parent	parent_department	Superior department code
status	status	status	A - Active , I - Inactive
cust_LegalEntityProp	companycode	company code	If you belong to multiple companies, only C0100-SCH is used

Return structure example

[
  {
    "department_id": "60020001",
    "effective_as_of": "2001-12-18T00:00:00",
    "division": "60020001",
    "department_name": "President & C.O.O.",
    "parent_department": "60020001",
    "status": "A",
    "companycode": "H0700"
  },
  {
    "department_id": "60020002",
    "effective_as_of": "2001-12-18T00:00:00",
    "division": "60020001",
    "department_name": "Vice President",
    "parent_department": "60020001",
    "status": "A",
    "companycode": "H0700"
  }
]

Reviews

schm-external-hr-eapi doesn't have any reviews yet

home

schm-external-hr-eapi

Directory

1.Authentication Information

2.Interface list:

3.Interface description

3.1 Access to employee information

Request parameter description:

Request body structure example

Return structure specification

Return structure example

3.2 Regional information query

Request parameter description:

Request body structure example

Return structure specification

Return structure example

3.3 Department information inquiry

Request parameter description:

Request body structure example

Return structure specification

Return structure example

3.4 HongKong employee information

Request parameter description:

Request body structure example

Return structure specification

3.5 HongKong Regional information query

Request parameter description:

Request body structure example

Return structure specification

Return structure example

3.6 HongKong Department information inquiry

Request parameter description:

Request body structure example

Return structure specification

Return structure example

Reviews