Rest API for Employee Checkin

rajatkhandeparkar · July 23, 2020, 8:11am

Hi Community,
I was trying to create a POST request for Employee Checkin but encountered the following :
frappe.exceptions.ValidationError: No Employee found for the given employee field value. ‘attendance_device_id’: ‘HR-EMP-00005’
PS: I do have employee ‘HR-EMP-00005’ in my system.
Screenshot%20from%202020-07-23%2013-30-19

Am i missing out something??

rajatkhandeparkar · July 27, 2020, 6:08am

I tried posting data using Postman on to
https://stsdemo.erpnext.com/api/method/erpnext.hr.doctype.employee_checkin.employee_checkin.add_log_based_on_employee_field

In headers:

Authorization:token access key:secret key

Status received:

417 EXPECTATION FAILED

Traceback:
File “/home/frappe/benches/bench-version-13-2020-07-02/apps/frappe/frappe/app.py”, line 64, in application
response = frappe.api.handle()
File “/home/frappe/benches/bench-version-13-2020-07-02/apps/frappe/frappe/api.py”, line 58, in handle
return frappe.handler.handle()
File “/home/frappe/benches/bench-version-13-2020-07-02/apps/frappe/frappe/handler.py”, line 30, in handle
data = execute_cmd(cmd)
File “/home/frappe/benches/bench-version-13-2020-07-02/apps/frappe/frappe/handler.py”, line 69, in execute_cmd
return frappe.call(method, **frappe.form_dict)
File “/home/frappe/benches/bench-version-13-2020-07-02/apps/frappe/frappe/init.py”, line 1085, in call
return fn(*args, **newargs)
File “/home/frappe/benches/bench-version-13-2020-07-02/apps/erpnext/erpnext/hr/doctype/employee_checkin/employee_checkin.py”, line 61, in add_log_based_on_employee_field
frappe.throw(_(“No Employee found for the given employee field value. ‘{}’: {}”).format(employee_fieldname,employee_field_value))
File “/home/frappe/benches/bench-version-13-2020-07-02/apps/frappe/frappe/init.py”, line 396, in throw
msgprint(msg, raise_exception=exc, title=title, indicator=‘red’, is_minimizable=is_minimizable)
File “/home/frappe/benches/bench-version-13-2020-07-02/apps/frappe/frappe/init.py”, line 375, in msgprint
_raise_exception()
File “/home/frappe/benches/bench-version-13-2020-07-02/apps/frappe/frappe/init.py”, line 326, in _raise_exception
raise raise_exception(msg)
frappe.exceptions.ValidationError: No Employee found for the given employee field value. ‘attendance_device_id’: HR-EMP-00003

iRaySpace · July 27, 2020, 10:29am

Hello,

Check your fields again. I think the key is not employee_field_value but employee.

Try to check the source code also. You need to pass on employee_fieldname the field you want to match with.

github.com

frappe/erpnext/blob/version-12/erpnext/hr/doctype/employee_checkin/employee_checkin.py#L57


      
          	:param timestamp: The timestamp of the Log. Currently expected in the following format as string: '2019-05-08 10:48:08.000000'
          	:param device_id: (optional)Location / Device ID. A short string is expected.
          	:param log_type: (optional)Direction of the Punch if available (IN/OUT).
          	:param skip_auto_attendance: (optional)Skip auto attendance field will be set for this log(0/1).
          	:param employee_fieldname: (Default: attendance_device_id)Name of the field in Employee DocType based on which employee lookup will happen.
          	"""
          
          
	if not employee_field_value or not timestamp:
          		frappe.throw(_("'employee_field_value' and 'timestamp' are required."))
          
          
	employee = frappe.db.get_values("Employee", {employee_fieldname: employee_field_value}, ["name", "employee_name", employee_fieldname], as_dict=True)
          	if employee:
          		employee = employee[0]
          	else:
          		frappe.throw(_("No Employee found for the given employee field value. '{}': {}").format(employee_fieldname,employee_field_value))
          
          
	doc = frappe.new_doc("Employee Checkin")
          	doc.employee = employee.name
          	doc.employee_name = employee.employee_name
          	doc.time = timestamp
          	doc.device_id = device_id

Regards,

Ivan

rajatkhandeparkar · July 27, 2020, 6:10pm

Hey Thanks.
Yes i had missed employee_fieldname.

uzumaki_naruto · January 15, 2021, 12:39pm

I’m trying the same thing here. But I do not understand what really is employee_field_value.

Please help me if you guys understand this and help me in getting a successful response from this REST API.
Thanks

walstanb · March 1, 2021, 10:06am

This is the attendance_device_id field which takes employee_field_value in Employee, this number should be same for the employee in your Attendance Device.

ralphgutz · March 6, 2023, 2:08am

Hello, I am a newbie to ERPNext and I want to integrate a fingerprint biometric device to the attendance system. I was reading the documentation, but I cannot open the implementation details anymore (step 4 of integrating erpnext with biometric devices). Could you help me on how I could implement this API?

Aarti_Ladikkar · March 13, 2023, 10:09am

I am facing same error, I am updating biometric device logs to Frappe erp software using C# service, receiving following error, please update me where can I find mapping which is shown in the table image.(posted by @iRaySpace )

Error:
{“exc_type”:“ValidationError”,“exception”:“frappe.exceptions.ValidationError: No Employee found for the given employee field value. ‘attendance_device_id’: 35”,“exc”:“["Traceback (most recent call last):\n File \"apps/frappe/frappe/app.py\", line 66, in application\n response = frappe.api.handle()\n File \"apps/frappe/frappe/api.py\", line 55, in handle\n return frappe.handler.handle()\n File \"apps/frappe/frappe/handler.py\", line 38, in handle\n data = execute_cmd(cmd)\n File \"apps/frappe/frappe/handler.py\", line 76, in execute_cmd\n return frappe.call(method, **frappe.form_dict)\n File \"apps/frappe/frappe/init.py\", line 1473, in call\n return fn(*args, **newargs)\n File \"apps/erpnext/erpnext/hr/doctype/employee_checkin/employee_checkin.py\", line 91, in add_log_based_on_employee_field\n employee_fieldname, employee_field_value\n File \"apps/frappe/frappe/init.py\", line 511, in throw\n as_list=as_list,\n File \"apps/frappe/frappe/init.py\", line 479, in msgprint\n _raise_exception()\n File \"apps/frappe/frappe/init.py\", line 434, in _raise_exception\n raise raise_exception(msg)\nfrappe.exceptions.ValidationError: No Employee found for the given employee field value. ‘attendance_device_id’: 35\n"]”,“_server_messages”:“["{\"message\": \"No Employee found for the given employee field value. ‘attendance_device_id’: 35\", \"title\": \"Message\", \"indicator\": \"red\", \"raise_exception\": 1}"]”}