Integration of segment records (via API)

The purpose of this article is to describe the sequence of API calls necessary for integrating segment records into Endalia. The described scenario targets segment records from time-stamping devices. For other scenarios, consult the  Integrations section.

TABLE OF CONTENTS

• 1. Output Data
• 2. Input Data
• 3. Use Case: Rewrite records

1. Output Data

HR uses Endalia to register employees and associated users. In this case, it is proposed that the device provider collects these data from Endalia and uploads them to their system via API. 

If minimal data is required to create the employee, it is recommended to refer to the user endpoint  APIs: Details - Endalia HR API

[{

    "EmpID": 1,

    "EmpCode": "123456",

    "EmpFullName": "John Doe",

    "CardID": "38571428Z",

    "Username": "john.doe",

    "ID": "00000000-0000-0000-0000-000000000001",

    "RoleKey": "Admin; Employee; etc",

    "Rolename": "Role 1"

}]

The provider integrates these data through periodic synchronization (daily or with the estimated periodicity). 

If you need to obtain additional data. You can refer to the outbound employee API, which contains more employee data (such as contracts APIs: Details - Endalia HR API )

2. Input Data

The provider must integrate the segment records into Endalia. Segments must be complete (with start time and end time). 

This endpoint registers segments and not events, so integration must occur once data has been consolidated at the source.

3. Use Case: Rewrite records

If you need to delete the records of a day and reload segments:

In Endalia, APIs: Details - Endalia HR API (https://api.endaliahr.com/inbound/time/api/inbound/v1/stretches/employees)

The endpoint has OverwriteStretch

[{

    "Errors": [{

        "ErrorMessage": "string",

        "PropertyName": "string",

        "ErrorType": "string"

    }],

    "RowID": 0,

    "CardID": "38571428Z",

    "EmpCode": "00154",

    "Employee": "John Doe",

    "EmpID": 0,

    "Day": "2021-01-01T12:00:00Z",

    "TimeZone": "(UTC+01:00) Brussels, Copenhagen, Madrid, Paris",

    "Start": "2021-01-01T08:00:00Z",

    "End": "2021-01-01T05:00:00Z",

    "StretchType": "Work",

    "OverwriteStretch": "Yes",

    "StretchTypeID": 0

}]

If you need to rewrite a day, for example, on 25/11/2025 and the employee had the following segments: 

25/11/2025 22:00 - 02:00 

26/11/2025 02:00 - 04:00   ---> This is a night record with the reference date 25/11/2025 

 And delete both segments.