Timesheet

Returns the current timesheet status for the specified employee.

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/erp/hr/timesheet

Version: v1

Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/{byu_id} GET

Paths

GET /{byu_id}

byu_id

The nine-digit computer-generated ID assigned to each employee

path string , must match ^[0-9]{9}$ #/parameters/byu_id

Uses default content-types: application/json

200 OK

The employee's current timesheet

Example for application/json
{
"byu_id": "999999999",
"international": false,
"jobs": [
{
"clock_in": false,
"employee_record": "0",
"full_part_time": "P",
"job_code_description": "Project Assistant",
"message": "This account code is currently inactive. Please contact your supervisor to update the account code",
"operating_unit": "R5422011",
"period_subtotal": "00:00",
"physical_facilities": false,
"valid_account": false,
"weekly_subtotal": "00:00"
},
{
"clock_in": false,
"employee_record": "1",
"full_part_time": "P",
"job_code_description": "Research Assistant",
"operating_unit": "11233010",
"period_subtotal": "51:41",
"physical_facilities": false,
"valid_account": true,
"weekly_subtotal": "51:41"
}
]
,
"period_total": "51:41",
"weekly_total": "51:41"
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

Example for application/json
{
"status": {
"code": "400",
"message": "No jobs currently active to record punches"
}
}
401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that was not the fault of the user

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Parameter definitions

byu_id byu_id

The nine-digit computer-generated ID assigned to each employee

path string , must match ^[0-9]{9}$

Response definitions

400

Invalid Request - unable to interpret request

Example for application/json
{
"status": {
"code": "400",
"message": "No jobs currently active to record punches"
}
}
401

Authentication required to access data

403

Access denied to protected data

500

Internal Server Error - Error occurred that was not the fault of the user

504

Gateway Timeout

default

Unexpected error

Schema definitions

byu_id: string , must match ^[0-9]{9}$

The nine-digit computer-generated ID assigned to each employee

clock_in: boolean

Specifies if an employee is currently clocked in (true) or not (false).

code: string

The HTTP status code associated with the response.

employee_record: integer (up to 3 chars)

The number that corresponds to a particular job for an employee when they work multiple jobs concurrently on campus.

error_response: object

status: object
message: message
code: code

full_part_time: string , x ∈ { P , F }

Specifies if the employee is part-time (P) or full-time (F).

international: boolean

Indicates that the employee is a non-resident alien (true) or not (false).

job_code_description: string (up to 30 chars)

Department specified description of a specific job.

jobs: object

weekly_subtotal: weekly_subtotal
period_subtotal: period_subtotal
employee_record: employee_record
job_code_description: job_code_description
valid_account: valid_account
clock_in: clock_in
physical_facilities: physical_facilities
full_part_time: full_part_time
message: message
operating_unit: operating_unit

message: string (up to 100 chars)

A user-friendly message indicating why the employee is not able to clock in/out of a particular job.

operating_unit: string (up to 8 chars)

An eight digit alphanumeric field that defines a financial reporting entity.

period_subtotal: string

Aggregate of time worked for the period. If the employee has any uncorrected exceptions it will display --:--

period_total: string

Aggregate of time worked across all jobs for the period. If the employee has any uncorrected exceptions it will display --:--

physical_facilities: boolean

Indicates if the job is in the physical facilities department (true) or not (false).

timesheet: object

weekly_total: weekly_total
period_total: period_total
byu_id: byu_id
international: international
jobs: jobs

valid_account: boolean

Indicates if the account associated with the job is active (true) or not (false). If false, a corresponding message property will be available to display to end users.

weekly_subtotal: string

Aggregate of time worked for the week. If the employee has any uncorrected exceptions it will display --:--

weekly_total: string

Aggregate of time worked across all jobs for the week. If the employee has any uncorrected exceptions it will display --:--

Service Path: 
/domains/erp/hr/timesheet
Domain or University API: 
/domains/erp/hr/timesheet

Community

 

Don't see your question listed here? Ask!