Employees

Employees Resource of the University API. Returns information about BYU employees.

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

Base URL: /byuapi/employees

Version: v1

Schemes:

Summary

Path Operation Description
/* GET

Returns a list of employees based on query parameters.

/{byu_id}* GET

Returns data for a specific employee.

/{byu_id}/compensations GET

Get the compensation-related data for the employee.

/{byu_id}/date_of_birth GET

Get date of birth data for the employee.

/{byu_id}/employment_actions GET

Get employment action data for the employee.

/{byu_id}/hr_data GET

Get the HR Related data for the employee.

/{byu_id}/jobs GET

Returns job data for the specified employee

/{byu_id}/paygroups GET

Get the paygroup data for the employee.

/{byu_id}/ssn GET

Get the SSN data for the employee.

Paths

Returns a list of employees based on query parameters.

GET /*

Returns a list of employees based on query parameters.

department_id

A 4 digit code representing a university department.

query string #/parameters/department_id
200 OK #/responses/query_200

Success

Example for application/json
{
"links": {
}
,
"metadata": {
"collection_size": 1
}
,
"values": [
{
"basic": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"first_name": {
"api_type": "related",
"display_label": "First Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "Cosmo"
}
,
"middle_name": {
"api_type": "related",
"display_label": "Middle Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "James"
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmo"
}
,
"surname": {
"api_type": "related",
"display_label": "Last Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "Cougar"
}
}
,
"links": {
}
,
"metadata": {
}
}
]
}
400 Bad Request #/responses/query_400

Bad Request

Example for application/json
{
"validation_information": [
"Department Id is required."
]
,
"validation_response": {
"code": 400,
"message": "Bad Request"
}
}
403 Forbidden #/responses/403

Forbidden

404 Not Found #/responses/query_404

Department Not Found

Example for application/json
{
"validation_information": [
"Too many employees to return at once."
]
,
"validation_response": {
"code": 400,
"message": "Bad Request"
}
}
500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Returns data for a specific employee.

GET /{byu_id}*

Tags: employees

Returns date for a specific employee. An optional field_sets parameter can be specified that will return additional information.

byu_id

A 9 digit employee ID.

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

A comma-separated list of Field Sets to call the API for. If none are specified, basic is assumed.

query string[] basic , comma separated (field_sets=aaa,bbb) #/parameters/field_sets
200 OK #/responses/employee_200

Success

Example for application/json
{
"basic": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"first_name": {
"api_type": "related",
"display_label": "First Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "Cosmo"
}
,
"hr_status": {
"api_type": "derived",
"description": "Active",
"display_label": "Primary HR Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/hr_statuses",
"value": "A"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"middle_name": {
"api_type": "related",
"display_label": "Middle Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "James"
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
,
"surname": {
"api_type": "related",
"display_label": "Last Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "Cougar"
}
}
,
"compensations": {
"links": {
}
,
"metadata": {
"collection_size": 1
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"compensation_rate": {
"api_type": "read-only",
"display_label": "Compensation Rate",
"value": 50000
}
,
"compensation_rate_frequency": {
"api_type": "read-only",
"description": "Annual",
"display_label": "Compensation Rate Frequency",
"domain": "https://api.byu.edu/byuapi/meta/employees/compensation_rate_frequencies",
"value": "A"
}
,
"effective_date": {
"api_type": "system",
"display_label": "Effective Date",
"key": true,
"value": "2017-09-01"
}
,
"effective_sequence": {
"api_type": "system",
"display_label": "Effective Sequence",
"key": true,
"value": 0
}
,
"employee_record_number": {
"api_type": "system",
"display_label": "Employee Record Number",
"key": true,
"value": 0
}
,
"hr_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/hr_statuses",
"value": "A"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
}
]
}
,
"date_of_birth": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"date_of_birth": {
"api_type": "related",
"display_label": "Date of Birth",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "1847-07-24"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
}
,
"employment_actions": {
"links": {
}
,
"metadata": {
"collection_size": 1
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"effective_date": {
"api_type": "system",
"display_label": "Effective Date",
"key": true,
"value": "2017-09-01"
}
,
"effective_sequence": {
"api_type": "system",
"display_label": "Effective Sequence",
"key": true,
"value": 0
}
,
"employee_record_number": {
"api_type": "system",
"display_label": "Employee Record Number",
"key": true,
"value": 0
}
,
"employment_action": {
"api_type": "read-only",
"description": "Data Change",
"display_label": "Employment Action",
"value": "DTA"
}
,
"employment_action_reason": {
"api_type": "read-only",
"description": "Data Change",
"display_label": "Employment Action",
"value": "ANU"
}
,
"hr_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/hr_statuses",
"value": "A"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
}
]
}
,
"hr_data": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"date_of_death": {
"api_type": "related",
"display_label": "Date of Death",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": null
}
,
"hr_status": {
"api_type": "derived",
"description": "Active",
"display_label": "Primary HR Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/hr_statuses",
"value": "A"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
,
"original_hire_date": {
"api_type": "derived",
"display_label": "Original Hire Date",
"value": "2011-07-26"
}
,
"restricted_person": {
"api_type": "read-only",
"display_label": "Restricted",
"long_description": "The data in this record is not restricted.",
"value": false
}
}
,
"jobs": {
"links": {
}
,
"metadata": {
"collection_size": 1
}
,
"values": [
{
"account": {
"api_type": "read-only",
"description": "Admin Salaries-Reg-(FT)",
"display_label": "Account",
"value": "1234"
}
,
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"chartblock": {
"api_type": "read-only",
"display_label": "Chartblock",
"value": "12345678-1234-12345"
}
,
"class": {
"api_type": "read-only",
"description": "Unclassified",
"display_label": "Class",
"value": "00000"
}
,
"department": {
"api_type": "read-only",
"description": "BYU Mascot",
"display_label": "Department",
"domain": "https://api.byu.edu/byuapi/meta/employees/departments",
"value": "1234"
}
,
"division_id": {
"api_type": "read-only",
"description": "BYU Mascots",
"display_label": "Division",
"domain": "https://api.byu.edu/byuapi/meta/employees/divisions",
"value": "1234"
}
,
"effective_date": {
"api_type": "system",
"display_label": "Effective Date",
"key": true,
"value": "2017-09-01"
}
,
"effective_sequence": {
"api_type": "system",
"display_label": "Effective Sequence",
"key": true,
"value": 0
}
,
"empl_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Employee Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/empl_statuses",
"value": "A"
}
,
"employee_category": {
"api_type": "read-only",
"description": "Full Time",
"display_label": "Employee Category",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_categories",
"value": "FT"
}
,
"employee_classification": {
"api_type": "read-only",
"description": "Administrative Staff",
"display_label": "Employee Classification",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_classifications",
"value": "ADM"
}
,
"employee_group": {
"api_type": "read-only",
"description": "Administrative",
"display_label": "Employee Group",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_groups",
"value": "ADM"
}
,
"employee_record_number": {
"api_type": "system",
"display_label": "Employee Record Number",
"key": true,
"value": 0
}
,
"employee_standing": {
"api_type": "derived",
"description": "Active",
"display_label": "Employee Standing",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_standings",
"value": "ACT"
}
,
"employee_status": {
"api_type": "read-only",
"description": "Full-Time",
"display_label": "Employee Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_statuses",
"value": "FT"
}
,
"employee_workgroup": {
"api_type": "read-only",
"display_label": "Work Group",
"value": null
}
,
"employment_action": {
"api_type": "read-only",
"description": "Data Change",
"display_label": "Employment Action",
"value": "DTA"
}
,
"full_part_time": {
"api_type": "read-only",
"description": "Full-Time",
"display_label": "Full-Time or Part-Time",
"domain": "https://api.byu.edu/byuapi/meta/employees/ft_pt_statuses",
"value": "F"
}
,
"hire_date": {
"api_type": "derived",
"display_label": "Hire Date",
"value": "2015-04-21"
}
,
"hr_empl_class_code": {
"api_type": "read-only",
"description": "Admin",
"display_label": "HR Employee Class Code",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_classes",
"long_description": "Administrative",
"value": "B"
}
,
"hr_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/hr_statuses",
"value": "A"
}
,
"job_code": {
"api_type": "read-only",
"description": "BYU Mascot",
"display_label": "Job Code",
"domain": "https://api.byu.edu/byuapi/meta/employees/job_codes",
"value": "123456"
}
,
"last_date_worked": {
"api_type": "read-only",
"display_label": "Last Date Worked",
"value": null
}
,
"last_hire_date": {
"api_type": "read-only",
"display_label": "Hire Date",
"value": "2015-04-21"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"months_ft_service": {
"api_type": "derived",
"display_label": "Months of Full-Time Service",
"value": 50
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
,
"operating_unit": {
"api_type": "read-only",
"description": "App Dev Enterprise Resource Pl",
"display_label": "Operating Unit",
"value": "12345678"
}
,
"position_number": {
"api_type": "read-only",
"description": "BYU Mascot",
"display_label": "Position Number",
"domain": "https://api.byu.edu/byuapi/meta/employees/positions",
"value": "12345678"
}
,
"regular_temp": {
"api_type": "read-only",
"description": "Regular",
"display_label": "Regular or Temporary",
"domain": "https://api.byu.edu/byuapi/meta/employees/reg_temp_statuses",
"value": "R"
}
,
"reports_to": {
"byu_id": {
"api_type": "related",
"display_label": "BYU Id",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "987654321"
}
,
"first_name": {
"api_type": "related",
"display_label": "First Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "Brigham"
}
,
"middle_name": {
"api_type": "related",
"display_label": "Middle Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "A"
}
,
"surname": {
"api_type": "related",
"display_label": "Last Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "Young"
}
}
,
"termination_date": {
"api_type": "read-only",
"display_label": "Termination Date",
"value": null
}
}
]
}
,
"links": {
}
,
"metadata": {
"field_sets_available": [
"basic",
"hr_data",
"ssn",
"date_of_birth",
"jobs",
"compensations",
"paygroups",
"employment_actions"
]
,
"field_sets_default": [
"basic"
]
,
"field_sets_returned": [
"basic",
"hr_data",
"jobs",
"compensations",
"ssn",
"date_of_birth",
"paygroups",
"employment_actions"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"paygroups": {
"links": {
}
,
"metadata": {
"collection_size": 1
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"effective_date": {
"api_type": "system",
"display_label": "Effective Date",
"key": true,
"value": "2017-09-01"
}
,
"effective_sequence": {
"api_type": "system",
"display_label": "Effective Sequence",
"key": true,
"value": 0
}
,
"employee_record_number": {
"api_type": "system",
"display_label": "Employee Record Number",
"key": true,
"value": 0
}
,
"hr_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/hr_statuses",
"value": "A"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
,
"paygroup": {
"api_type": "read-only",
"description": "BYU Admin Pay Group",
"display_label": "Paygroup",
"domain": "https://api.byu.edu/byuapi/meta/employees/paygroups",
"value": "ADM"
}
}
]
}
,
"ssn": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
,
"ssn": {
"api_type": "read-only",
"display_label": "Social Security Number",
"value": "123456789"
}
}
}
400 Bad Request #/responses/employee_400

Bad Request

Example for application/json
{
"validation_information": [
"Too many employees to return at once."
]
,
"validation_response": {
"code": 400,
"message": "Bad Request"
}
}
403 Forbidden #/responses/403

Forbidden

404 Not Found #/responses/employee_404

Employee Not Found

Example for application/json
{
"validation_information": [
"Too many employees to return at once."
]
,
"validation_response": {
"code": 400,
"message": "Bad Request"
}
}
500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Get the compensation-related data for the employee.

GET /{byu_id}/compensations

Tags: jobs

Get the compensation-related data for the employee.

byu_id

A 9 digit employee ID.

path string , must match [0-9]{9} #/parameters/byu_id
200 OK #/responses/compensations_200

Success

Get date of birth data for the employee.

GET /{byu_id}/date_of_birth

Tags: employees

Get date of birth data for the employee.

byu_id

A 9 digit employee ID.

path string , must match [0-9]{9} #/parameters/byu_id
200 OK #/responses/date_of_birth_200

Success

Get employment action data for the employee.

GET /{byu_id}/employment_actions

Tags: jobs

Get employment action data for the employee.

byu_id

A 9 digit employee ID.

path string , must match [0-9]{9} #/parameters/byu_id
200 OK #/responses/employment_actions_200

Success

Get the HR Related data for the employee.

GET /{byu_id}/hr_data

Tags: employees

Get the HR Related data for the employee.

byu_id

A 9 digit employee ID.

path string , must match [0-9]{9} #/parameters/byu_id
200 OK #/responses/hr_data_200

Success

Returns job data for the specified employee

GET /{byu_id}/jobs

Tags: jobs

Returns job data for the specified employee

byu_id

A 9 digit employee ID.

path string , must match [0-9]{9} #/parameters/byu_id
200 OK #/responses/employees200jobs

Success

Example for application/json
{
"links": {
}
,
"metadata": {
"collection_size": 1
}
,
"values": [
{
"account": {
"api_type": "read-only",
"description": "Admin Salaries-Reg-(FT)",
"display_label": "Account",
"value": "1234"
}
,
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"chartblock": {
"api_type": "read-only",
"display_label": "Chartblock",
"value": "12345678-1234-12345"
}
,
"class": {
"api_type": "read-only",
"description": "Unclassified",
"display_label": "Class",
"value": "00000"
}
,
"department": {
"api_type": "read-only",
"description": "BYU Mascot",
"display_label": "Department",
"domain": "https://api.byu.edu/byuapi/meta/employees/departments",
"value": "1234"
}
,
"division_id": {
"api_type": "read-only",
"description": "BYU Mascots",
"display_label": "Division",
"domain": "https://api.byu.edu/byuapi/meta/employees/divisions",
"value": "1234"
}
,
"effective_date": {
"api_type": "system",
"display_label": "Effective Date",
"key": true,
"value": "2017-09-01"
}
,
"effective_sequence": {
"api_type": "system",
"display_label": "Effective Sequence",
"key": true,
"value": 0
}
,
"empl_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Employee Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/empl_statuses",
"value": "A"
}
,
"employee_category": {
"api_type": "read-only",
"description": "Full Time",
"display_label": "Employee Category",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_categories",
"value": "FT"
}
,
"employee_classification": {
"api_type": "read-only",
"description": "Administrative Staff",
"display_label": "Employee Classification",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_classifications",
"value": "ADM"
}
,
"employee_group": {
"api_type": "read-only",
"description": "Administrative",
"display_label": "Employee Group",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_groups",
"value": "ADM"
}
,
"employee_record_number": {
"api_type": "system",
"display_label": "Employee Record Number",
"key": true,
"value": 0
}
,
"employee_standing": {
"api_type": "derived",
"description": "Active",
"display_label": "Employee Standing",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_standings",
"value": "ACT"
}
,
"employee_status": {
"api_type": "read-only",
"description": "Full-Time",
"display_label": "Employee Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_statuses",
"value": "FT"
}
,
"employee_workgroup": {
"api_type": "read-only",
"display_label": "Work Group",
"value": null
}
,
"employment_action": {
"api_type": "read-only",
"description": "Data Change",
"display_label": "Employment Action",
"value": "DTA"
}
,
"full_part_time": {
"api_type": "read-only",
"description": "Full-Time",
"display_label": "Full-Time or Part-Time",
"domain": "https://api.byu.edu/byuapi/meta/employees/ft_pt_statuses",
"value": "F"
}
,
"hire_date": {
"api_type": "derived",
"display_label": "Hire Date",
"value": "2015-04-21"
}
,
"hr_empl_class_code": {
"api_type": "read-only",
"description": "Admin",
"display_label": "HR Employee Class Code",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_classes",
"long_description": "Administrative",
"value": "B"
}
,
"hr_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/hr_statuses",
"value": "A"
}
,
"job_code": {
"api_type": "read-only",
"description": "BYU Mascot",
"display_label": "Job Code",
"domain": "https://api.byu.edu/byuapi/meta/employees/job_codes",
"value": "123456"
}
,
"last_date_worked": {
"api_type": "read-only",
"display_label": "Last Date Worked",
"value": null
}
,
"last_hire_date": {
"api_type": "read-only",
"display_label": "Hire Date",
"value": "2015-04-21"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"months_ft_service": {
"api_type": "derived",
"display_label": "Months of Full-Time Service",
"value": 50
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
,
"operating_unit": {
"api_type": "read-only",
"description": "App Dev Enterprise Resource Pl",
"display_label": "Operating Unit",
"value": "12345678"
}
,
"position_number": {
"api_type": "read-only",
"description": "BYU Mascot",
"display_label": "Position Number",
"domain": "https://api.byu.edu/byuapi/meta/employees/positions",
"value": "12345678"
}
,
"regular_temp": {
"api_type": "read-only",
"description": "Regular",
"display_label": "Regular or Temporary",
"domain": "https://api.byu.edu/byuapi/meta/employees/reg_temp_statuses",
"value": "R"
}
,
"reports_to": {
"byu_id": {
"api_type": "related",
"display_label": "BYU Id",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "987654321"
}
,
"first_name": {
"api_type": "related",
"display_label": "First Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "Brigham"
}
,
"middle_name": {
"api_type": "related",
"display_label": "Middle Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "A"
}
,
"surname": {
"api_type": "related",
"display_label": "Last Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "Young"
}
}
,
"termination_date": {
"api_type": "read-only",
"display_label": "Termination Date",
"value": null
}
}
]
}
400 Bad Request #/responses/employee_400

Bad Request

Example for application/json
{
"validation_information": [
"Too many employees to return at once."
]
,
"validation_response": {
"code": 400,
"message": "Bad Request"
}
}
403 Forbidden #/responses/403

Forbidden

404 Not Found #/responses/employee_404

Employee Not Found

Example for application/json
{
"validation_information": [
"Too many employees to return at once."
]
,
"validation_response": {
"code": 400,
"message": "Bad Request"
}
}
500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Get the paygroup data for the employee.

GET /{byu_id}/paygroups

Tags: jobs

Get the paygroup data for the employee.

byu_id

A 9 digit employee ID.

path string , must match [0-9]{9} #/parameters/byu_id
200 OK #/responses/paygroups_200

Success

Get the SSN data for the employee.

GET /{byu_id}/ssn

Tags: employees

Get the SSN data for the employee.

byu_id

A 9 digit employee ID.

path string , must match [0-9]{9} #/parameters/byu_id
200 OK #/responses/ssn_200

Success

Parameter definitions

byu_id byu_id

A 9 digit employee ID.

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

A comma-separated list of Field Sets to call the API for. If none are specified, basic is assumed.

query string[] basic , comma separated (field_sets=aaa,bbb)
department_id department_id

A 4 digit code representing a university department.

query string

Response definitions

403

Forbidden

500

Internal Server Error - Error occurred that wasn't the user's fault

504

Gateway Timeout

employee_200

Success

Example for application/json
{
"basic": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"first_name": {
"api_type": "related",
"display_label": "First Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "Cosmo"
}
,
"hr_status": {
"api_type": "derived",
"description": "Active",
"display_label": "Primary HR Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/hr_statuses",
"value": "A"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"middle_name": {
"api_type": "related",
"display_label": "Middle Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "James"
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
,
"surname": {
"api_type": "related",
"display_label": "Last Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "Cougar"
}
}
,
"compensations": {
"links": {
}
,
"metadata": {
"collection_size": 1
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"compensation_rate": {
"api_type": "read-only",
"display_label": "Compensation Rate",
"value": 50000
}
,
"compensation_rate_frequency": {
"api_type": "read-only",
"description": "Annual",
"display_label": "Compensation Rate Frequency",
"domain": "https://api.byu.edu/byuapi/meta/employees/compensation_rate_frequencies",
"value": "A"
}
,
"effective_date": {
"api_type": "system",
"display_label": "Effective Date",
"key": true,
"value": "2017-09-01"
}
,
"effective_sequence": {
"api_type": "system",
"display_label": "Effective Sequence",
"key": true,
"value": 0
}
,
"employee_record_number": {
"api_type": "system",
"display_label": "Employee Record Number",
"key": true,
"value": 0
}
,
"hr_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/hr_statuses",
"value": "A"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
}
]
}
,
"date_of_birth": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"date_of_birth": {
"api_type": "related",
"display_label": "Date of Birth",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "1847-07-24"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
}
,
"employment_actions": {
"links": {
}
,
"metadata": {
"collection_size": 1
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"effective_date": {
"api_type": "system",
"display_label": "Effective Date",
"key": true,
"value": "2017-09-01"
}
,
"effective_sequence": {
"api_type": "system",
"display_label": "Effective Sequence",
"key": true,
"value": 0
}
,
"employee_record_number": {
"api_type": "system",
"display_label": "Employee Record Number",
"key": true,
"value": 0
}
,
"employment_action": {
"api_type": "read-only",
"description": "Data Change",
"display_label": "Employment Action",
"value": "DTA"
}
,
"employment_action_reason": {
"api_type": "read-only",
"description": "Data Change",
"display_label": "Employment Action",
"value": "ANU"
}
,
"hr_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/hr_statuses",
"value": "A"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
}
]
}
,
"hr_data": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"date_of_death": {
"api_type": "related",
"display_label": "Date of Death",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": null
}
,
"hr_status": {
"api_type": "derived",
"description": "Active",
"display_label": "Primary HR Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/hr_statuses",
"value": "A"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
,
"original_hire_date": {
"api_type": "derived",
"display_label": "Original Hire Date",
"value": "2011-07-26"
}
,
"restricted_person": {
"api_type": "read-only",
"display_label": "Restricted",
"long_description": "The data in this record is not restricted.",
"value": false
}
}
,
"jobs": {
"links": {
}
,
"metadata": {
"collection_size": 1
}
,
"values": [
{
"account": {
"api_type": "read-only",
"description": "Admin Salaries-Reg-(FT)",
"display_label": "Account",
"value": "1234"
}
,
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"chartblock": {
"api_type": "read-only",
"display_label": "Chartblock",
"value": "12345678-1234-12345"
}
,
"class": {
"api_type": "read-only",
"description": "Unclassified",
"display_label": "Class",
"value": "00000"
}
,
"department": {
"api_type": "read-only",
"description": "BYU Mascot",
"display_label": "Department",
"domain": "https://api.byu.edu/byuapi/meta/employees/departments",
"value": "1234"
}
,
"division_id": {
"api_type": "read-only",
"description": "BYU Mascots",
"display_label": "Division",
"domain": "https://api.byu.edu/byuapi/meta/employees/divisions",
"value": "1234"
}
,
"effective_date": {
"api_type": "system",
"display_label": "Effective Date",
"key": true,
"value": "2017-09-01"
}
,
"effective_sequence": {
"api_type": "system",
"display_label": "Effective Sequence",
"key": true,
"value": 0
}
,
"empl_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Employee Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/empl_statuses",
"value": "A"
}
,
"employee_category": {
"api_type": "read-only",
"description": "Full Time",
"display_label": "Employee Category",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_categories",
"value": "FT"
}
,
"employee_classification": {
"api_type": "read-only",
"description": "Administrative Staff",
"display_label": "Employee Classification",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_classifications",
"value": "ADM"
}
,
"employee_group": {
"api_type": "read-only",
"description": "Administrative",
"display_label": "Employee Group",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_groups",
"value": "ADM"
}
,
"employee_record_number": {
"api_type": "system",
"display_label": "Employee Record Number",
"key": true,
"value": 0
}
,
"employee_standing": {
"api_type": "derived",
"description": "Active",
"display_label": "Employee Standing",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_standings",
"value": "ACT"
}
,
"employee_status": {
"api_type": "read-only",
"description": "Full-Time",
"display_label": "Employee Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_statuses",
"value": "FT"
}
,
"employee_workgroup": {
"api_type": "read-only",
"display_label": "Work Group",
"value": null
}
,
"employment_action": {
"api_type": "read-only",
"description": "Data Change",
"display_label": "Employment Action",
"value": "DTA"
}
,
"full_part_time": {
"api_type": "read-only",
"description": "Full-Time",
"display_label": "Full-Time or Part-Time",
"domain": "https://api.byu.edu/byuapi/meta/employees/ft_pt_statuses",
"value": "F"
}
,
"hire_date": {
"api_type": "derived",
"display_label": "Hire Date",
"value": "2015-04-21"
}
,
"hr_empl_class_code": {
"api_type": "read-only",
"description": "Admin",
"display_label": "HR Employee Class Code",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_classes",
"long_description": "Administrative",
"value": "B"
}
,
"hr_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/hr_statuses",
"value": "A"
}
,
"job_code": {
"api_type": "read-only",
"description": "BYU Mascot",
"display_label": "Job Code",
"domain": "https://api.byu.edu/byuapi/meta/employees/job_codes",
"value": "123456"
}
,
"last_date_worked": {
"api_type": "read-only",
"display_label": "Last Date Worked",
"value": null
}
,
"last_hire_date": {
"api_type": "read-only",
"display_label": "Hire Date",
"value": "2015-04-21"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"months_ft_service": {
"api_type": "derived",
"display_label": "Months of Full-Time Service",
"value": 50
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
,
"operating_unit": {
"api_type": "read-only",
"description": "App Dev Enterprise Resource Pl",
"display_label": "Operating Unit",
"value": "12345678"
}
,
"position_number": {
"api_type": "read-only",
"description": "BYU Mascot",
"display_label": "Position Number",
"domain": "https://api.byu.edu/byuapi/meta/employees/positions",
"value": "12345678"
}
,
"regular_temp": {
"api_type": "read-only",
"description": "Regular",
"display_label": "Regular or Temporary",
"domain": "https://api.byu.edu/byuapi/meta/employees/reg_temp_statuses",
"value": "R"
}
,
"reports_to": {
"byu_id": {
"api_type": "related",
"display_label": "BYU Id",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "987654321"
}
,
"first_name": {
"api_type": "related",
"display_label": "First Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "Brigham"
}
,
"middle_name": {
"api_type": "related",
"display_label": "Middle Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "A"
}
,
"surname": {
"api_type": "related",
"display_label": "Last Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "Young"
}
}
,
"termination_date": {
"api_type": "read-only",
"display_label": "Termination Date",
"value": null
}
}
]
}
,
"links": {
}
,
"metadata": {
"field_sets_available": [
"basic",
"hr_data",
"ssn",
"date_of_birth",
"jobs",
"compensations",
"paygroups",
"employment_actions"
]
,
"field_sets_default": [
"basic"
]
,
"field_sets_returned": [
"basic",
"hr_data",
"jobs",
"compensations",
"ssn",
"date_of_birth",
"paygroups",
"employment_actions"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"paygroups": {
"links": {
}
,
"metadata": {
"collection_size": 1
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"effective_date": {
"api_type": "system",
"display_label": "Effective Date",
"key": true,
"value": "2017-09-01"
}
,
"effective_sequence": {
"api_type": "system",
"display_label": "Effective Sequence",
"key": true,
"value": 0
}
,
"employee_record_number": {
"api_type": "system",
"display_label": "Employee Record Number",
"key": true,
"value": 0
}
,
"hr_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/hr_statuses",
"value": "A"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
,
"paygroup": {
"api_type": "read-only",
"description": "BYU Admin Pay Group",
"display_label": "Paygroup",
"domain": "https://api.byu.edu/byuapi/meta/employees/paygroups",
"value": "ADM"
}
}
]
}
,
"ssn": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
,
"ssn": {
"api_type": "read-only",
"display_label": "Social Security Number",
"value": "123456789"
}
}
}
employee_400

Bad Request

Example for application/json
{
"validation_information": [
"Too many employees to return at once."
]
,
"validation_response": {
"code": 400,
"message": "Bad Request"
}
}
employee_404

Employee Not Found

Example for application/json
{
"validation_information": [
"Too many employees to return at once."
]
,
"validation_response": {
"code": 400,
"message": "Bad Request"
}
}
query_200

Success

Example for application/json
{
"links": {
}
,
"metadata": {
"collection_size": 1
}
,
"values": [
{
"basic": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"first_name": {
"api_type": "related",
"display_label": "First Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "Cosmo"
}
,
"middle_name": {
"api_type": "related",
"display_label": "Middle Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "James"
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmo"
}
,
"surname": {
"api_type": "related",
"display_label": "Last Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "Cougar"
}
}
,
"links": {
}
,
"metadata": {
}
}
]
}
query_400

Bad Request

Example for application/json
{
"validation_information": [
"Department Id is required."
]
,
"validation_response": {
"code": 400,
"message": "Bad Request"
}
}
query_404

Department Not Found

Example for application/json
{
"validation_information": [
"Too many employees to return at once."
]
,
"validation_response": {
"code": 400,
"message": "Bad Request"
}
}
default

Unexpected error

hr_data_200

Success

ssn_200

Success

date_of_birth_200

Success

employees200jobs

Success

Example for application/json
{
"links": {
}
,
"metadata": {
"collection_size": 1
}
,
"values": [
{
"account": {
"api_type": "read-only",
"description": "Admin Salaries-Reg-(FT)",
"display_label": "Account",
"value": "1234"
}
,
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"chartblock": {
"api_type": "read-only",
"display_label": "Chartblock",
"value": "12345678-1234-12345"
}
,
"class": {
"api_type": "read-only",
"description": "Unclassified",
"display_label": "Class",
"value": "00000"
}
,
"department": {
"api_type": "read-only",
"description": "BYU Mascot",
"display_label": "Department",
"domain": "https://api.byu.edu/byuapi/meta/employees/departments",
"value": "1234"
}
,
"division_id": {
"api_type": "read-only",
"description": "BYU Mascots",
"display_label": "Division",
"domain": "https://api.byu.edu/byuapi/meta/employees/divisions",
"value": "1234"
}
,
"effective_date": {
"api_type": "system",
"display_label": "Effective Date",
"key": true,
"value": "2017-09-01"
}
,
"effective_sequence": {
"api_type": "system",
"display_label": "Effective Sequence",
"key": true,
"value": 0
}
,
"empl_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Employee Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/empl_statuses",
"value": "A"
}
,
"employee_category": {
"api_type": "read-only",
"description": "Full Time",
"display_label": "Employee Category",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_categories",
"value": "FT"
}
,
"employee_classification": {
"api_type": "read-only",
"description": "Administrative Staff",
"display_label": "Employee Classification",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_classifications",
"value": "ADM"
}
,
"employee_group": {
"api_type": "read-only",
"description": "Administrative",
"display_label": "Employee Group",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_groups",
"value": "ADM"
}
,
"employee_record_number": {
"api_type": "system",
"display_label": "Employee Record Number",
"key": true,
"value": 0
}
,
"employee_standing": {
"api_type": "derived",
"description": "Active",
"display_label": "Employee Standing",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_standings",
"value": "ACT"
}
,
"employee_status": {
"api_type": "read-only",
"description": "Full-Time",
"display_label": "Employee Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_statuses",
"value": "FT"
}
,
"employee_workgroup": {
"api_type": "read-only",
"display_label": "Work Group",
"value": null
}
,
"employment_action": {
"api_type": "read-only",
"description": "Data Change",
"display_label": "Employment Action",
"value": "DTA"
}
,
"full_part_time": {
"api_type": "read-only",
"description": "Full-Time",
"display_label": "Full-Time or Part-Time",
"domain": "https://api.byu.edu/byuapi/meta/employees/ft_pt_statuses",
"value": "F"
}
,
"hire_date": {
"api_type": "derived",
"display_label": "Hire Date",
"value": "2015-04-21"
}
,
"hr_empl_class_code": {
"api_type": "read-only",
"description": "Admin",
"display_label": "HR Employee Class Code",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_classes",
"long_description": "Administrative",
"value": "B"
}
,
"hr_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/hr_statuses",
"value": "A"
}
,
"job_code": {
"api_type": "read-only",
"description": "BYU Mascot",
"display_label": "Job Code",
"domain": "https://api.byu.edu/byuapi/meta/employees/job_codes",
"value": "123456"
}
,
"last_date_worked": {
"api_type": "read-only",
"display_label": "Last Date Worked",
"value": null
}
,
"last_hire_date": {
"api_type": "read-only",
"display_label": "Hire Date",
"value": "2015-04-21"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"months_ft_service": {
"api_type": "derived",
"display_label": "Months of Full-Time Service",
"value": 50
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
,
"operating_unit": {
"api_type": "read-only",
"description": "App Dev Enterprise Resource Pl",
"display_label": "Operating Unit",
"value": "12345678"
}
,
"position_number": {
"api_type": "read-only",
"description": "BYU Mascot",
"display_label": "Position Number",
"domain": "https://api.byu.edu/byuapi/meta/employees/positions",
"value": "12345678"
}
,
"regular_temp": {
"api_type": "read-only",
"description": "Regular",
"display_label": "Regular or Temporary",
"domain": "https://api.byu.edu/byuapi/meta/employees/reg_temp_statuses",
"value": "R"
}
,
"reports_to": {
"byu_id": {
"api_type": "related",
"display_label": "BYU Id",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "987654321"
}
,
"first_name": {
"api_type": "related",
"display_label": "First Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "Brigham"
}
,
"middle_name": {
"api_type": "related",
"display_label": "Middle Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "A"
}
,
"surname": {
"api_type": "related",
"display_label": "Last Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "Young"
}
}
,
"termination_date": {
"api_type": "read-only",
"display_label": "Termination Date",
"value": null
}
}
]
}
compensations_200

Success

paygroups_200

Success

employment_actions_200

Success

Schema definitions

basic_field_set: object

byu_id: field_byu_id
net_id: field_net_id
first_name: field_first_name
middle_name: field_middle_name
surname: field_surname
hr_status: field_hr_status
links: links
metadata: field_set_metadata

collection_metadata: object

collection_size: collection_size
restricted_person: restricted_person_flag

collection_size: number

compensations: object

byu_id: field_byu_id
net_id: field_net_id
employee_record_number: field_employee_record_number
effective_date: field_effective_date
effective_sequence: field_effective_sequence
hr_status: field_hr_status
compensation_rate: field_compensation_rate
compensation_rate_frequency: field_compensation_rate_frequency
metadata: field_set_metadata

compensations_field_sets: object

values: object[]
links: links
metadata: collection_metadata

date_of_birth_field_set: object

byu_id: field_byu_id
net_id: field_net_id
date_of_birth: field_date_of_birth
links: links
metadata: field_set_metadata

description: string

Explains the data value in human-friendly terms.

description_code: string

Explains the data value in human-friendly terms. This will typically be the explanation of the letter code value.

display_label: string

Provides a string to use when creating a label for this property in the user interface if the name of the property is not appropriate (or is too cryptic) to use as a user interface label.

domain: string

Contains the URL that can be used to retrieve the set of allowable codes. The result of invoking the URL could be used to populate the UI's way of choosing a value from the allowable set.

employee_not_found: object

metadata: error_metadata

employment_actions: object

byu_id: field_byu_id
net_id: field_net_id
employee_record_number: field_employee_record_number
effective_date: field_effective_date
effective_sequence: field_effective_sequence
hr_status: field_hr_status
employment_action: field_employment_action
employment_action_reason: field_employment_action_reason
links: links
metadata: field_set_metadata

employment_actions_field_set: object

values: object[]
links: links
metadata: collection_metadata

error: string

error_metadata: object

validation_response: validation_response
validation_information: validation_information

error_response: object

status: error

field_account_field: object

A four digit numeric Chart Field that categorizes financial transactions. These values are standard across campus.

api_type: string , x ∈ { read-only (default) }
value: string
display_label: display_label
description: description_code

field_byu_id: object

The nine-digit computer-generated ID assigned to each identity in BYU-IAM, which is printed on the BYU ID Card in the format xx-xxx-xxxx and serves as a unique identifier. The BYU ID should be used for identification at points of service, as well as for system-to-system identification.

api_type: string , x ∈ { system (default) }
value: string , must match [0-9]{9}
key: key
display_label: display_label

field_chartblock: object

The combination of chart fields required for a journal entry, including Operating Unit, Account Field, and Class Field.

api_type: string , x ∈ { read-only (default) }
value: string , must match [0-9a-zA-z]{8}-[0-9]{4}-[0-9a-zA-z]{5}
description: description_code
display_label: display_label
domain: domain

field_class_field: object

A four digit numeric Chart Field that categorizes financial transactions. These values are standard across campus.

api_type: string , x ∈ { read-only (default) }
value: string
display_label: display_label
description: description_code

field_compensation_rate: object

The dollar amount that the employee makes. This is relative to the Compensation Rate frequency that the employee has. If Full-Time, this will be an Annual amount, otherwise it will be an Hourly amount.

api_type: string , x ∈ { read-only (default) }
value: number
display_label: display_label

field_compensation_rate_frequency: object

The frequency code associated with the job. Most common are H (Hourly) and A (Annual).

api_type: string , x ∈ { read-only (default) }
value: string
description: description_code
display_label: display_label
domain: domain

field_date_of_birth: object

The combined day, month, and year of a person's birth, in yyyy-mm-dd format (e.g. 1991-06-04).

api_type: string , x ∈ { related (default) }
value: string (date)
display_label: display_label
related_resource: related_resource

field_date_of_death: object

The combined day, month, and year of a person's death, in yyyy-mm-dd format (e.g. 2015-05-28), if any.

api_type: string , x ∈ { related (default) }
value: string (date)
display_label: display_label
related_resource: related_resource

field_department: object

An organizational grouping of financial Operating Units. A Department usually contains one or more Operating Units and each Department may contain Departments as part of a hierarchical reporting structure within the University.

api_type: string , x ∈ { read-only (default) }
value: string
description: description_code
display_label: display_label
domain: domain

field_division_id: object

The Department ID that is at level four above a given Department ID in the organization hierarchy. For academic units, the Division ID identifies the college. The division name can be found by looking up the Department for the specified Division ID.

api_type: string , x ∈ { read-only (default) }
value: string
description: description_code
display_label: display_label
domain: domain

field_effective_date: object

The date that the associated data is available and active. If multiple job actions happen on the same date, use the effective sequence to determine which action happened first.

api_type: string , x ∈ { system (default) }
value: string (date)
display_label: display_label

field_effective_sequence: object

A sequence number associated with a job that distinguishes between multiple job actions that happen on the same effective date.

api_type: string , x ∈ { system (default) }
value: integer
display_label: display_label

field_empl_status: object

The HR Employee Status field. Not to be confused with employee_status. This field is used to determine the Employee Standing.

api_type: string , x ∈ { read-only (default) }
value: string (1 to 1 chars)
description: description_code
display_label: display_label
domain: domain

field_employee_category: object

Defines the employee category for HR purposes. The most common employee categories are Full-time, Part-time and On Call. Very similar to Employee Status.

api_type: string , x ∈ { read-only (default) }
value: string (2 to 2 chars)
description: description_code
display_label: display_label
domain: domain

field_employee_classification: object

Defines the work role of an employee for general campus purposes. The most common employee classifications are Faculty, Administrative Staff, Staff and Student. Not to be confused with hr_empl_class_code. Also known as the Employee Group.

api_type: string , x ∈ { read-only (default) }
value: string (3 to 3 chars)
description: description_code
display_label: display_label
domain: domain

field_employee_group: object

Defines the employee group for HR purposes. The most common employee groups are Faculty, Administrative Staff, Staff and Student. Not to be confused with hr_empl_class_code. Similar to the Employee Classification.

api_type: string , x ∈ { read-only (default) }
value: string (3 to 3 chars)
description: description_code
display_label: display_label
domain: domain

field_employee_record_number: object

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

api_type: string , x ∈ { system (default) }
value: number
display_label: display_label
key: key

field_employee_standing: object

Defines the current expected work activity of an employee for general campus purposes. The most common employee standings are Active, Terminated and Retired. Derived from empl_status.

api_type: string , x ∈ { derived (default) }
value: string (3 to 3 chars)
description: description_code
display_label: display_label
domain: domain

field_employee_status: object

Defines the expected amount of time a person is employed per pay period. The most common employee statuses are Full-time, Part-time and On Call. Not to be confused with empl_status.

api_type: string , x ∈ { read-only (default) }
value: string (2 to 2 chars)
description: description_code
display_label: display_label
domain: domain

field_employee_workgroup: object

A group of people that report time in a similar manner. Only associated with hourly employees.

api_type: string , x ∈ { read-only (default) }
value: string
description: description
display_label: display_label
domain: domain

field_employment_action: object

An action that results in a modification of employment.

api_type: string , x ∈ { read-only (default) }
value: string
display_label: display_label
description: description_code

field_employment_action_reason: object

The detailed reason for a given employment action.

api_type: string , x ∈ { read-only (default) }
value: string
display_label: display_label
description: description_code

field_first_name: object

The first given name of a person. For example, if a person's name were John Michael Harrison, his first name would be John.

api_type: string , x ∈ { related (default) }
value: string
display_label: display_label
related_resource: related_resource

field_full_part_time: object

Whether the employee is considered Full-Time or Part-Time.

api_type: string , x ∈ { read-only (default) }
value: string (1 to 1 chars)
description: description_code
display_label: display_label
domain: domain

field_hire_date: object

The date an employee started their most recent employment at BYU.

api_type: string , x ∈ { read-only (default) }
value: string (date)
description: description_code
display_label: display_label
domain: domain

field_hr_empl_class_code: object

The HR Employee Classification. Defines a discrete bundle that describes a set of employees. The bundle conceptually includes the employee classification, employee status, employee standing, paygroup and others. This bundle is used to quickly set values for an employee. Examples include: Staff (Full-Time), Staff (Temporary), Faculty F/T (Regular), Faculty F/T (Researcher). Not to be confused with employee_classification. This field is the granular HR code associated with the job.

api_type: string , x ∈ { read-only (default) }
value: string (1 to 2 chars)
description: description_code
long_description: long_description
display_label: display_label
domain: domain

field_hr_status: object

Designates whether a person is currently an employee or a BYU affiliated employee (e.g., LDS Philanthropies, ROTC, etc.). The two values are Active and Inactive. The "Restricted Flag" will restrict access where the restricted flag has been selected.

api_type: string , x ∈ { derived (default) }
value: string
display_label: display_label
description: description

field_job_code: object

A six digit number associated with the type of job.

api_type: string , x ∈ { read-only (default) }
value: string , must match [0-9]{9}
description: description
long_description: long_description
display_label: display_label
domain: domain

field_last_date_worked: object

The last day this employee worked.

api_type: string , x ∈ { read-only (default) }
value: string (date)
description: description_code
display_label: display_label
domain: domain

field_last_hire_date: object

The Seniority Hire date that is used for benefits calculations.

api_type: string , x ∈ { read-only (default) }
value: string (date)
description: description_code
display_label: display_label
domain: domain

field_middle_name: object

The given middle name of the person.

api_type: string , x ∈ { related (default) }
value: string
display_label: display_label
related_resource: related_resource

field_months_ft_service: object

The number of months the employee has been employed full-time in this job, if any.

api_type: string , x ∈ { derived (default) }
value: number
description: description
display_label: display_label

field_net_id: object

A unique identifier used for enterprise sign-in (with a password and/or other security provisions such as two-factor authentication). Usually five-to-eight characters, beginning with a letter. May be self-selected or system-generated. Net IDs are known for being more human-readable than the other unique identifiers used at BYU.

api_type: string , x ∈ { related (default) }
value: string
key: key
display_label: display_label

field_operating_unit: object

An eight digit alphanumeric field that defines a financial reporting entity. They begin with either a two-digit Fund number or an eight character alphanumeric Project number.

api_type: string , x ∈ { read-only (default) }
value: string
display_label: display_label
description: description_code

field_original_hire_date: object

The earliest date that an employee started employment at BYU as either a part-time or full-time employment.

api_type: string , x ∈ { related (default) }
value: string (date)
display_label: display_label
related_resource: related_resource

field_paygroup: object

Grouping of employees based on shared characteristics that facilitate payroll processing, such as employee type, pay frequency, location, benefits, etc.

api_type: string , x ∈ { read-only (default) }
value: string
description: description_code
display_label: display_label
domain: domain

field_position_number: object

The position number of the employee, if the employee is positioned (Full-Time or 3/4-Time). Also known as a Slot number.

api_type: string , x ∈ { read-only (default) }
value: string , must match [0-9]{8}
description: description
display_label: display_label
domain: domain

field_regular_temp: object

Whether the employee is considered a Regular employee or a temporary employee.

api_type: string , x ∈ { read-only (default) }
value: string (1 to 1 chars)
description: description_code
display_label: display_label
domain: domain

field_set_metadata: object

validation_response: validation_response
validation_information: validation_information
restricted_person: restricted_person_flag

field_ssn: object

The 9-digit government-issued Social Security Number (SSN) or Individual Tax Payer Identification Number (ITIN); a required identifier for tax-related and other government services.

api_type: string , x ∈ { related (default) }
value: string
key: key
display_label: display_label

field_surname: object

The surname, family name, or last name of a person.

api_type: string , x ∈ { related (default) }
value: string
display_label: display_label
related_resource: related_resource

field_termination_date: object

The date the employee was terminated from this job, if any.

api_type: string , x ∈ { read-only (default) }
value: string (date)
description: description_code
display_label: display_label
domain: domain

forbidden_error: string , must match Forbidden

The caller of the web service is not authorized. They must have a data-sharing agreement in place to obtain this data from HR

hr_data_field_set: object

byu_id: field_byu_id
net_id: field_net_id
hr_status: field_hr_status
date_of_death: field_date_of_death
original_hire_date: field_original_hire_date
links: links
metadata: field_set_metadata

jobs: object

byu_id: field_byu_id
net_id: field_net_id
employee_record_number: field_employee_record_number
effective_date: field_effective_date
effective_sequence: field_effective_sequence
hr_status: field_hr_status
reports_to: reports_to
department: field_department
division_id: field_division_id
job_code: field_job_code
chartblock: field_chartblock
operating_unit: field_operating_unit
account_field: field_account_field
class_field: field_class_field
employee_workgroup: field_employee_workgroup
position_number: field_position_number
regular_temp: field_regular_temp
full_part_time: field_full_part_time
empl_status: field_empl_status
hr_empl_class_code: field_hr_empl_class_code
employee_group: field_employee_group
employee_classification: field_employee_classification
employee_category: field_employee_category
employee_status: field_employee_status
employee_standing: field_employee_standing
hire_date: field_hire_date
months_ft_service: field_months_ft_service
last_hire_date: field_last_hire_date
termination_date: field_termination_date
last_date_worked: field_last_date_worked
employment_action: field_employment_action
links: links
metadata: field_set_metadata

jobs_field_sets: object

{
"links": {
}
,
"metadata": {
"collection_size": 1
}
,
"values": [
{
"account": {
"api_type": "read-only",
"description": "Admin Salaries-Reg-(FT)",
"display_label": "Account",
"value": "1234"
}
,
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789",
"value": "123456789"
}
,
"chartblock": {
"api_type": "read-only",
"display_label": "Chartblock",
"value": "12345678-1234-12345"
}
,
"class": {
"api_type": "read-only",
"description": "Unclassified",
"display_label": "Class",
"value": "00000"
}
,
"department": {
"api_type": "read-only",
"description": "BYU Mascot",
"display_label": "Department",
"domain": "https://api.byu.edu/byuapi/meta/employees/departments",
"value": "1234"
}
,
"division_id": {
"api_type": "read-only",
"description": "BYU Mascots",
"display_label": "Division",
"domain": "https://api.byu.edu/byuapi/meta/employees/divisions",
"value": "1234"
}
,
"effective_date": {
"api_type": "system",
"display_label": "Effective Date",
"key": true,
"value": "2017-09-01"
}
,
"effective_sequence": {
"api_type": "system",
"display_label": "Effective Sequence",
"key": true,
"value": 0
}
,
"empl_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Employee Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/empl_statuses",
"value": "A"
}
,
"employee_category": {
"api_type": "read-only",
"description": "Full Time",
"display_label": "Employee Category",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_categories",
"value": "FT"
}
,
"employee_classification": {
"api_type": "read-only",
"description": "Administrative Staff",
"display_label": "Employee Classification",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_classifications",
"value": "ADM"
}
,
"employee_group": {
"api_type": "read-only",
"description": "Administrative",
"display_label": "Employee Group",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_groups",
"value": "ADM"
}
,
"employee_record_number": {
"api_type": "system",
"display_label": "Employee Record Number",
"key": true,
"value": 0
}
,
"employee_standing": {
"api_type": "derived",
"description": "Active",
"display_label": "Employee Standing",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_standings",
"value": "ACT"
}
,
"employee_status": {
"api_type": "read-only",
"description": "Full-Time",
"display_label": "Employee Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_statuses",
"value": "FT"
}
,
"employee_workgroup": {
"api_type": "read-only",
"display_label": "Work Group",
"value": null
}
,
"employment_action": {
"api_type": "read-only",
"description": "Data Change",
"display_label": "Employment Action",
"value": "DTA"
}
,
"full_part_time": {
"api_type": "read-only",
"description": "Full-Time",
"display_label": "Full-Time or Part-Time",
"domain": "https://api.byu.edu/byuapi/meta/employees/ft_pt_statuses",
"value": "F"
}
,
"hire_date": {
"api_type": "derived",
"display_label": "Hire Date",
"value": "2015-04-21"
}
,
"hr_empl_class_code": {
"api_type": "read-only",
"description": "Admin",
"display_label": "HR Employee Class Code",
"domain": "https://api.byu.edu/byuapi/meta/employees/employee_classes",
"long_description": "Administrative",
"value": "B"
}
,
"hr_status": {
"api_type": "read-only",
"description": "Active",
"display_label": "HR Status",
"domain": "https://api.byu.edu/byuapi/meta/employees/hr_statuses",
"value": "A"
}
,
"job_code": {
"api_type": "read-only",
"description": "BYU Mascot",
"display_label": "Job Code",
"domain": "https://api.byu.edu/byuapi/meta/employees/job_codes",
"value": "123456"
}
,
"last_date_worked": {
"api_type": "read-only",
"display_label": "Last Date Worked",
"value": null
}
,
"last_hire_date": {
"api_type": "read-only",
"display_label": "Hire Date",
"value": "2015-04-21"
}
,
"links": {
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"months_ft_service": {
"api_type": "derived",
"display_label": "Months of Full-Time Service",
"value": 50
}
,
"net_id": {
"api_type": "related",
"display_label": "Net ID",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/123456789/credentials/NET_ID,cosmoc",
"value": "cosmoc"
}
,
"operating_unit": {
"api_type": "read-only",
"description": "App Dev Enterprise Resource Pl",
"display_label": "Operating Unit",
"value": "12345678"
}
,
"position_number": {
"api_type": "read-only",
"description": "BYU Mascot",
"display_label": "Position Number",
"domain": "https://api.byu.edu/byuapi/meta/employees/positions",
"value": "12345678"
}
,
"regular_temp": {
"api_type": "read-only",
"description": "Regular",
"display_label": "Regular or Temporary",
"domain": "https://api.byu.edu/byuapi/meta/employees/reg_temp_statuses",
"value": "R"
}
,
"reports_to": {
"byu_id": {
"api_type": "related",
"display_label": "BYU Id",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "987654321"
}
,
"first_name": {
"api_type": "related",
"display_label": "First Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "Brigham"
}
,
"middle_name": {
"api_type": "related",
"display_label": "Middle Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "A"
}
,
"surname": {
"api_type": "related",
"display_label": "Last Name",
"related_resource": "https://api.byu.edu/byuapi/persons/v1/987654321",
"value": "Young"
}
}
,
"termination_date": {
"api_type": "read-only",
"display_label": "Termination Date",
"value": null
}
}
]
}
values: object[]
links: links
metadata: collection_metadata

key: boolean true

Designates that the property is one of the key elements for this resource. This has several implications. First, key fields are required fields - they are not allowed to be blank or null. Second, it is used in the URL segment of the URL to access a specific item in the resource collection. Some resources may not allow a key value to be modified, but there are the exceptions. Refer to the documentation for the API. Some resources may assign the key value when the item is added. Once again, refer to the documentation for the API (https://developer.byu.edu/docs/design-api/university-api-standard)

long_description: string

Explains the data value in human-friendly terms; contains more information than the (short) description.

outer_metadata:

field_sets_returned: string[] basic
string , x ∈ { basic , hr_data , ssn , date_of_birth , jobs , compensations , paygroups , employment_actions }
field_sets_available: string[] basic,hr_data,ssn,date_of_birth,jobs,compensations,paygroups,employment_actions
string , x ∈ { basic , hr_data , ssn , date_of_birth , jobs , compensations , paygroups , employment_actions }
field_sets_default: string[] basic
string , x ∈ { basic }

paygroups: object

byu_id: field_byu_id
net_id: field_net_id
employee_record_number: field_employee_record_number
effective_date: field_effective_date
effective_sequence: field_effective_sequence
hr_status: field_hr_status
paygroup: field_paygroup
links: links
metadata: field_set_metadata

paygroups_field_set: object

values: object[]
links: links
metadata: collection_metadata

reports_to: object

byu_id: field_byu_id
first_name: field_first_name
middle_name: field_middle_name
surname: field_surname

restricted_person_flag: boolean

A flag indicating whether a person has requested anonymity in the university's Identity system. The Restricted Flag carries more serious implications than the Unlisted Data Flag: if a person is marked as "restricted," his or her presence at the University MUST NOT be made known to the public.

ssn_field_set: object

byu_id: field_byu_id
net_id: field_net_id
ssn: field_ssn
links: links
metadata: field_set_metadata

successful_response_multiple_employees: object

values: object[]
object
links: links
metadata: collection_metadata

successful_response_single_employee: object

basic: basic_field_set
hr_data: hr_data_field_set
ssn: ssn_field_set
date_of_birth: date_of_birth_field_set
jobs: jobs_field_sets
compensations: compensations_field_sets
paygroups: paygroups_field_set
employment_actions: employment_actions_field_set
links: links
metadata: outer_metadata

validation_information: object[]

validation_information_message: string

validation_response: object

validation_response_code: number , x ∈ { 200 , 400 , 403 , 404 , 500 , 504 }

validation_response_message: string

Service Path: 
/byuapi/employees
Domain or University API: 
/U/employees

Community

 

Don't see your question listed here? Ask!