UC Recruit provides a RESTful web service to expose the recruitments demographics information stored in the system, which is obtained from the demographic survey. This is a read-only API that allows consumption of the data for integration into other systems for analytics, tracking, and reporting.

If you would like access to the API, please fill out the form here. This form helps us maintain control over who has access to the API and the information contained within.

Working with the API

Requests listed below are prefixed with their necessary HTTP verb.

Making Valid Requests

All requests should use the GET HTTP method. All API requests require HTTP Basic Authentication. Please see your systems administrator for assistance in determining the username and password for your site, or contact UCRecruit-Support@uci.edu.

It is strongly suggested that the following headers be set, or that all requests use a .json suffix to ensure that JSON responses are generated.

‘Accept’ HTTP Header

application/json

Listing Applicant Demographics

To list all the applicant demographics data that are accessible to you:

GET https://recruit.ucx.edu/api/v1/recruitments/demographics

 

Get only demographics data that have recently changed

You can optionally add a changed_since parameter followed by a date such as:

GET https://recruit.ucx.edu/api/v1/recruitments/demographics?changed_since=2019-10-01

Examples of valid changed_since values are:

2019-10-01
10/1/2019
yesterday
today

The following fields are present in a successful response:

Fields for recruitment demographics list		Format
changed_since	Cutoff value used to scope demographics information that are recorded after this timestamp.	ISO 8601 “Combined date and time in UTC” format. Example: 2012-04-19T20:13Z
demographics	An array of all applicant demographic descriptions. Contains subfields.	Object
requested_at	Time that api request was made.	ISO 8601 “Combined date and time in UTC” format. Example: 2012-04-19T20:13Z
requested_by	User that made the request.	String

Fields for recruitment demographics		Format
application_id	The internal identifier used to refer to the Application.	integer
disability_status	A human-readable string identifying the applicant’s self-selected disability status. May change as time goes on; if you need to compare long-term datasets, use disability_status_code, below. If the applicant took the survey but declined to answer this question, will be the string “Decline to state”.	text
disability_status_code	The internal code identifying the applicant’s self-selected disability status. Usable as a long-term key. If the applicant took the survey before this question was asked, will be `not_asked`.	text or null
ethnicity	A human-readable string identifying the applicant’s reported ethnicity. May change as time goes on; if you need to compare long-term datasets, use ethnicity_code, below. If the applicant took the survey but declined to answer this question, will be the string “ Decline to state”.	text
ethnicity_answers	A list of human-readable strings identifying the applicant’s ethnicity choices. May change as time goes on; if you need to compare long-term datasets, use ethnicity_answer_codes, below. You will get an empty array [] here in the event that applicant has taken an old survey that did not allow for multiple ethnicity choices.	Array of texts
ethnicity_answer_codes	A list of the internal codes identifying the applicant’s self-selected ethnicity choices. Usable as a long-term key. You will get an empty array [] here in the event that applicant has taken an old survey that did not allow for multiple ethnicity choices.	Array of texts
ethnicity_code	The internal code identifying the applicant’s self-selected primary ethnicity. Usable as a long-term key.	text
gender	A human-readable string identifying the applicant’s self-selected gender. May change as time goes on; if you need to compare long-term datasets, use gender_code, below. If the applicant took the survey but declined to answer this question, will be the string “Declined”.	text
gender_answer	The answer to the survey’s gender identity question. If the applicant has yet to see this question, will be null.	text or null
gender_code	The internal code identifying the applicant’s self-selected gender. Usable as a long-term key.	text
gender_rollup	The rollup that represents the applicant’s high-level gender demographic group	text
protected_veteran_status	A human-readable string identifying the applicant’s self-selected protected veteran status. May change as time goes on; if you need to compare long-term datasets, use protected_veteran_status_code, below. To simplify displaying data, will always contain a string; if the applicant has yet to take the survey, will be the string “No response”. If the applicant took the survey but declined to answer this question, will be the string “Declined”.	text
protected_veteran_status_code	The internal code identifying the applicant’s self-selected protected veteran status. Usable as a long-term key. If the applicant has yet to take the survey, will be null. If the applicant took the survey before this question was asked, will be `not_asked`.	text or null
sexual_orientation	A human-readable string identifying the applicant’s reported sexual orientation. May change as time goes on; if you need to compare long-term datasets, use sexual_orientation_code, below. If the applicant has yet to see this question, will be “Not Asked”.	text
sexual_orientation_code	The internal code identifying the applicant’s self-selected sexual orientation. If the applicant has yet to see this question, will be “not_asked”.	text

 

IPEDS

IPEDS is the Integrated Postsecondary Education Data System. It is a system of interrelated surveys conducted annually by the U.S. Department of Education’s National Center for Education Statistics (NCES). IPEDS gathers information from every college, university, and technical and vocational institution that participates in the federal student financial aid programs.

In the case where the survey taker selects one or more race or ethnicity options, the following rollup rules are applied by the NSF:

If a survey taker selects one or more of the options Hispanic or Latino, Mexican or Chicano, Puerto Rican, or Cuban, they are rolled into the Hispanic or Latino category.

If a survey taker selects two or more race or ethnicity options, they will only be counted in one race or ethnicity category according to a specific hierarchy.

See Race/Ethnicity Hierarchy below for details.

Race/Ethnicity Hierarchy

If a survey taker selects two or more race or ethnicity options, they will be counted in only one of their selected categories in the following “trumping” order:

Hispanic or Latino
Black or African American
American Indian or Alaska Native
Native Hawaiian or other Pacific Islander
Asian
White

For example, if a survey taker selects a Hispanic or Latino option plus White, they will only be counted in Hispanic or Latino.

Another example: If a survey taker selects American Indian or Alaska Native plus Native Hawaiian or other Pacific Islander plus Asian, they will only be counted in the American Indian or Alaska Native category.

This race/ethnicity hierarchy is in place in order to avoid small cell issues, as small cells could jeopardize a survey taker’s anonymity.