API: Import Attendance Logs

The purpose of this API is to upload attendance logs to modulus®.

Request

Query String Parameters

Request Body Parameters

The uploaded file must be structured as follows:

File is in CSV format with PIPE “|” separator, the above table should map to the following file content:

1 | 2018-01-01 10:00:00 | I
1 | 2018-01-01 16:30:00 | O

Notes

• Possible direction flag values: ‘I’ for check-in, ‘O’ for check-out.
• Note that, header row must not be included in the uploaded file.
• 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)
• If the device direction is set to “IN”, modulus® accepts all logs as “check-in”, regardless of the direction flag.
• If the device direction is set to “OUT”, modulus® accepts all logs as “check-out”, regardless of the direction flag.
• If the device direction is set to “NONE”, modulus® decides direction of logs depending on the shifts on relevant date.
• Log file size should not exceed 100KB. Larger log amounts should be split into smaller files of sizes less than 100KB.

Responses

Example

curl --request POST 'https://your_account.modulus.biz/api/cmn/PublicAttendanceLogImport?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--form 'device_id=13' \
--form 'log_file=@/D:/files/logs.csv'

{
    "result": true,
    "title": "Success",
    "message": "Attendance logs imported successfully.",
    "object": null
}

{
    "result": false,
    "title": "Bad Request",
    "message": "Device is disabled.",
    "object": null
}

{
    "result": false,
    "title": "Error",
    "message": "Importing file failed.",
    "object": null
}