eForms

 

API for getting information about eForms

 

 

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

 

Base URL: /domains/erp/hr/forms

Version: v1

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

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 eForms based on the BYU Id

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 an eForm based on the eForm Id

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

byu_id: string , must match ^[0-9]{9}$

 

effective_date: string (date)

 

error: string

 

error_response: object

status: error
 

form: object

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
 

form_id: string , must match [0-9]{1,12}

 

form_status: string (1 to 1 chars)

 

form_status_descr: string

 

form_type: string , x ∈ { HIRE , TERMINATE , JOBCHANGE , LEAVE , SUPCOMP , RESEARCH , I9 , I9_2013 }

 

forms: object[]

form
 

hr_empl_class_code: string , must match [A-Z]|[0-9]

 
Service Path: 
/domains/erp/hr/forms

Community

 

Don't see your question listed here? Ask!