Events
API for getting information about events
More information: https://it.byu.edu
Contact Info: api@byu.edu
Base URL: /domains/erp/hr/events
Version: v1
Default response content-types: application/json, application/xml
Schemes: https
Summary
Path | Operation | Description |
---|---|---|
/{event_id} | GET |
Get an Event based on its Event Id |
Paths
Get an Event based on its Event Id
GET /{event_id}
Get events from the HR Event Hub Log
event_id |
Event Id (e.g 2018012307151706401) |
path | string , must match [0-9]{19} |
Uses default content-types: application/json application/xml
- 200 OK
-
Event found.
Example for application/json{ "body": { "byu_id": "999999999", "effective_date": "2017-09-01", "net_id": "jschmo", "updated_by": "jeyre" }, "event_header": { "domain": "edu.byu", "event_id": "2018020112033407901", "event_type": "Address Changed", "source_dt": "2018-02-01T12:03:34.000000-07:00", "source_id": "HR" }, "filters": [ { "filter_name": "hr_empl_class_code", "filter_value": "S" }, { "filter_name": "department", "filter_value": "1234" } ] }
- 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
Example for application/json{ "error": "The sequence number has to be greater than zero." }
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
Event not Found
Example for application/json{ "error_message": "Event Id (2018020112033407801) Not found" }
- 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": "The sequence number has to be greater than zero." }
- 401
-
Authentication required to access data
- 403
-
Access denied to protected data
- 404
-
Event not Found
Example for application/json{ "error_message": "Event Id (2018020112033407801) Not found" }
- 500
-
Internal Server Error - Error occurred that wasn't the user's fault
- 504
-
Gateway Timeout
- default
-
Unexpected error
Schema definitions
- byu_id: byu_id
-
- net_id: net_id
-
- callback: callback
-
- updated_by: net_id
-
- effective_date: effective_date
-
- form_id: form_id
-
- employee_record_number: employee_record_number
-
- punch_date: punch_date
-
- punch_time: punch_time
-
- punch_type: punch_type
-
- sequence_number: sequence_number
-
- previous_punch_date: punch_date
-
- previous_punch_time: punch_time
-
- previous_punch_type: punch_type
-
- previous_sequence_number: sequence_number
-
- event_id: event_id
-
- status: error
-
- body: body
-
- event_header: event_header
-
- filters: filters
-
- source_dt: string (date-time)
-
- source_id: string , must match HR
-
- event_type: string
-
- domain: string
-
- event_id: event_id
-
Service Path:
/domains/erp/hr/events