{"id":3455,"date":"2018-03-04T17:37:50","date_gmt":"2018-03-04T15:37:50","guid":{"rendered":"http:\/\/modulus.help\/kb\/docs\/documentation\/introduction\/api-import-attendance-logs\/"},"modified":"2021-02-17T13:10:41","modified_gmt":"2021-02-17T11:10:41","slug":"api-import-attendance-logs","status":"publish","type":"docs","link":"https:\/\/modulus.help\/kb\/docs\/documentation\/personnel-apis-v1\/api-import-attendance-logs\/","title":{"rendered":"API: Import Attendance Logs"},"content":{"rendered":"

The purpose of this API is to upload attendance logs to modulus®.<\/p>\n

Request<\/h4>\n\n\n\n\n\n\n\n\n
API Name<\/th>\n\nPublicAttendanceLogImport\n<\/td>\n<\/tr>\n
URL<\/th>\nhttps:\/\/your_account.modulus.biz\/api\/hr\/PublicAttendanceLogImport&token=YOUR_TOKEN<\/td>\n<\/tr>\n
Method<\/th>\nPOST<\/td>\n<\/tr>\n
Source<\/th>\nThird Party Server<\/td>\n<\/tr>\n
Recipient<\/th>\nmodulus® Server<\/td>\n<\/tr>\n
Content Type<\/th>\nmultipart\/form-data<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Query String Parameters<\/h4>\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
token<\/th>\nSecurity token retrieved from Authentication API<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Request Body Parameters<\/h4>\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
device_id<\/th>\nThe device ID retrieved from the API PublicAttendanceDeviceList<\/a>.<\/td>\n<\/tr>\n
log_file<\/th>\nFile in CSV format that holds attendance logs to be uploaded. File should be UTF-8 encoded without BOM.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

The uploaded file must be structured as follows:<\/p>\n\n\n\n\n\n\n
Employee ID<\/th>\nDate Time<\/th>\nDirection Flag<\/th>\n<\/tr>\n<\/thead>\n
1<\/td>\n2018-01-01 10:00:00<\/td>\nI<\/td>\n<\/tr>\n
1<\/td>\n2018-01-01 16:30:00<\/td>\nO<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

File is in CSV format with PIPE “|” separator, the above table should map to the following file content:<\/p>\n

1 | 2018-01-01 10:00:00 | I\r\n1 | 2018-01-01 16:30:00 | O<\/code><\/pre>\n
Notes<\/h5>\n
    \n
  • Possible direction flag values: ‘I’ for check-in, ‘O’ for check-out.<\/li>\n
  • Note that, header row must not be included in the uploaded file.<\/li>\n
  • The direction flag is necessary if the device setup on modulus® is marked to accept this flag (i.e. device direction set to “IN\/OUT” value)<\/li>\n
  • If the device direction is set to “IN”, modulus® accepts all logs as “check-in”, regardless of the direction flag.<\/li>\n
  • If the device direction is set to “OUT”, modulus® accepts all logs as “check-out”, regardless of the direction flag.<\/li>\n
  • If the device direction is set to “NONE”, modulus® decides direction of logs depending on the shifts on relevant date.<\/li>\n
  • Log file size should not exceed 100KB. Larger log amounts should be split into smaller files of sizes less than 100KB.<\/li>\n<\/ul>\n
    Responses<\/h4>\n\n\n\n\n\n\n\n\n\n
    HTTP Status<\/th>\nresult<\/th>\ntitle<\/th>\nmessage<\/th>\nobject<\/th>\n<\/tr>\n<\/thead>\n
    Success Responses<\/th>\n<\/tr>\n
    200 OK<\/td>\ntrue<\/td>\nSuccess<\/td>\nAttendance logs imported successfully.<\/td>\nnull<\/td>\n<\/tr>\n
    Failure Responses<\/th>\n<\/tr>\n
    400 Bad Request<\/td>\nfalse<\/td>\nBad Request<\/td>\nDevice ID is missing.
    \nLogs file is missing.
    \nUpload error #error_number
    \nUploaded file is larger than 100 KB.
    \nInvalid file mime type.
    \nInvalid file content.
    \nInvalid Device ID.
    \nDevice is disabled.\n<\/td>\n    		null<\/td>\n<\/tr>\n
    500 Internal Server Error<\/td>\nfalse<\/td>\nError<\/td>\nImporting file failed.<\/td>\nnull<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Example<\/h4>\n\n\n\n\n\n\n\n\n
    Request<\/th>\n\n
    curl --request POST 'https:\/\/your_account.modulus.biz\/api\/cmn\/PublicAttendanceLogImport?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \\\r\n--form 'device_id=13' \\\r\n--form 'log_file=@\/D:\/files\/logs.csv'\r\n<\/code><\/pre>\n<\/td>\n<\/tr>\n
    Success Responses<\/th>\n<\/tr>\n
    200 OK<\/th>\n\n
    {\r\n    \"result\": true,\r\n    \"title\": \"Success\",\r\n    \"message\": \"Attendance logs imported successfully.\",\r\n    \"object\": null\r\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n
    Failure Responses<\/th>\n<\/tr>\n
    400 Bad Request<\/th>\n\n
    {\r\n    \"result\": false,\r\n    \"title\": \"Bad Request\",\r\n    \"message\": \"Device is disabled.\",\r\n    \"object\": null\r\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n
    500 Internal Server Error<\/th>\n\n
    {\r\n    \"result\": false,\r\n    \"title\": \"Error\",\r\n    \"message\": \"Importing file failed.\",\r\n    \"object\": null\r\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"featured_media":0,"parent":3773,"menu_order":2,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"comment_count":0,"_links":{"self":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/3455"}],"collection":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/comments?post=3455"}],"version-history":[{"count":22,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/3455\/revisions"}],"predecessor-version":[{"id":4580,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/3455\/revisions\/4580"}],"up":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/3773"}],"prev":[{"title":"API: List Attendance Devices","link":"https:\/\/modulus.help\/kb\/docs\/documentation\/personnel-apis-v1\/api-list-attendance-devices\/","href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/3453"}],"wp:attachment":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/media?parent=3455"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/doc_tag?post=3455"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}