Y-Time-Locations

API for getting information about Y-Time locations

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

Base URL: /domains/erp/hr/locations

Version: v1

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

Summary

Path Operation Description
/* GET

Get all Y-Time locations

/{ytime_location_code} GET

Get a Y-Time location based on the location code

Paths

Get all Y-Time locations

GET /*

Get all Y-Time locations

Uses default content-types: application/json application/xml

200 OK

Successfully returned Y-Time locations

Example for application/json
[
{
"latitude": 40.259636,
"location_source": "FAC",
"longitude": -111.645679,
"status": "A",
"updated_by_name": "barry",
"updated_datetime": "2016-09-24T02:45:56.000000-06:00",
"ytime_location": "(10M) RICH (BENJAMIN E) BLDG (TEACHING)",
"ytime_location_abbreviation": "(10M) RICH (BENJAMIN E) BLDG (",
"ytime_location_code": "10M"
},
{
"latitude": 40.262896,
"location_source": "HR",
"longitude": -111.657565,
"status": "I",
"updated_by_name": "iris",
"updated_datetime": "2017-10-01T08:45:42.000000-06:00",
"ytime_location": "",
"ytime_location_abbreviation": "OUTDOORS UNLIMITED",
"ytime_location_code": "1151 WSC"
},
{
"latitude": 40.259162,
"location_source": "FAC",
"longitude": -111.645298,
"status": "A",
"updated_by_name": "joe",
"updated_datetime": "2017-05-25T10:45:42.000000-06:00",
"ytime_location": "(11M) BALLARD (MELVIN J) BLDG (SPECIAL T",
"ytime_location_abbreviation": "(11M) BALLARD (MELVIN J) BLDG",
"ytime_location_code": "11M"
}
]
403 Forbidden #/responses/403

Forbidden

404 Not Found #/responses/404

Form not Found

Example for application/json
{
"error_message": "Data for Location 'AAA' does not exist."
}
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 a Y-Time location based on the location code

GET /{ytime_location_code}

Get a Y-Time location from HR based on its location code

ytime_location_code

The location code for the Y-Time location

path string (up to 10 chars)

Uses default content-types: application/json application/xml

200 OK

Y-Time Location Found

Example for application/json
{
"latitude": 40.404425,
"location_source": "FAC",
"longitude": -111.601847,
"status": "A",
"updated_by_name": "ironman",
"updated_datetime": "2017-09-24T13:45:42.000000-06:00",
"ytime_location": "ASPEN GROVE (EMERALD DINING HALL)",
"ytime_location_abbreviation": "ASPEN GROVE (EMERALD DINING HA",
"ytime_location_code": "AEDH"
}
403 Forbidden #/responses/403

Forbidden

404 Not Found #/responses/404

Form not Found

Example for application/json
{
"error_message": "Data for Location 'AAA' does not exist."
}
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

403

Forbidden

404

Form not Found

Example for application/json
{
"error_message": "Data for Location 'AAA' does not exist."
}
500

Internal Server Error - Error occurred that wasn't the user's fault

504

Gateway Timeout

default

Unexpected error

Schema definitions

datetime: string (date-time)

error: string

error_response: object

status: error

latitude: string , must match ^-?(\d\.\d{1,7}|[1-8]\d\.\d{1,7}|90\.0{1,7})$

Latitude

location: object

ytime_location_code: ytime_location_code
ytime_location_abbreviation: ytime_location_abbreviation
ytime_location: ytime_location
status: location_status
longitude: longitude
latitude: latitude
updated_datetime: datetime
updated_by_name: updated_by_name
location_source: location_source

location_source: string , x ∈ { HR , FAC }

location_status: string , x ∈ { A , I }

locations: object[]

longitude: string , must match ^-?((([1]?[0-7][0-9]|[1-9]?[0-9])\.{1}\d{1,7}$)|[1]?[1-8][0]\.{1}0{1,7})$

Longitude

updated_by_name: string

ytime_location: string (up to 100 chars)

ytime_location_abbreviation: string (up to 30 chars)

ytime_location_code: string (up to 10 chars)

Service Path: 
/domains/erp/hr/locations
Domain or University API: 
/domains/erp/hr/locations

Community

 

Don't see your question listed here? Ask!