Review exceptions
In this tutorial, we mark exceptions as reviewed.
Mark exceptions as reviewed
The manager calls the Update Timecard as Manager operation using the POST HTTP method to mark exceptions as reviewed.
- POST a request to the following URL:
https://<<hostName>>/api/v1/timekeeping/timecard - Include the standard Headers.
- Include an appropriate JSON call body. Refer to the examples below.
When constructing the JSON body of your request, keep the following points in mind:
- Use the punches/updated array
- In the array, provide the employee ID, punch ID, punch date and time, and the Boolean property
isExceptionResolvedas true
- In the array, provide the employee ID, punch ID, punch date and time, and the Boolean property
- The operation requires an employee ID with start and end dates and times or a symbolic period
Example request
{
"where" : {
"employee" : {
"id" : 309
},
"dateRange" : {
"startDate" : "2017-11-08T10:02:00",
"EndDate" : "2017-11-08T10:05:00"
}
},
"do" : {
"punches" : {
"updated" : [{
"employee" : {
"id" : "309"
},
"id" : 30401,
"punchDtm" : "2017-11-08T10:06:00",
"isExceptionResolved" : true
}
]
}
}
}
Example response
{
"lastUpdates": [
{
"employeeId": 309,
"updateDateTime": "2018-02-08T04:45:43",
"updateByPersonFullName": "Ivan, Holly",
"isEditedInSignedOff": false
}
],
"projects": [],
"overtimeApprovals": [
{
"existingApprovalsOrDenials": [],
"unapprovedSegments": [],
"unapprovedAmount": 0,
"deniedAmount": 0
}
],
"punches": [
{
"id": 6001,
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"punchDtm": "2017-11-08T10:02:00",
"timeZone": {
"id": 134110,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)",
"name": "(GMT -05:00) Eastern Time (USA; Canada)"
},
"enteredOnDtm": "2018-02-08T02:52:24",
"editByType": {
"id": -2
},
"dataSource": {
"id": 3275,
"qualifier": "Ivan, Sean",
"name": "Ivan, Sean"
},
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:06:00",
"applyDate": "2017-11-08",
"id": -7,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": -5
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
}
],
"commentsNotes": [],
"isPhantom": false,
"isScheduled": false,
"updatedOnDtm": "2018-02-08T02:52:24",
"exceptionResolved": false,
"editable": true
},
{
"id": 30401,
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"punchDtm": "2017-11-08T10:06:00",
"timeZone": {
"id": 134110,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)",
"name": "(GMT -05:00) Eastern Time (USA; Canada)"
},
"enteredOnDtm": "2018-02-08T04:45:43",
"editByType": {
"id": -2
},
"dataSource": {
"id": 3294,
"qualifier": "Ivan, Holly",
"name": "Ivan, Holly"
},
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:06:00",
"endDateTime": "2017-11-08T14:02:00",
"applyDate": "2017-11-08",
"id": -8,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 13,
"name": "SHORT_SHIFT",
"description": "SHORT_SHIFT_DSC",
"displayName": "Short Shift",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 3.93,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0.07,
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": -5
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": true,
"transfer": false,
"eventDate": "2017-11-08",
"startException": false,
"endException": true
}
],
"commentsNotes": [],
"isPhantom": false,
"isScheduled": false,
"updatedOnDtm": "2018-02-08T04:45:43",
"exceptionResolved": true,
"editable": true
}
],
"workedShifts": [
{
"id": 30401,
"employee": {
"id": 309
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:06:00",
"startTimezone": {
"id": 134110
},
"endTimezone": {
"id": 134110
},
"roundedStartDateTime": "2017-11-08T10:02:00",
"roundedEndDateTime": "2017-11-08T10:06:00",
"roundedStartTimezone": {
"id": 134110
},
"roundedEndTimezone": {
"id": 134110
},
"unscheduledStartDateTime": "2017-11-08T10:02:00",
"unscheduledEndDateTime": "2017-11-08T18:02:00",
"unscheduledWorkRule": {
"id": 17
},
"inProgress": false,
"workedSpans": [
{
"id": 30401,
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:06:00",
"startTimezone": {
"id": 134110
},
"endTimezone": {
"id": 134110
},
"primaryOrgJob": {
"id": 440
},
"workRule": {
"id": 17
},
"primaryWorkRule": {
"id": 440
},
"orderNumber": 1,
"startPunch": {
"id": 6001,
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"punchDtm": "2017-11-08T10:02:00",
"timeZone": {
"id": 134110,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)",
"name": "(GMT -05:00) Eastern Time (USA; Canada)"
},
"enteredOnDtm": "2018-02-08T02:52:24",
"editByType": {
"id": -2
},
"dataSource": {
"id": 3275,
"qualifier": "Ivan, Sean",
"name": "Ivan, Sean"
},
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:06:00",
"applyDate": "2017-11-08",
"id": 26456,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
}
],
"commentsNotes": [],
"isPhantom": false,
"isScheduled": false,
"updatedOnDtm": "2018-02-08T02:52:24",
"exceptionResolved": false,
"editable": true
},
"endPunch": {
"id": 30401,
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"punchDtm": "2017-11-08T10:06:00",
"timeZone": {
"id": 134110,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)",
"name": "(GMT -05:00) Eastern Time (USA; Canada)"
},
"enteredOnDtm": "2018-02-08T04:45:43",
"editByType": {
"id": -2
},
"dataSource": {
"id": 3294,
"qualifier": "Ivan, Holly",
"name": "Ivan, Holly"
},
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:06:00",
"endDateTime": "2017-11-08T14:02:00",
"applyDate": "2017-11-08",
"id": -12,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 13,
"name": "SHORT_SHIFT",
"description": "SHORT_SHIFT_DSC",
"displayName": "Short Shift",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 3.93,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0.07,
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": true,
"transfer": false,
"eventDate": "2017-11-08",
"startException": false,
"endException": true
}
],
"commentsNotes": [],
"isPhantom": false,
"isScheduled": false,
"updatedOnDtm": "2018-02-08T04:45:43",
"exceptionResolved": true,
"editable": true
},
"scheduledOrgJob": false,
"scheduledWorkRule": false,
"userEnteredOrgJob": false,
"transferOrgJob": false,
"userEnteredWorkRule": false,
"transferWorkRule": false,
"projected": false
}
],
"shiftTotalHours": 240,
"scheduledShiftIds": [],
"projected": false,
"fromSchedule": false
}
],
"hoursWorked": [],
"payCodeEdits": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"paycode": {
"id": 784,
"qualifier": "Call Back",
"name": "Call Back"
},
"id": 2351,
"endDateTime": "2017-11-08T03:00:01",
"durationInHours": 3,
"amountType": "HOUR",
"scheduleAmountType": "AMOUNT_NOT_FROM_SCHEDULE",
"systemGenerated": false,
"editable": true,
"exceptions": [],
"commentsAvailable": false,
"commentsNotes": [],
"itemId": 30451,
"applyDate": "2017-11-08",
"editByType": {
"id": -2
}
},
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"paycode": {
"id": 784,
"qualifier": "Call Back",
"name": "Call Back"
},
"id": 2352,
"endDateTime": "2017-11-08T03:00:01",
"durationInHours": 3,
"amountType": "HOUR",
"scheduleAmountType": "AMOUNT_NOT_FROM_SCHEDULE",
"systemGenerated": false,
"editable": true,
"exceptions": [],
"commentsAvailable": false,
"commentsNotes": [],
"itemId": 30452,
"applyDate": "2017-11-08",
"editByType": {
"id": -2
}
},
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"paycode": {
"id": 784,
"qualifier": "Call Back",
"name": "Call Back"
},
"id": 2353,
"endDateTime": "2017-11-08T03:00:01",
"durationInHours": 3,
"amountType": "HOUR",
"scheduleAmountType": "AMOUNT_NOT_FROM_SCHEDULE",
"systemGenerated": false,
"editable": true,
"exceptions": [],
"commentsAvailable": false,
"commentsNotes": [],
"itemId": 30453,
"applyDate": "2017-11-08",
"editByType": {
"id": -2
}
}
],
"historicalCorrections": [],
"workHolidayCredits": [],
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:06:00",
"applyDate": "2017-11-08",
"id": 26456,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workedShift": {
"id": -10
},
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
},
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:06:00",
"endDateTime": "2017-11-08T14:02:00",
"applyDate": "2017-11-08",
"id": -12,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 13,
"name": "SHORT_SHIFT",
"description": "SHORT_SHIFT_DSC",
"displayName": "Short Shift",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 3.93,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0.07,
"workedShift": {
"id": -10
},
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": true,
"transfer": false,
"eventDate": "2017-11-08",
"startException": false,
"endException": true
}
],
"extendedExceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:06:00",
"applyDate": "2017-11-08",
"id": 26456,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workedShift": {
"id": -10
},
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"actualDateTime": "2017-11-08T10:02:00",
"comments": "",
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
},
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:06:00",
"endDateTime": "2017-11-08T14:02:00",
"applyDate": "2017-11-08",
"id": -12,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 13,
"name": "SHORT_SHIFT",
"description": "SHORT_SHIFT_DSC",
"displayName": "Short Shift",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 3.93,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0.07,
"workedShift": {
"id": -10
},
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"actualDateTime": "2017-11-08T10:06:00",
"comments": "",
"reviewed": true,
"transfer": false,
"eventDate": "2017-11-08",
"startException": false,
"endException": true
}
],
"dailyTotals": [
{
"id": 30401,
"durationInHours": 0.07,
"wages": 2.2,
"durationInDays": 0,
"timeItemId": 30401,
"amountType": "HOUR",
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"fromShift": true,
"totalType": "HOURSANDCOST"
},
...
],
"totals": [
{
"employeeContext": {
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"timezone": {
"id": 13411,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)",
"name": "(GMT -05:00) Eastern Time (USA; Canada)"
}
},
"totalContext": {
"totalType": "Actual totals",
"totalAggregationType": "All",
"totalGroupByType": "All"
},
"aggregatedTotals": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"location": {
"id": 440,
"qualifier": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse",
"name": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse"
},
"job": {
"id": 440,
"qualifier": "RN",
"name": "RN"
},
"payCode": {
"id": 320,
"qualifier": "Regular",
"name": "Regular"
},
"amount": 0.06666666666666667,
"wages": 2.2,
"jobTransfer": false,
"laborCategoryTransfer": false,
"timeItemType": {}
},
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"location": {
"id": 440,
"qualifier": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse",
"name": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse"
},
"job": {
"id": 440,
"qualifier": "RN",
"name": "RN"
},
"payCode": {
"id": 2000000010,
"qualifier": "Actual combined hours",
"name": "Actual combined hours"
},
"amount": 0.06666666666666667,
"wages": 2.2,
"jobTransfer": false,
"laborCategoryTransfer": false,
"timeItemType": {}
},
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"location": {
"id": 440,
"qualifier": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse",
"name": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse"
},
"job": {
"id": 440,
"qualifier": "RN",
"name": "RN"
},
"payCode": {
"id": 677,
"qualifier": "All Regular",
"name": "All Regular"
},
"amount": 0.06666666666666667,
"wages": 2.2,
"jobTransfer": false,
"laborCategoryTransfer": false,
"timeItemType": {}
},
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"location": {
"id": 440,
"qualifier": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse",
"name": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse"
},
"job": {
"id": 440,
"qualifier": "RN",
"name": "RN"
},
"payCode": {
"id": 809,
"qualifier": "Total Hours Worked Retail",
"name": "Total Hours Worked Retail"
},
"amount": 0.06666666666666667,
"wages": 2.2,
"jobTransfer": false,
"laborCategoryTransfer": false,
"timeItemType": {}
},
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"location": {
"id": 440,
"qualifier": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse",
"name": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse"
},
"job": {
"id": 440,
"qualifier": "RN",
"name": "RN"
},
"payCode": {
"id": 784,
"qualifier": "Call Back",
"name": "Call Back"
},
"amount": 9,
"wages": 297,
"jobTransfer": false,
"laborCategoryTransfer": false,
"timeItemType": {}
},
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"location": {
"id": 440,
"qualifier": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse",
"name": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse"
},
"job": {
"id": 440,
"qualifier": "RN",
"name": "RN"
},
"payCode": {
"id": 2000000013,
"qualifier": "Scheduled combined hours",
"name": "Scheduled combined hours"
},
"amount": 0.06666666666666667,
"wages": 2.2,
"jobTransfer": false,
"laborCategoryTransfer": false,
"timeItemType": {}
}
]
}
],
"dailyTotalSummary": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"cumulativeTotal": 32640,
"dailyTotalAmount": {
"HOUR": 32640
},
"hoursAndCostSummaries": {
"HOUR": [
{
"id": 30401,
"durationInHours": 0.07,
"wages": 2.2,
"durationInDays": 0,
"timeItemId": 30401,
"amountType": "HOUR",
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"fromShift": true,
"totalType": "HOURSANDCOST"
},
...
]
}
}
],
"itemTotals": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"itemId": 30401,
"startApplyDate": "2017-11-08",
"endApplyDate": "2017-11-08",
"itemHours": 240
},
...
]
}
Updated about 1 year ago