NAME

This API is used to query the employee name. If the effective_date element is not specified, the service will return current data for the specified byu_id.

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

Base URL: /domains/erp/hr/name

Version: v1

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

Summary

Path Operation Description
/* GET
OPTIONS

Paths

GET /*

byu_id

BYU ID

query string
effective_date

Effective Date

query string (date)

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
{
"name": {
"employee": {
"byu_id": "999999999",
"effective_date": "2000-10-04",
"first_name": "Daffy",
"last_name": "Duck",
"middle_name": "",
"name_prefix": "",
"name_suffix": "",
"preferred_first_name": ""
}
}
}

OPTIONS /*

Uses default content-types: application/json

200 OK

Schema definitions

byu_id: object

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

effective_date: object

value: string (date)

employee: object

byu_id: byu_id
effective_date: effective_date
name_prefix: name_prefix
first_name: first_name
middle_name: middle_name
last_name: last_name
name_suffix: name_suffix
preferred_first_name: preferred_first_name

first_name: object

value: string (up to 30 chars)

last_name: object

value: string (up to 30 chars)

middle_name: object

value: string (up to 30 chars)

name: object

employee: employee

name_prefix: object

value: string (up to 4 chars)

name_suffix: object

value: string (up to 15 chars)

preferred_first_name: object

value: string (up to 30 chars)
Service Path: 
/domains/erp/hr/name
Domain or University API: 
/domains/erp/hr/name

Community

 

Don't see your question listed here? Ask!