Sign-off timecards

Sign off on an employee timecard

The manager calls the Sign Off Employee Timecard as Manager operation using the POST HTTP method to sign off an employee's timecard.

1. POST a request to the following URL: https://<<hostName>>/api/v1/timekeeping/timecard_signoffs
2. Include the standard Headers.
3. Include the following Query Parameter:
   • timeframe_id : <<timeframeId>>
4. Include an appropriate JSON call body. Refer to the examples below.

Example request

In this example, the manager signs off on an employee's timecard using employee ID 308. If a manager mistakenly signs off on a timecard, use the same endpoint and request body with the DELETE HTTP method to remove the manager signoff.

{
    "id": 308
}

Example response

The response returns a HTTP status code 204 with an empty response body. Subsequent attempts to sign off on the same employee's timecard result in an error response body. For example:

{
    "errorCode": "WTK-165000",
    "message": "Timecard is already signed off."
}

View employee timecard signoffs

The manager calls the Retrieve Signoffs as Manager operation using the GET HTTP method to view employee timecard signoffs.

1. Send a GET request to the following URL: https://<<hostName>>/api/v1/timekeeping/timecard_signoffs
2. Include the standard Headers.
3. Include the following Query Parameter:
   • employee_id : <<employeeId>>

Example response

[
    {
        "hireDate": "2016-08-14",
        "managerSignOffThroughDate": "2018-02-04",
        "signOffLockThroughDateTime": "3000-01-01T00:00:00",
        "signOffPending": false,
        "employee": {
            "id": 308,
            "qualifier": "10027",
            "name": "10027"
        },
        "carryForwardDates": [
            "2018-02-04"
        ]
    }
]