UC Recruit Project Site

Updates, information, and documentation for UC Recruit, the system-wide academic employee recruitment web application

UC Recruit Feeds Web API

Recruit supports the importing of data unique to your campus via the Feeds Web API.

There are three requirements for using the API:

If you need technical information and advice with writing an implementation of a Recruit Web API feeder, please contact us at UCRecruit-Support@uci.edu.

Valid File Upload and Payload Formats

UC Recruit applies three passes of validation rules during data upload: ZIP format rules, CSV format rules and data format rules.

ZIP Format Rules

  • The API accepts one ZIP formatted file
  • The ZIP file may be named anything, but must contain the extension “.zip” (lowercase)
  • The ZIP file archive contains the CSV files we accept (see “CSV Format Rules” for more information)
  • The ZIP file archive must contain at least one CSV file, but can contain up to the five accepted CSV files
  • Only one CSV file per data category should be in the ZIP archive.
  • The CSV files should all be at the same level of the ZIP archive.  Files in subdirectories of the ZIP file archive will be ignored.

CSV Format Rules

  • UC Recruit uses a fairly strict definition of CSV taken directly from the RFC.  When UC Recruit encounters a CSV file that does not adhere to the RFC definition, the import process is aborted without changing any data.
  • The CSV file must have the extension “.csv” (lowercase)
  • The CSV file names need to conform to the naming conventions described below.  Any other names will be ignored.
Accepted CSV file names Description
schools.csv One of two hierarchy files, used to organize recruitments, grant user access and facilitate delegation of support within the appropriate school
departments.csv One of two hierarchy files, used to organize recruitments, grant user access and facilitate delegation of support within the appropriate department
directory.csv File containing directory data of academic faculty users, e.g. anyone who could be included in search committee activities or administration of the Recruit system.
user_roles.csv File containing authorization data, i.e. the relationships between Recruit users, roles and resources
demographics.csv  File containing demographic data on academic employees that are eligible to serve on search committees

Data Format Rules

  • UC Recruit maintains strict data types and foreign key relationships for all underlying data models.
  • Headers are required for all CSV datasets.  See required header labels below.
  • Header names are lowercase
  • The number of columns is required, even if their values are optional
  • Most values are required.  See each dataset’s documentation for details
  • Optional values that are not provided must be represented as empty strings (,””,) or as empty entries (,,)
Dataset Headers Headers Required Number of columns
Schools external_id, name, abbreviation, address Yes 4
Departments external_id, name, school_external_id Yes 3
Directory external_user_id, alias, name, last_first_name, email_address, department, department_code, student_id, employee_id, faculty_level Yes 10
User roles external_user_id, role, resource_type, resource_external_id Yes 4
Demographics  external_user_id, ethnicity, gender, member_type Yes 4

Please see each dataset’s documentation for more information:

  1. Schools/Divisions
  2. Departments
  3. User Directory
  4. User Roles
  5. Employee Demographic Data

Email Notifications

The import process sends emails of errors and successes.  Emails are sent to the data feed contact(s) at the customer campus. It is critical that the email address(es) on file are monitored by at least one person with the authority and operational responsibility to quickly resolve data errors, as they could lead to a negative impact on the user experience or inhibit full use of UC Recruit for your campus.

Actions on Errors

The three areas of errors are handled as:

Type Examples of errors Action
ZIP format errors File is not a ZIP file
File is missing the suffix “.zip”.		 No data is processed and all parties are notified
CSV format errors File is missing a required column
Rows have uneven columns		 No data is processed and all parties are notified
Data validation errors Dependent resource does not exist. For example, user on which demographics depends is not found; school on which department depends is not found
Required data is missing. For example, demographics is missing data; user_role is missing data		 Rows with validation errors are skipped, and valid rows are processed. Email of errors and successes are emailed to the data feed contacts

Please contact UCRecruit-Support@uci.edu regarding support for any feed issues.

Valid POST Requests to the API Endpoints

  • The sending client’s (or proxy server’s) IP address must be registered in Recruit’s firewall safe-list. Contact UCRecruit-Support@uci.edu to have your system’s IP address added.
  • The web API is accessible at each of the campus environments (see list below), from the path “/api/v1/feeds”
  • The request must be a POST request
  • The content type envelope containing the ZIP data must be “multipart/form-data”
  • The content type of the request header must be “application/zip”
  • The form field name containing the ZIP file payload must be “feed_data”
Campus URLs
UC ANR Production: https://recruit.ucanr.edu
Training: https://training.recruit.ucanr.edu
QA: https://qa.recruit.ucanr.edu
UC Berkeley Production: https://aprecruit.berkeley.edu
Training: https://training-aprecruit.berkeley.edu
QA: https://qa-aprecruit.berkeley.edu
UC Davis Production: https://recruit.ucdavis.edu
Training: https://training.recruit.ucdavis.edu
QA: https://qa.recruit.ucdavis.edu
UC Irvine Production: https://recruit.ap.uci.edu
Training: https://training.recruit.ap.uci.edu
QA: https://qa.recruit.ap.uci.edu
UC Los Angeles Production: https://recruit.apo.ucla.edu
Training: https://training.recruit.apo.ucla.edu
QA: https://qa.recruit.apo.ucla.edu
UC Merced Production: https://aprecruit.ucmerced.edu
Training: https://training.aprecruit.ucmerced.edu
QA: https://qa.aprecruit.ucmerced.edu
UC Riverside Production: https://aprecruit.ucr.edu
Training: https://training.aprecruit.ucr.edu
QA: https://qa.aprecruit.ucr.edu
UC Santa Barbara Production: https://recruit.ap.ucsb.edu
Training: https://training.recruit.ap.ucsb.edu
QA: https://qa.recruit.ap.ucsb.edu
UC Santa Cruz Production: https://recruit.ucsc.edu
Training: https://training.recruit.ucsc.edu
QA: https://qa.recruit.ucsc.edu
UC San Diego Production: https://apol-recruit.ucsd.edu
Training: https://training.apol-recruit.ucsd.edu
QA: https://qa.apol-recruit.ucsd.edu
UC San Francisco Production: https://aprecruit.ucsf.edu
Training: https://training.aprecruit.ucsf.edu
QA: https://qa.aprecruit.ucsf.edu

Valid Credentials

  • Credentials are unique per campus
  • The same credentials apply across all the campus’s environments
  • Credentials are used in basic authentication during the HTTPS POST request
  • Please contact UCRecruit-Support@uci.edu to obtain your credentials, or to answer any questions about credentials