Termination
This API is used to get job termination information for an employee. The service will return a no_security element if the calling user does not have security to the data.
More information: https://it.byu.edu
Contact Info: api@byu.edu
Base URL: /domains/erp/hr/termination
Version: v1
Default response content-types: application/json
Schemes: https
Summary
Path | Operation | Description |
---|---|---|
/* | GET |
Paths
GET /*
byu_id | Employee ID | query | string , must match ^[0-9]{9}$ |
Uses default content-types: application/json
- 200 OK
-
The default response type is JSON. Add an Accept header with value=application/xml to return an XML response.
Example for application/json{
"employee_data": {
"birthdate": "2005-02-17",
"byu_id": "123456789",
"name": "Seed,Johnny Apple",
"terminations": [
{
"account_code": "11112222-3333-00000",
"action": "TER",
"alternate_job_description": {
},
"department_description": "Biological Science",
"department_id": "7890",
"effective_date": "2016-10-27",
"email_address": "johnny_appleseed@byu.edu",
"employee_class": "S",
"employee_class_description": "SE Student Hourly",
"job_title": "Landscape Architect",
"last_hire_date": "2016-10-27",
"pay_rate": "10",
"pay_rate_type": "Hourly",
"pay_status": "I",
"record": "1",
"supervisor_id": "456789123",
"supervisor_name": "Newton,Sir Isaac",
"termination_date": "2016-11-27",
"workgroup": "STHREG"
}
]
}
}
Schema definitions
- byu_id: byu_id
-
- name: name
-
- birthdate: birthdate
-
- terminations: terminations
-
- no_security: no_security
-
This response means that you have security to view the information for the requested employee, but no hire information exists in the database for the employee.
This message will be returned if the calling user does not have security to see the hire information for the requested employee.
- record: record
-
- effective_date: effective_date
-
- action: action
-
- last_hire_date: last_hire_date
-
- pay_status: pay_status
-
- account_code: account_code
-
- termination_date: termination_date
-
- department_id: department_id
-
- department_description: department_description
-
- job_title: job_title
-
- employee_class: employee_class
-
- employee_class_description: employee_class_description
-
- email_address: email_address
-
- supervisor_id: supervisor_id
-
- supervisor_name: supervisor_name
-
- workgroup: workgroup
-
- pay_rate: pay_rate
-
- pay_rate_type: pay_rate_type
-
- alternate_job_description: alternate_job_description
-
- no_data: no_data
-
Service Path:
/domains/erp/hr/termination
Domain or University API:
/domains/erp/hr/termination