attention star-empty star-fill bang mail phone filter check-tiny add-tiny add-tiny-hollow close-tiny organization board-certification grants misc subtract editor crop upload reorder hazard unlocked locked checkbox-control link-out arrow-left arrow-right menu add edit help clear check close trash chevron-down chevron-left chevron-right chevron-up search award book certification chat patent dna education id pulse vcard file-bad file-good sort-down sort-up group deskphone description orgchart

UF Health Web Directory API

Description

API endpoints that allow other applications and services to access directory data in JSON format. There are 3 tiers of endpoint access: public, secured, and restricted.

  • Public - Will return public data that is visible on https://directory.ufhealth.org/.
  • Secured - Will return data that are would require authenticationt to view on https://directory.ufhealth.org/, but not FERPA protected data, e.g. student photos and UFID.
  • Restricted - Will return secured data AND FERPA protected data.

How to Access Secured/Restricted Endpoints

To access Secured and Restricted endpoints, you must get a API key from Web Services department (request at WebServices@ahc.ufl.edu). The API key is unique to each application, and will only be usable by specified IP addresses.

Once you have the API key, add the key as a querystring in the requests to Secured/Restricted endpoints (e.g. /webservices/restricted/v1.1/profiles/email/morales2@ufl.edu/?key=APIKEY). Please note that the API key is case sensitive.

Endpoints

  • Public:

    • /webservices/v1.1/profiles/ufid/{UFID} - Retrieve individual profile data by UFID.
    • /webservices/v1.1/profiles/email/{EMAIL} - Retrieve individual profile data by Email.
    • /webservices/v1.1/profiles/all - Retrieve all profiles. You can page through the results and adjust the number of items per page by using the following querystring parameters:
      • page: default is 1.
      • pagesize: default is 10.
    • /webservices/v1.1/profiles/search/{TERM} - Returns a listing of profiles matching the search term. You can page through the results and adjust the number of items per page by using the following querystring parameters:
      • page: default is 1.
      • pagesize: default is 10.
    • /webservices/v1.1/departments/search/{TERM} - Returns a listing of departments matching the search term.
    • /webservices/v1.1/departments/{DEPARTMENT_NAME}/profiles - Returns a listing of profiles in the specified department. The name of the department must match what is returned in the department search endpoint above.
    • /webservices/v1.1/groups/search/{TERM} - Returns a listing of custom groups matching the search term.
    • /webservices/v1.1/groups/{GROUP_ID} - Returns detailed information about a specific group.
  • Secured:

    • /webservices/secured/v1.1/profiles/ufid/{UFID} - Retrieve individual profile data by UFID.
    • /webservices/secured/v1.1/profiles/email/{EMAIL} - Retrieve individual profile data by Email.
    • /webservices/secured/v1.1/profiles/all - Retrieve all profiles. You can page through the results and adjust the number of items per page by using the following querystring parameters:
      • page: default is 1.
      • pagesize: default is 10.
  • Restricted

    • /webservices/restricted/v1.1/profiles/ufid/{UFID} - Retrieve individual profile data by UFID.
    • /webservices/restricted/v1.1/profiles/email/{EMAIL} - Retrieve individual profile data by Email.
    • /webservices/restricted/v1.1/profiles/all - Retrieve all profiles. You can page through the results and adjust the number of items per page by using the following querystring parameters:
      • page: default is 1.
      • pagesize: default is 10.
    • /webservices/restricted/v1.1/departments/search/{TERM} - Returns a listing of departments matching the search term.
    • /webservices/restricted/v1.1/departments/{DEPARTMENT_NAME}/profiles - Returns a listing of profiles in the specified department. The name of the department must match what is returned in the department search endpoint above.
    • /webservices/restricted/v1.1/groups/{GROUP_ID}/members - Returns a paged listing of members in the specified group. You can page through the results and adjust the number of items per page by using the following querystring parameters:
      • page: default is 1.
      • limit: default is 25.

UF Health is a collaboration of the University of Florida Health Science Center, Shands hospitals and other health care entities. © 2019 University of Florida Health