Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Interfolio Evaluations API
version: 1.0.0
x-logo:
url: /images/logo_faculty180_intf.png
description: 'Operations tagged Evaluations across 2 of this provider''s published API definitions: faculty180-swagger.json, interfolio-faculty180-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://faculty180.interfolio.com
tags:
- name: Evaluations
description: Retrieve details of users' evaluations.
paths:
/api.php/evaluations:
get:
tags:
- Evaluations
summary: Retrieves details for users' evaluations
description: 'Description
Retrieves details on evaluations. A count of the evaluations will be returned if no parameters are specified.
Example URL(s)
https://faculty180.interfolio.com/api.php/evaluations?data=detailed'
operationId: facultyEvaluations
parameters:
- name: data
in: query
description: "Determines the extent of data that will be returned.\n * **Count:** Returns the number of evaluations found.\n * **Summary:** Returns the same data as reported by “detailed”.\n * **Detailed:** Returns an array of values for the specified evaluations."
schema:
type: string
enum:
- count
- summary
- detailed
default: count
- $ref: '#/components/parameters/q'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
responses:
'200':
description: List of users' evaluations.
content:
application/json:
example:
- id: 80
evaluation_id: 1184
facultyid: m123456
unit: University
title: IS Department Committee Review
type: Tenure Evaluation
status_date: '2017-04-24 14:00:00'
due_date: '2018-01-10 17:45:00'
date_created: '2017-01-11 14:30:00'
date_submitted: '2017-04-24 14:14:00'
date_response_submitted: '2017-04-25 12:15:00'
open_for_response: true
default:
description: an "unexpected" error
servers:
- url: https://faculty180.interfolio.com
/evaluations/search:
get:
tags:
- Evaluations
summary: Searches for an existing evaluation
description: 'Description
Retrieves details for any evaluations matching the search criteria.
Example URL(s)
https://faculty180.interfolio.com/evaluations/search'
operationId: faq
parameters:
- name: title
in: query
description: The title assigned to the evaluation
required: true
schema:
type: string
- name: process_id
in: query
description: The process id associated with the evaluation process in which the evaluation resides.
required: true
schema:
type: integer
- name: unit_id
in: query
description: The unit id associated with the unit in which the evaluation resides.
required: true
schema:
type: integer
- name: self_evaluation
in: query
description: When true, the serach will be limited to self_evaluations
required: true
schema:
type: boolean
- name: template_flag
in: query
description: "Retrieve evaluations that are not templates by using 0. Evaluations that are templates\n * with a value of 1, or evaluations that are workflow templates with a value of 2."
required: true
schema:
type: integer
responses:
'200':
description: Evaluations that match the request.
content:
application/json:
example:
data:
- id: 2
creator: 0022843
unit_id: 1
title: 2017 Tenure Evaluation
description: Tenure evaluation for 2017 candidates.
reviewers_group_id: 4
reviewees_group_id: 6
email_group_id: 5
page_access: CV
review_type: Tenure Evaluation
time_created: '2017-01-01 15:06:28.24691'
time_started: '2017-03-15 08:00:00'
time_due: '2017-07-15 16:00:00'
time_completed: null
response_due: 10
evaluation_access: 79
classification_term_id_started: null
classification_term_id_finished: null
self_evaluation: 0
template_flag: 0
time_access_faculty: null
standard_input_flag: 1
allow_attachments: 1
collaborative: 0
default:
description: an "unexpected" error
servers:
- url: https://faculty180.interfolio.com
components:
parameters:
offset:
name: offset
in: query
description: Used to offset queries that are segmented into chunks with limit.
schema:
type: integer
limit:
name: limit
in: query
description: Limit query to specified number of records.
schema:
type: integer
q:
name: q
in: query
description: Search term. Use '*' as wildcard.
schema:
type: string
x-refined-from:
- faculty180-swagger.json
- interfolio-faculty180-openapi.yml