OitEdgeTimeKeeperv1.0

OitEdgeTimeKeeperv1.0

TimeKeeper is an application used to report employee time and then record that time and the work orders in the OIT Billing service.

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

Base URL: /domains/legacy/oit/edge/timekeeper_v1.0

Version: v1

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

Summary

Path Operation Description
/laborTaskRelationships GET

Get labor task relationships by parameters
/managers GET

Get managers by parameters
POST

Create a manager
/managers/{identifier} DELETE

Delete a manager by identifier
GET

Get a manager by identifier
PUT

Update a manager by identifier
/tasks GET

Get tasks by parameters
POST

Create a task
/tasks/{taskid} DELETE

Delete a task by task ID
GET

Get a task by task ID
PUT

Update a task by task ID
/users GET

Get users by parameters
POST

Create a user
/users/{identifier} DELETE

Delete a user by identifier
GET

Get a user by identifier
PUT

Update a user by identifier
/workOrders GET

Get work orders by parameters

Paths

Get labor task relationships by parameters

GET /laborTaskRelationships

Tags: TimeKeeperv2.0Service

Get labor task relationships by parameters
parameters

string -> a parameter

 query string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get managers by parameters

GET /managers

Tags: TimeKeeperv2.0Service

Get managers by parameters
active

'true' returns active managers, 'false' returns inactive managers, 'any' returns all managers

 query string
expand

Gets all the users that belong to the manager

 query string

Uses default content-types: application/json

200 OK

Returns a list of all managers

getManagers
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Create a manager

POST /managers

Tags: TimeKeeperv2.0Service

Create a manager

Create a new manager

createManager

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

createManagerResponse
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Delete a manager by identifier

DELETE /managers/{identifier}

Tags: TimeKeeperv2.0Service

Delete a manager by identifier
identifier

string ->

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get a manager by identifier

GET /managers/{identifier}

Tags: TimeKeeperv2.0Service

Get a manager by identifier
identifier

string ->

path string
expand

Gets all the users that belong to the manager

 query string

Uses default content-types: application/json

200 OK

Returns a single manager object

getManagers
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Update a manager by identifier

PUT /managers/{identifier}

Tags: TimeKeeperv2.0Service

Update a manager by identifier

Updates an existing manager -> all request body parameters are optional

updateManager
identifier

string ->

path string

Uses default content-types: application/json

200 OK

Returns an updated manager

updateManagerResponse
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get tasks by parameters

GET /tasks

Tags: TimeKeeperv2.0Service

Get tasks by parameters
netid

Allowed values are any user's net id

 query string
weekOf

Only allowed value is any valid date

 query string
startDate

Only allowed value is any valid date

 query string
endDate

Only allowed value is any valid date

 query string
expand

only allowed value is 'users' which expands the user section

 query string
approved

Only allowed values are 'true' or 'false'. Only approved or unapproved tasks can be returned

 query string

Uses default content-types: application/json

200 OK

Returns a list of tasks

getTasks
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Create a task

POST /tasks

Tags: TimeKeeperv2.0Service

Create a task

Creates a task

createTask

Uses default content-types: application/json

200 OK

Returns a created task

createTaskResponse
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Delete a task by task ID

DELETE /tasks/{taskid}

Tags: TimeKeeperv2.0Service

Delete a task by task ID
taskid

string ->

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get a task by task ID

GET /tasks/{taskid}

Tags: TimeKeeperv2.0Service

Get a task by task ID
taskid

string ->

path string
expand

only allowed value is 'users' which expands the user section

 query string

Uses default content-types: application/json

200 OK

Returns a single task object

getTask
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Update a task by task ID

PUT /tasks/{taskid}

Tags: TimeKeeperv2.0Service

Update a task by task ID

updates an existing task

updateTask
taskid

string ->

path string

Uses default content-types: application/json

200 OK

$eturns an updated task object

updateTask
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get users by parameters

GET /users

Tags: TimeKeeperv2.0Service

Get users by parameters
active

'true' returns active users, 'false' returns inactive users, 'any' returns all users

 query string
expand

'mgr' returns the manager of each user, 'tasks' returns tasks associated with that user

 query string

Uses default content-types: application/json

200 OK

Returns a list of users

getUsers
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Create a user

POST /users

Tags: TimeKeeperv2.0Service

Create a user

Creates a new user

createUser

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

createUserResponse
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Delete a user by identifier

DELETE /users/{identifier}

Tags: TimeKeeperv2.0Service

Delete a user by identifier
identifier

string ->

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get a user by identifier

GET /users/{identifier}

Tags: TimeKeeperv2.0Service

Get a user by identifier
identifier

string ->

path string
expand

'mgr' returns the manager of each user, 'tasks' returns tasks associated with that user

 query string

Uses default content-types: application/json

200 OK

Returns an individual user

getUser
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Update a user by identifier

PUT /users/{identifier}

Tags: TimeKeeperv2.0Service

Update a user by identifier

Updates an existing user

updateUser
identifier

string ->

path string

Uses default content-types: application/json

200 OK

Returns an updated user

updateUserResponse
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get work orders by parameters

GET /workOrders

Tags: TimeKeeperv2.0Service

Get work orders by parameters
parameters

string -> a parameter

 query string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Schema definitions

active: boolean

approved: boolean

approvedBy: string

code: string

createManager: object

netid: netid

createManagerResponse: object

netid: netid
firstName: firstName
lastName: lastName
personid: personid
id: id
display: display
active: active

createTask: object

user: user
description: description
hours: hours
workOrder: workOrder
laborTask: laborTask
date: date
approved: approved
approvedBy: approvedBy
dateApproved: dateApproved
relatedTask: relatedTask

createTaskResponse: object

hours: hours
description: description
user: user
relatedTask: relatedTask
approved: approved
workOrder: workOrder
date: date
href: href
id: id
laborTask: laborTask

createUser: object

netid: netid
manager: manager

createUserResponse: object

netid: netid
manager: manager
firstName: firstName
lastName: lastName
personid: personid
id: id
display: display
active: active
prepopulateDate: prepopulateDate

date: string

dateApproved: string

description: string

display: boolean

firstName: string

getManagers: object[]

object
netid: netid
firstName: firstName
lastName: lastName
personid: personid
users: users
display: display

getTask: object[]

object
hours: hours
description: description
user: users
approvedBy: approvedBy
dateApproved: dateApproved
relatedTask: relatedTask
approved: approved
workOrder: workOrder
date: date
href: href
id: id
laborTask: laborTask

getTasks: object[]

object
hours: hours
description: description
user: user
approvedBy: approvedBy
dateApproved: dateApproved
relatedTask: relatedTask
approved: approved
workOrder: workOrder
date: date
href: href
id: id
laborTask: laborTask

getUser: object[]

object
netid: netid
managerObject: managerObject
firstName: firstName
lastName: lastName
personid: personid
prepopulateDate: prepopulateDate
tasks: tasks
display: display
active: active
href: href
id: id

getUsers: object[]

object
netid: netid
managerObject: managerObject
firstName: firstName
lastName: lastName
personid: personid
prepopulateDate: prepopulateDate
display: display
active: active
href: href
id: id

hours: number

href: string

id: string

laborTask: object

name: name
code: code

lastName: string

manager: string

managerObject: object

netid: netid
firstName: firstName
lastName: lastName
personid: personid
users: users
display: display
active: active
href: href
id: id

name: string

netid: string

personid: string

prepopulateDate: string

relatedTask: string

simpleUser: string

tasks: object[]

object
description: description
user: simpleUser
hours: hours
approvedBy: approvedBy
dateApproved: dateApproved
relatedTask: relatedTask
approved: approved
laborTask: laborTask
workOrder: workOrder
date: date
href: href
id: id

updateManager: object

firstName: firstName
lastName: lastName
active: active
display: display

updateManagerResponse: object

netid: netid
firstName: manager
lastName: lastName
personid: personid
display: display
active: active
href: href
id: id

updateTask: object

hours: hours
description: description
user: user
relatedTask: relatedTask
approved: approved
approvedBy: approvedBy
dateApproved: dateApproved
workOrder: workOrder
date: date
href: href
id: id
laborTask: laborTask

updateUser: object

manager: manager
firstName: firstName
lastName: lastName
active: active
display: display
prepopulateDate: prepopulateDate

updateUserResponse: object

netid: netid
manager: manager
firstName: firstName
lastName: lastName
personid: personid
id: id
display: display
active: active
prepopulateDate: prepopulateDate

user: string

users: object[]

object
netid: netid
manager: manager
firstName: manager
lastName: lastName
personid: personid
prepopulateDate: prepopulateDate
display: display
active: active
href: href
id: id

workOrder: string

Service Path: 
/domains/legacy/oit/edge/timekeeper_v1.0
Domain or University API: 
/domains/D/oit/edge/timekeeper_v1.0
Tags: 
domains
legacy
oit
edge
timekeeper_v1.0

Community

 

Don't see your question listed here? Ask!

View This API in the API Store

Get Elevated Access