eForms
API for getting information about eForms
Base URL: /domains/erp/hr/forms
Version: v1
Summary
Path | Operation | Description |
---|---|---|
/* | GET |
Get eForms based on the BYU Id |
/{form_id} | GET |
Get an eForm based on the eForm Id |
Paths
GET /*
Get eForms from HR based on BYU Id, and an optional Form Type, to narrow down the results
byu_id |
BYU Id of the individual |
query | string , must match ^[0-9]{9}$ | |
form_type |
The optional Form Type to restrict Results to |
query | string , x ∈ { HIRE , TERMINATE , JOBCHANGE , LEAVE , SUPCOMP , RESEARCH , I9 , I9_2013 } |
Uses default content-types: application/json application/xml
- 200 OK
-
Successfully returned form(s)
Example for application/json[ { "byu_id": "123456789", "effective_date": "2014-06-26", "form_id": "1052840", "form_status": "E", "form_status_descr": "Executed", "form_type": "HIRE", "hr_empl_class_code": "S" }, { "byu_id": "123456789", "effective_date": "2015-02-24", "form_id": "1135051", "form_status": "E", "form_status_descr": "Executed", "form_type": "HIRE", "hr_empl_class_code": "S" } ]
- 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
Example for application/json{ "error": "Either form_id or byu_id is required. Neither was supplied." }
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
User does not have security to view form
- 404 Not Found #/responses/404
-
Form not Found
Example for application/json{ "error_message": "The form id you specified is not associated with a form." }
- 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 /{form_id}
Get eForms from HR based on the eForm Id
form_id |
eForm Id (e.g 1513972) |
path | string , must match ^[0-9]{12}$ |
Uses default content-types: application/json application/xml
- 200 OK
-
Form found.
Example for application/json{ "byu_id": "123456789", "effective_date": "2017-12-23", "form_id": "1513972", "form_status": "H", "form_status_descr": "On Hold", "form_type": "HIRE", "hr_empl_class_code": "S" }
- 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
Example for application/json{ "error": "Either form_id or byu_id is required. Neither was supplied." }
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
User does not have security to view form
- 404 Not Found #/responses/404
-
Form not Found
Example for application/json{ "error_message": "The form id you specified is not associated with a form." }
- 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
Response definitions
- 400
-
Invalid Request - unable to interpret request
Example for application/json{ "error": "Either form_id or byu_id is required. Neither was supplied." }
- 401
-
Authentication required to access data
- 403
-
User does not have security to view form
- 404
-
Form not Found
Example for application/json{ "error_message": "The form id you specified is not associated with a form." }
- 500
-
Internal Server Error - Error occurred that wasn't the user's fault
- 504
-
Gateway Timeout
- default
-
Unexpected error
Schema definitions
- status: error
-
- form_id: form_id
-
- form_type: form_type
-
- form_status: form_status
-
- form_status_descr: form_status_descr
-
- byu_id: byu_id
-
- effective_date: effective_date
-
- hr_empl_class_code: hr_empl_class_code
-