GET_DMBA_EMP_SUMMARY
Self-service web service that returns DMBA Employee Summary Data
More information: https://it.byu.edu
Contact Info: api@byu.edu
Base URL: /domains/erp/hr/get_dmba_emp_summary
Version: v1
Default response content-types: application/json
Schemes: https
Summary
Path | Operation | Description |
---|---|---|
/* | GET |
Paths
GET /*
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{
"dmba_data": {
"accidental_death_deduction_amount": "13.6",
"accidental_death_dependant_amount": "5000",
"accidental_death_effective_date": "2014-09-01",
"accidental_death_insurance_amount": "220000",
"accidental_death_spouse_amount": "100000",
"benlife_deduction_amount": "0",
"effective_date": "2017-03-12",
"employment_history": {
"history": [
{
"history_company_code": "B03",
"history_company_description": "BRIGHAM YOUNG UNIVERSITY",
"history_from_date": "2001-04-23",
"history_thru_date": "2002-01-11"
},
{
"history_company_code": "B03",
"history_company_description": "BRIGHAM YOUNG UNIVERSITY",
"history_from_date": "2014-07-14",
"history_thru_date": {
}
}
]
},
"eye_med_deduction_amount": "26.3",
"family_data": {
"dependant": [
{
"birthdate": "1959-01-28",
"first_name": "Blaine",
"gender": "M",
"ineligible_date": {
},
"last_name": "DeBeers",
"relationship": "Employee"
},
{
"birthdate": "1958-10-17",
"first_name": "Liv",
"gender": "F",
"ineligible_date": {
},
"last_name": "Moore",
"relationship": "Spouse"
},
{
"birthdate": "1978-07-01",
"first_name": "Peyton",
"gender": "F",
"ineligible_date": {
},
"last_name": "Charles",
"relationship": "Child"
}
]
},
"fsa_dependant_deduction_amount": "0",
"fsa_medical_deduction_amount": "216.67",
"group_term_life_dependant_amount": "2000",
"group_term_life_effective_date": "2014-07-14",
"group_term_life_insurance_amount": "50000",
"group_term_life_spouse_amount": "5000",
"liberty_deduction_amount": "0",
"loans": {
"loan": {
}
},
"medical_billing_code": "A A LPF3NMCMDD",
"medical_deduction_amount": "108.2",
"medical_plan_enrollment_date": "2014-07-14",
"medical_plan_provider": "Deseret Value",
"metlife_deduction_amount": "0",
"savings_plans": {
"saving_plan": [
{
"plan_deduction_amount": "234.56",
"plan_deduction_code": "235",
"plan_description": "DMBA RPP Retirement Benefit",
"plan_effective_date": "2015-07-03",
"plan_pay_frequency": "Monthly",
"plan_percent": "3.5"
},
{
"plan_deduction_amount": "123.45",
"plan_deduction_code": "223",
"plan_description": "DMBA Roth 401k",
"plan_effective_date": "2014-08-29",
"plan_pay_frequency": "Monthly",
"plan_percent": "6"
},
{
"plan_deduction_amount": "456.7",
"plan_deduction_code": "233",
"plan_description": "DMBA Thrift Match",
"plan_effective_date": "2015-06-26",
"plan_pay_frequency": "Monthly",
"plan_percent": "4"
}
]
},
"supplemental_group_term_life_deduction_amount": "13.22",
"supplemental_group_term_life_dependant_amount": "5000",
"supplemental_group_term_life_effective_date": "2014-09-01",
"supplemental_group_term_life_insurance_amount": "220000",
"supplemental_group_term_life_spouse_amount": "100000"
}
}
Schema definitions
- first_name: first_name
-
- last_name: last_name
-
- relationship: relationship
-
- gender: gender
-
- birthdate: birthdate
-
- ineligible_date: ineligible_date
-
- effective_date: effective_date
-
- medical_plan_enrollment_date: medical_plan_enrollment_date
-
- medical_billing_code: medical_billing_code
-
- medical_plan_provider: medical_plan_provider
-
- medical_deduction_amount: medical_deduction_amount
-
- eye_med_deduction_amount: eye_med_deduction_amount
-
- group_term_life_effective_date: group_term_life_effective_date
-
- group_term_life_insurance_amount: group_term_life_insurance_amount
-
- group_term_life_spouse_amount: group_term_life_spouse_amount
-
- group_term_life_dependant_amount: group_term_life_dependant_amount
-
- supplemental_group_term_life_effective_date: supplemental_group_term_life_effective_date
-
- supplemental_group_term_life_insurance_amount: supplemental_group_term_life_insurance_amount
-
- supplemental_group_term_life_spouse_amount: supplemental_group_term_life_spouse_amount
-
- supplemental_group_term_life_dependant_amount: supplemental_group_term_life_dependant_amount
-
- supplemental_group_term_life_deduction_amount: supplemental_group_term_life_deduction_amount
-
- accidental_death_effective_date: accidental_death_effective_date
-
- accidental_death_insurance_amount: accidental_death_insurance_amount
-
- accidental_death_spouse_amount: accidental_death_spouse_amount
-
- accidental_death_dependant_amount: accidental_death_dependant_amount
-
- accidental_death_deduction_amount: accidental_death_deduction_amount
-
- benlife_deduction_amount: benlife_deduction_amount
-
- metlife_deduction_amount: metlife_deduction_amount
-
- liberty_deduction_amount: liberty_deduction_amount
-
- fsa_medical_deduction_amount: fsa_medical_deduction_amount
-
- fsa_dependant_deduction_amount: fsa_dependant_deduction_amount
-
- family_data: family_data
-
- savings_plans: savings_plans
-
- loans: loans
-
- employment_history: employment_history
-
- history: history
-
- dependant: dependant
-
- dmba_data: dmba_data
-
- history_company_code: history_company_code
-
- history_company_description: history_company_description
-
- history_from_date: history_from_date
-
- history_thru_date: history_thru_date
-
- loan_deduction_code: loan_deduction_code
-
- loan_description: loan_description
-
- loan_amount: loan_amount
-
- loan: loan
-
- plan_description: plan_description
-
- plan_deduction_code: plan_deduction_code
-
- plan_effective_date: plan_effective_date
-
- plan_percent: plan_percent
-
- plan_deduction_amount: plan_deduction_amount
-
- plan_pay_frequency: plan_pay_frequency
-
- saving_plan: saving_plan
-
Service Path:
/domains/erp/hr/get_dmba_emp_summary
Domain or University API:
/domains/erp/hr/get_dmba_emp_summary