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 Activity Classifications API
version: 1.0.0
x-logo:
url: /images/logo_faculty180_intf.png
description: 'Operations tagged Activity Classifications 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: Activity Classifications
description: Retrieves details regarding activity classifications.
paths:
/api.php/activityclassifications:
get:
tags:
- Activity Classifications
summary: Retrieves details regarding activity classifications
description: 'Description
Retrieves activity classifications. A count of the activity classifications will be returned if no parameters are specified.
Example URL(s)
https://faculty180.interfolio.com/api.php/activityclassifications?data=detailed'
operationId: activityclassifications
parameters:
- name: unitid
in: query
description: "Retrieve an Activity Classification with a specific unitid.\n * When defined, filter classifications to the specified unit.\n * When undefined, filters classifications from the highest unit accessible."
schema:
type: integer
- name: data
in: query
description: "Determines the extent of data that will be returned.\n * **Count:** Returns count of number of activity classifications found.\n * **Summary:** Returns the same data as 'detailed'.\n * **Detailed:** Returns an array of values for all activity classifications."
schema:
type: string
enum:
- count
- summary
- detailed
default: count
- $ref: '#/components/parameters/q'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
responses:
'200':
description: A list of Activity Classifications.
content:
application/json:
example:
- activityclassificationid: 18
classification_name: 'Professional Development: Category'
default:
description: an "unexpected" error
servers:
- url: https://faculty180.interfolio.com
/api.php/activityclassifications/{activityclassificationid}:
get:
tags:
- Activity Classifications
summary: Retrieves details regarding activity classifications
description: 'Description
Retrieves details on a specific activity classification. A count of the activity classification will be returned if no parameters are specified.
Example URL(s)
https://faculty180.interfolio.com/api.php/activityclassifications/18?data=detailed'
operationId: getApiPhpActivityclassificationsByActivityclassificationid
parameters:
- name: activityclassificationid
in: path
description: Retrieves a specific Activity Classification based on the activityclassificationid.
schema:
type: integer
required: true
- name: data
in: query
description: "Determines the extent of data that will be returned.\n * **Count:** Returns value of 1 if desired resource exists or 0 otherwise.\n * **Summary:** Returns the same data as 'detailed'.\n * **Detailed:** Returns an array of values for all activity classifications.\n * The string returned for each of the 'choices' is the activityclassificationchoicevalue which is used for later filtering by Activity resources."
schema:
type: string
enum:
- count
- summary
- detailed
default: count
- $ref: '#/components/parameters/q'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
responses:
'200':
description: A list of a specific Activity Classification.
content:
application/json:
example:
- activityclassificationid: 18
classification_name: 'Professional Development: Category'
choices:
'64': Instructional
'65': Professional
'66': Research
default:
description: an "unexpected" error
x-operation-id-source: normalized
x-operation-id-original: activityclassifications
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