Registrations - Clock Out, GET

API Url

Clock Out (CO) variant of generic registration

Ignore the URI, for the correct URI see

GET
http://localhost:16010/ProMarkREST/{DummyRegistration?type=CO}

Success 200

FieldTypeDescription
actualTimedatetime

The actual time the registration was made

approvaloptionalobject[]

Approval information

  approvalTimeoptionaldatetime

Time of approval/rejection, available when status is 2 or 3

  approverIdoptionalstring

Id of user that approved or rejected, available when status is 2 or 3

  deptIdstring

Department ID, secondary to approval group

  groupIdstring

Approval group ID

  levelnumber

1: First level approval, 2: Second level approval or 3: Escalated level approval

Allowed values:123
  rejectCodeoptionalstring

Rejection code, in use when status is 3

  rejectMsgoptionalstring

Rejection message, in use when status is 3

  statusnumber

0: No approval, 1: Needs approval, 2: Approved or 3: Rejected

Allowed values:0123
approvalStatusnumber

0: No approval, 1: Needs approval, 2: Approved or 3: Rejected

Allowed values:0123
attendanceDatedate

The date that the registration belongs to. Typical the date of the registration unless it's a night shift

    typenumber

-1: As pre-reported. 0: No absence. 1: Absent percent of day. 2: Absent a number of hours. 3: Absent during a full shift.

Allowed values:-10123
clockOutoptionalobject

Clock Out

  absenceoptionalobject

Absence

    hoursoptionalnumber

Absence time in seconds.

    percentoptionalnumber

Absence time as percentage according to the selected reason setup.

    reasonoptionalobject

Absence reason

      backColoroptionalstring

Hex encoded RGB background color related to reason

      codestring

ID of reason

      descriptionstring

Description of reason

      foreColoroptionalstring

Hex encoded RGB foreground color related to reason

      typestring

Reason type

Allowed values:"AA"
  autoBreakboolean

Action attribute mnot part of the registration; set to true to ensure that breaks are automatically generated if required.

  autoClockOutboolean

TRUE if there is an automatic break end at clock out

  commentoptionalstring

Extra data to fill in when there are no secondary reasons

  coTimeAtNextCIoptionalboolean

TRUE if you want to be prompted for the clock out time at your next clock in

  enteredTimeoptionalnumber

If coTimeAtNextCI is true then the employee is prompted for the actual clock-out time when later clockin-in and the entered time is stored in this field.

  forcedOvertimeoptionalobject
    alternativeoptionalboolean
    endoptionalnumber

Overtime end in seconds

    startoptionalnumber

Overtime start in seconds.

  isOvertimeoptionalboolean

True if the clock out is overtime

  lockUserDataoptionalboolean

In some cases prevents ProMark from automatically changing the selected clock-out reason to something else.

  reasonoptionalobject

Reason for the Clock Out

    backColoroptionalstring

Hex encoded RGB background color related to reason

    codestring

ID of reason

    descriptionstring

Description of reason

    distributionoptionalobject

Distribution on secondary reasons with time

      secondaryReasonobject

Secondary reason

        descriptionstring

Secondary reason description.

        groupstring

Secondary reason group.

        idstring

Secondary reason id.

      timenumber

Reason distribution time in seconds

    foreColoroptionalstring

Hex encoded RGB foreground color related to reason

    secondaryReasonoptionalobject

Secondary reason without distribution

      descriptionstring

Secondary reason description.

      groupstring

Secondary reason group.

      idstring

Secondary reason id.

    typestring

Reason type

Allowed values:"COE,COL,COS"
closedPeriodboolean

The registration is in a closed period

correctedRegTimedatetime

Registration time adjusted according to setup in ProMark

descriptionstring
Default value: Clock Out
empIdstring

Internal employee ID

isDeletedboolean

The registration is deleted and cannot be altered.

isErroneousboolean

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.

locationoptionalobject

Geo location of registration

  latitudenumber

Latitude, negative value is west

Size range: -180 to 180
  longitudenumber

Longitude, negative value is south

Size range: -180 to 180
noDeleteboolean

It's not allowed to delete the registration. Some registrations may be readOnly but can still be deleted

noTimeChangeboolean

regTime cannot be changed, for instance on absence registrations

readOnlyboolean

It's not allowed to edit the registration

regTimedatetime

The time of registration

signOffoptionalobject

Sign off information

  bystring

Used if status = 2: Terminal Id is signed off by employee or User Id if signed off by user

  statusnumber

0: Not required, 1: Pending or 2: Signed off

Allowed values:012
  timedatetime

Used if status = 2: Time of sign off

terminalIdstring

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

transSeqnumber

Unique reference of registration

typestring
Default value: CO
underValidationboolean

The registration is under validation