UC Recruit provides a RESTful web service to expose the search exemptions stored in the system. 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 Search Exemptions
To list the entire set of Search Exemptions in a given Academic Year:
GET https://recruit.ucx.edu/api/v1/exemptions?academic_year=2015%20-%202016
Note that the academic_year parameter must follow the format nnnn – nnnn.
Whitespace is significant and required.
Asking for years that the system does not know about will yield an empty list of Search Exemptions.
Asking without providing an Academic Year will result in a 400 response code.
The following fields are present in a successful response:
Fields for search exemptions list |
Format | |
|---|---|---|
| exemptions | An array of search exemption descriptions for the requested Academic Year. Contains subfields. |
Object |
| meta | Meta information. Contains subfields. |
Object |
Fields for meta |
Format | |
| academic_year | The Academic Year that was requested. | /^d{4} – d{4}$/ |
| as_of | A timestamp showing when the list was generated. | ISO 8601 “Combined date and time in UTC” format. Example: 2012-04-19T20:13Z |
Once you have this information you can look at individual search exemptions using the next endpoint.
Fetching Indvidual Search Exemption Information
To obtain more information about an individual search exemption with code EXR00123:
GET https://recruit.ucx.edu/api/v1/exemptions/EXR00123
Asking for search exemptions that the system does not know about will yield a 404 response code.
A valid response will return one JSON object representing the search exemption.
Fields for search exemptions |
Format | |
|---|---|---|
| academic_year | The academic year in which this search exemption was initiated. | /^d{4} – d{4}$/ |
| added_history | Any historical records that were added to this waiver. Contains subfields. | array of objects |
| additional_information | Any additional information about the candidate or position that the exemption contains. This field is not available in the list view. | text |
| appointment_start_date | The appointment start date for this exemption. | ISO 8601 date |
| approval_status | The status of the approval request for this Exemption request. | Text |
| candidate_employment_status.description | A long description of the candidate’s employment status with UC before the exemption | string |
| candidate_employment_status.value | The candidate’s employment status with UC before the exemption | string |
| candidate_hired | Indicates whether the candidate has been hired. | boolean |
| candidate_name | The name of the candidate for whom the search exemption was created | string |
| category | Category of the exemption.Contains subfields. | Object |
| code | The identifier you can use to refer to this search exemption request | Matches the regular expression /EXR(d+)/ |
| concluded_at | A timestamp revealing when this exemption was concluded. | ISO 8601 date |
| created_at | The date that this search exemption was created | ISO 8601 date and time |
| created_by_external_user_id | The external_user_id of the user who created the search exemption. | text |
| declined_at | The date that the exemption was declined. | ISO 8601 date |
| declined_by_external_user_id | The external_user_id of the user who declined the exemption. | text |
| department | The home department for this Search Exemption. Contains subfields. |
Object |
| department_comments | Any comments the department entered into the search exemption. This field is not available in the list view. | text |
| discovered_history | Any historical records that share a connection with this waiver. These are automatically discovered based on their waiver’s employee ID and email addresses. Contains subfields. | array of objects |
| employee_id | The candidate employee ID for this exemption. | string |
| ends_on | The search exemption’s effective end date | ISO 8601 date |
| school | The home school for this Exemption. | String Contains subfields. |
| starts_on | The search exemption’s effective start date | ISO 8601 date |
| supporting_documents | An array of documents provided in support of the request.Contains subfields. | Array of objects |
| updated_at | The last time this exemption was edited | ISO 8601 date and time |
| urls | URLs for the search exemption. Contains subfields. | Object |
Fields for approval |
||
| approvers | The steps that this approval must take to be approved. Each element contains subfields. |
Object |
| comments | The comments made on this approval. Each element contains subfields. |
Object |
| creator | The the user who submitted this approval request | Object |
| created_at | When this approval was submitted | ISO8601 date |
| name | The name of this approval request | text |
| updated_at | When this approval was last modified. Includes comments added, approvers filled, and changes to the approved object. |
ISO8601 date |
Fields for approvers |
||
| created_at | When this approver step was submitted. | ISO8601 date |
| filled_by_external_user_id | The external user id of the user who filled this step, if it is filled | text |
| name | The name of the step. Explains who can fill it. | text |
| required | Indicate whether this step is required or not. | boolean |
| updated_at | When this approval was last modified. | ISO8601 date |
Fields for category |
||
| name | The category’s name (True Visitor, Recall Appointment, etc). | text |
Fields for department |
||
| external_id | The department’s external ID. | text |
| name | The department’s name. | text |
| tags | Tags associated with the department | Array of strings |
Fields for school |
||
| abbreviation | Abbreviation of school | text |
| address | Address of school | text |
| external_id | External id of school | text |
| name | Name of school | text |
| tags | Tags associated with the school | Array of strings |
Fields for supporting documents |
||
| content_type | The MIME type of the provided document. | String |
| created_at | When this document step was uploaded. | ISO8601 date |
| created_by_external_user_id | The external user id of the person who uploaded the document. | string |
| description | An optional string explaining what the document is. | string |
| external | If true, this file is not digital, and Recruit only has a placeholder. The description and the placeholder will contain information on where to obtain the actual materials. | boolean |
| filename | The name of the file when it was uploaded. | string |
| size | The size of the file, in bytes. | integer |
| updated_at | When this document was last modified. | ISO8601 date |
Fields for search exemptions URLs |
||
| api | The URL at which more information about this search exemption can be obtained. | string |
| cv | A URL url to the candidate CV. | string |
Fields for supporting documents URLs |
||
| download | A URL where the file contents can be obtained. | string |