Registrations - Clock In, GET
API Url
Clock In (CI) variant of generic registration
Ignore the URI, for the correct URI see
http://localhost:16010/ProMarkREST/{DummyRegistration?type=CI}
Success 200
| Field | Type | Description |
|---|---|---|
| actualTime | datetime | The actual time the registration was made |
approvaloptional | object[] | Approval information |
approvalTimeoptional | datetime | Time of approval/rejection, available when status is |
approverIdoptional | string | Id of user that approved or rejected, available when status is |
| deptId | string | Department ID, secondary to approval group |
| groupId | string | Approval group ID |
| level | number |
123 |
rejectCodeoptional | string | Rejection code, in use when status is |
rejectMsgoptional | string | Rejection message, in use when status is |
| status | number |
0123 |
| approvalStatus | number |
0123 |
| attendanceDate | date | The date that the registration belongs to. Typical the date of the registration unless it's a night shift |
clockInoptional | object | Clock In |
absenceoptional | object | Absence |
anyTimeoptional | boolean | |
hoursoptional | number | Absence time in seconds. |
percentoptional | number | Absence time as percentage according to the selected reason setup. |
reasonoptional | object | Absence reason |
backColoroptional | string | Hex encoded RGB background color related to reason |
| code | string | ID of reason |
| description | string | Description of reason |
foreColoroptional | string | Hex encoded RGB foreground color related to reason |
| type | string | Reason type "AA" |
| type | number |
-10123 |
| autoClockIn | boolean | Automatic generated clock in. |
commentoptional | string | Extra data fill in when there are no secondary reasons. |
dayProfIdoptional | string | The day profile used as basis for validating the registration. It is usually the day profile from the employee's schedule or from the clock-in reason (if any). It is alternatively possible to explicitly assign a day profile ID to be used for the registration by setting lockDayProfile to true. If lockDayProfile is not set ProMark will as fill-in the field and conversely the class user should not. |
explicitTimeoptional | datetime | Time entered if fixed reason has ticked the "Explicit corrected time" field |
isOvertimeoptional | boolean | The Clock In is overtime, the overtime button has been used at clock-in. |
lockDayProfileoptional | boolean | See "DayProfId". |
lockUserDataoptional | boolean | Similar to lockDayProfile but works on attendanceDate. Can also in some cases prevent ProMark from automatically changing the selected clock-in reason to something else. |
reasonoptional | object | Reason |
backColoroptional | string | Hex encoded RGB background color related to reason |
| code | string | ID of reason |
| description | string | Description of reason |
distributionoptional | object[] | Distribution on secondary reasons with time. |
| secondaryReason | object | Secondary reason. |
| description | string | Secondary reason description. |
| group | string | Secondary reason group. |
| id | string | Secondary reason id. |
| time | number | Reason distribution time in seconds. |
foreColoroptional | string | Hex encoded RGB foreground color related to reason |
secondaryReasonoptional | object | Secondary reason without distribution. |
| description | string | Secondary reason description. |
| group | string | Secondary reason group. |
| id | string | Secondary reason id. |
| type | string | Reason type "CIE,CIL,CIA,CIS" |
totalTimeAccountIdoptional | string | Account where total time is posted in addition to the account specified on the day profile. |
| closedPeriod | boolean | The registration is in a closed period |
| correctedRegTime | datetime | Registration time adjusted according to setup in ProMark |
| description | string | Default value: Clock In |
| empId | string | Internal employee ID |
| isDeleted | boolean | The registration is deleted and cannot be altered. |
| isErroneous | boolean | The registrations is erroneous and should either be changed or deleted. It's typical a result of offline CI/CO registration where a reason is missing or it's a duplicate. |
locationoptional | object | Geo location of registration |
| latitude | number | Latitude, negative value is west -180 to 180 |
| longitude | number | Longitude, negative value is south -180 to 180 |
| noDelete | boolean | It's not allowed to delete the registration. Some registrations may be readOnly but can still be deleted |
| noTimeChange | boolean | regTime cannot be changed, for instance on absence registrations |
| readOnly | boolean | It's not allowed to edit the registration |
| regTime | datetime | The time of registration |
signOffoptional | object | Sign off information |
| by | string | Used if status = |
| status | number |
012 |
| time | datetime | Used if status = |
| terminalId | string | Numeric ID (optional prefixed by*) of registration terminal. If it's not numeric (it does not start with a digit or *) then it's the ID of the user that changed or created the registration |
| transSeq | number | Unique reference of registration |
| type | string | Default value: CI |
| underValidation | boolean | The registration is under validation |