{
"openapi": "3.0.0",
"info": {
"title": "APL API",
"description": "APL NextED - OpenAPI Specification\n\n --------------------------------------------------------------------\n OAuth Token Request Examples:\n --------------------------------------------------------------------\n\n --- RAW\n\n curl --location --request POST 'https://api.aplnexted.com/oauth/token' \\\n --header 'Content-Type: application/json' \\\n --header 'Content-Length: {some non-zero value} ON PUT and POST' \\\n --header 'User-Agent: APL API Client v1' \\\n --data-raw '{\n \"grant_type\": \"password\",\n \"client_id\": \"{Client ID}\",\n \"client_secret\": \"{Client Secret}\",\n \"username\": \"{user name}\",\n \"password\": \"{password}\"\n }'\n\n --- FORM POST\n\n curl --location --request POST 'https://api.aplnexted.com/oauth/token' \\\n --header 'User-Agent: APL API Client v1' \\\n --form 'grant_type=\"password\"' \\\n --form 'client_id=\"{Client ID}\"' \\\n --form 'client_secret=\"{Client Secret}\"' \\\n --form 'username=\"{user name}\"' \\\n --form 'password=\"{password}\"'\n\n --------------------------------------------------------------------\n Request Example:\n --------------------------------------------------------------------\n\n --- GET REQUEST\n\n curl --location --request GET 'https://api.aplnexted.com/api/v1/faculty' \\\n --header 'Accept: application/json' \\\n --header 'User-Agent: APL API Client v1' \\\n --header 'Authorization: Bearer {Bearer Token}'\n ",
"version": "1.1.0"
},
"paths": {
"/v1/activity": {
"get": {
"tags": [
"Activity"
],
"summary": "Get list of activities",
"description": "Returns list of activities. Default required fields for creation: faculty_unique_id, title_of_activity, type, subtype_id, start_date. Note: Some institutions may have additional required fields configured via the APL application's institution activity configuration area.",
"operationId": "getActivities",
"parameters": [
{
"name": "faculty_unique_id",
"in": "query",
"description": "Filter by faculty unique ID",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type_id",
"in": "query",
"description": "Filter by activity type ID",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "year",
"in": "query",
"description": "Filter by academic year",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Activity"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Activity"
],
"summary": "Add a new Activity",
"description": "Add a new Activity. Required fields: faculty_unique_id, title_of_activity, type, subtype_id, start_date. Note: Some institutions may have additional required fields configured via the APL application's institution activity configuration area (activity_type_field_settings table).",
"operationId": "storeActivity",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"faculty_unique_id",
"title_of_activity",
"type",
"subtype_id",
"start_date"
],
"properties": {
"faculty_unique_id": {
"description": "Faculty UniqueID (always required)",
"type": "string"
},
"title_of_activity": {
"description": "Title Of Activity (always required)",
"type": "string"
},
"type": {
"description": "Activity Type name (always required)",
"type": "string"
},
"subtype_id": {
"description": "Subtype ID (always required)",
"type": "integer"
},
"start_date": {
"description": "Start Date (always required)",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date",
"type": "string",
"format": "date"
},
"tertiarytype_id": {
"description": "Tertiary Type ID",
"type": "integer"
},
"total": {
"description": "Total",
"type": "integer"
},
"count": {
"description": "Count",
"type": "integer"
},
"hours": {
"description": "Hours",
"type": "number",
"format": "float"
},
"dollars": {
"description": "Dollars",
"type": "number",
"format": "float"
},
"academic_year": {
"description": "Academic Year",
"type": "string"
},
"unique_id": {
"description": "UniqueID",
"type": "string"
},
"description": {
"description": "Description",
"type": "string"
},
"contributors": {
"description": "Contributors",
"type": "string"
},
"link": {
"description": "Link",
"type": "string"
},
"provider": {
"description": "Provider",
"type": "string"
},
"advisees": {
"description": "Advisees",
"type": "integer"
},
"grantor": {
"description": "Grantor",
"type": "string"
},
"role": {
"description": "Role",
"type": "string"
},
"journal_name": {
"description": "Journal Name",
"type": "string"
},
"acceptance_rate": {
"description": "Acceptance Rate",
"type": "string"
},
"circulation": {
"description": "Circulation",
"type": "string"
},
"selection_method": {
"description": "Selection Method",
"type": "string"
},
"citation": {
"description": "Citation",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/activity/{unique_id}": {
"get": {
"tags": [
"Activity"
],
"summary": "Get Activity information by UniqueID",
"description": "Returns Activity data",
"operationId": "getByActivityUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Activity UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Activity"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Activity"
],
"summary": "Update An Activity",
"description": "Update an Activity entry. Required fields cannot be removed: faculty_unique_id, title_of_activity, type, subtype_id, start_date. Note: Some institutions may have additional required fields configured.",
"operationId": "updateActivity",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Activity UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"faculty_unique_id": {
"description": "Faculty UniqueID",
"type": "string"
},
"title_of_activity": {
"description": "Title Of Activity",
"type": "string"
},
"type": {
"description": "Type",
"type": "string"
},
"subtype_id": {
"description": "Subtype ID",
"type": "integer"
},
"tertiarytype_id": {
"description": "Tertiary Type ID",
"type": "integer"
},
"total": {
"description": "Total",
"type": "integer"
},
"count": {
"description": "Count",
"type": "integer"
},
"hours": {
"description": "Hours",
"type": "number",
"format": "float"
},
"dollars": {
"description": "Dollars",
"type": "number",
"format": "float"
},
"start_date": {
"description": "Start Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date",
"type": "string",
"format": "date"
},
"academic_year": {
"description": "Academic Year",
"type": "string"
},
"description": {
"description": "Description",
"type": "string"
},
"contributors": {
"description": "Contributors",
"type": "string"
},
"link": {
"description": "Link",
"type": "string"
},
"provider": {
"description": "Provider",
"type": "string"
},
"advisees": {
"description": "Advisees",
"type": "integer"
},
"grantor": {
"description": "Grantor",
"type": "string"
},
"role": {
"description": "Role",
"type": "string"
},
"journal_name": {
"description": "Journal Name",
"type": "string"
},
"acceptance_rate": {
"description": "Acceptance Rate",
"type": "string"
},
"circulation": {
"description": "Circulation",
"type": "string"
},
"selection_method": {
"description": "Selection Method",
"type": "string"
},
"citation": {
"description": "Citation",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Activity"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Activity"
],
"summary": "Delete An Activity",
"description": "Delete an Activity entry.",
"operationId": "destroyActivity",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Activity UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/activity-status": {
"get": {
"tags": [
"ActivityStatus"
],
"summary": "Get list of activity status",
"description": "Returns list of activity status",
"operationId": "getActivityStatus",
"responses": {
"200": {
"description": "index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivityStatus"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"ActivityStatus"
],
"summary": "Add a new Activity Status",
"description": "Add a new Activity Status",
"operationId": "storeActivityStatus",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"faculty_unique_id",
"activity_unique_id",
"status",
"year"
],
"properties": {
"activity_unique_id": {
"description": "Activity Unique ID",
"type": "string"
},
"faculty_unique_id": {
"description": "Faculty Unique ID",
"type": "string"
},
"status": {
"description": "Activity Status(Values for Status can be only one of the following: Pending, Accepted, Submitted, Completed)",
"type": "string"
},
"year": {
"description": "Academic Year",
"type": "string"
},
"comments": {
"description": "Comments",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivityStatus"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/activity-status/{id}": {
"get": {
"tags": [
"ActivityStatus"
],
"summary": "Get Activity Status information by UniqueID",
"description": "Returns Activity Status data",
"operationId": "getActivityStatusById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Activity Status ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivityStatus"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"ActivityStatus"
],
"summary": "Update Activity Status Status information",
"description": "Update Attribute data",
"operationId": "updateActivityStatus",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Activity Status ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"faculty_unique_id",
"activity_unique_id",
"status",
"year"
],
"properties": {
"activity_unique_id": {
"description": "Activity Unique ID",
"type": "string"
},
"faculty_unique_id": {
"description": "Faculty Unique ID",
"type": "string"
},
"status": {
"description": "Activity Status(Values for Status can be only one of the following: Pending, Accepted, Submitted, Completed)",
"type": "string"
},
"year": {
"description": "Academic Year",
"type": "string"
},
"comments": {
"description": "Comments",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivityStatus"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"ActivityStatus"
],
"summary": "Delete Activity Status information",
"description": "Delete Activity Status data",
"operationId": "destroyActivityStatus",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Activity Status ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/attribute": {
"get": {
"tags": [
"Attribute"
],
"summary": "Get list of Attributes",
"description": "Returns list of Attributes",
"operationId": "getAttibutes",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Attribute"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Attribute"
],
"summary": "Add a new Attribute",
"description": "Add a new Attribute",
"operationId": "storeAttribute",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"faculty_unique_id",
"academic_year"
],
"properties": {
"faculty_unique_id": {
"description": "Faculty Unique ID",
"type": "string"
},
"academic_year": {
"description": "Academic Year",
"type": "string"
},
"rank": {
"description": "Rank Id",
"type": "integer"
},
"track": {
"description": "Track Id",
"type": "integer"
},
"load": {
"description": "Load Class Id",
"type": "integer"
},
"loadstatus": {
"description": "University Load Status Id",
"type": "integer"
},
"compensation_mode": {
"description": "Compensation Mode Id",
"type": "integer"
},
"qualification_group": {
"description": "Qualification Group Id",
"type": "integer"
},
"effective_date": {
"description": "Effective Date",
"type": "string",
"format": "date"
},
"unique_id": {
"description": "Unique Id",
"type": "string"
},
"faculty_comp_unique_id": {
"description": "Compensation Faculty Unique Id",
"type": "string"
},
"faculty_distinction_unique_id": {
"description": "Faculty Distinction Unique ID",
"type": "string"
},
"affiliation_unique_id": {
"description": "Affiliation Unique ID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Attribute"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/attribute/{unique_id}": {
"get": {
"tags": [
"Attribute"
],
"summary": "Get Attribute information by UniqueID",
"description": "Returns Attribute data",
"operationId": "getAttributeByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Attribute UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "view",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Attribute"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Attribute"
],
"summary": "Update Attribute information",
"description": "Update Attribute data",
"operationId": "updateAttribute",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Attribute UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"faculty_unique_id",
"academic_year"
],
"properties": {
"faculty_unique_id": {
"description": "Faculty Unique ID",
"type": "string"
},
"academic_year": {
"description": "Academic Year ex. 2025/2026",
"type": "string"
},
"rank": {
"description": "Rank",
"type": "integer"
},
"track": {
"description": "Track",
"type": "integer"
},
"load": {
"description": "Load Class Id",
"type": "integer"
},
"loadstatus": {
"description": "University Load Status Id",
"type": "integer"
},
"compensation_mode": {
"description": "Compensation Mode",
"type": "integer"
},
"qualification_group": {
"description": "Qualification Group",
"type": "integer"
},
"effective_date": {
"description": "Effective Date",
"type": "string",
"format": "date"
},
"faculty_comp_unique_id": {
"description": "Compensation Faculty Unique ID",
"type": "string"
},
"faculty_distinction_unique_id": {
"description": "Faculty Distinction Unique ID",
"type": "string"
},
"affiliation_unique_id": {
"description": "Affiliation Unique ID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Attribute"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Attribute"
],
"summary": "Delete Attribute information",
"description": "Delete Attribute data",
"operationId": "destroyAttribute",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Attribute UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/attribute/by-id/{id}": {
"get": {
"tags": [
"Attribute"
],
"summary": "Get Attribute information by ID",
"description": "Returns Attribute data",
"operationId": "getAttributeById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Attribute Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "view",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Attribute"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Attribute"
],
"summary": "Update Attribute information",
"description": "Update Attribute data",
"operationId": "updateAttributeById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Attribute Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"faculty_unique_id",
"academic_year"
],
"properties": {
"faculty_unique_id": {
"description": "Faculty Unique ID",
"type": "string"
},
"academic_year": {
"description": "Academic Year ex. 2025/2026",
"type": "string"
},
"rank": {
"description": "Rank",
"type": "integer"
},
"track": {
"description": "Track",
"type": "integer"
},
"load": {
"description": "Load Class Id",
"type": "integer"
},
"loadstatus": {
"description": "University Load Status Id",
"type": "integer"
},
"compensation_mode": {
"description": "Compensation Mode",
"type": "integer"
},
"qualification_group": {
"description": "Qualification Group",
"type": "integer"
},
"effective_date": {
"description": "Effective Date",
"type": "string",
"format": "date"
},
"faculty_comp_unique_id": {
"description": "Compensation Faculty Unique ID",
"type": "string"
},
"faculty_distinction_unique_id": {
"description": "Faculty Distinction Unique ID",
"type": "string"
},
"affiliation_unique_id": {
"description": "Affiliation Unique ID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Attribute"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/attribute-load": {
"get": {
"tags": [
"AttributeLoad"
],
"summary": "Get list of AttributeLoads",
"description": "Returns list of Attribute Loads",
"operationId": "getAttibuteLoads",
"responses": {
"200": {
"description": "index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttributeLoad"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"AttributeLoad"
],
"summary": "Add a new AttributeLoad",
"description": "Add a new AttributeLoad",
"operationId": "storeAttributeLoad",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name"
],
"properties": {
"unique_id": {
"description": "Unique ID",
"type": "string"
},
"name": {
"description": "Name",
"type": "string"
},
"class_id": {
"description": "",
"type": "integer"
},
"thresold": {
"description": "",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Attribute"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Access denied"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/attribute-load/{id}": {
"put": {
"tags": [
"AttributeLoad"
],
"summary": "Update the Attribute Load",
"description": "Update the Attribute Load",
"operationId": "updateAttributeLoad",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Attribute id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name"
],
"properties": {
"unique_id": {
"description": "Unique ID",
"type": "string"
},
"name": {
"description": "Name",
"type": "string"
},
"class_id": {
"description": "",
"type": "integer"
},
"thresold": {
"description": "",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttributeLoad"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Access denied"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"AttributeLoad"
],
"summary": "Delete Attribute Load information",
"description": "Delete Attribute Load data",
"operationId": "destroyAttributeLoad",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Attribute Load ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/attribute-rank": {
"get": {
"tags": [
"AttributeRank"
],
"summary": "Get list of Attribute Ranks",
"description": "Returns list of Attribute Ranks",
"operationId": "getAttibuteRanks",
"responses": {
"200": {
"description": "index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttributeRank"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"AttributeRank"
],
"summary": "Add a new AttributeRank",
"description": "Add a new AttributeRank",
"operationId": "storeAttributeRank",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name"
],
"properties": {
"unique_id": {
"description": "Unique ID",
"type": "string"
},
"name": {
"description": "Name",
"type": "string"
},
"class_id": {
"description": "",
"type": "integer"
},
"thresold": {
"description": "",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Attribute"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Access denied"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/attribute-rank/{id}": {
"get": {
"tags": [
"AttributeRank"
],
"summary": "Get list of Attribute Ranks",
"description": "Returns list of Attribute Ranks",
"operationId": "getAttributeRankById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Attribute Rank id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Attribute"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"AttributeRank"
],
"summary": "Update the Attribute Rank",
"description": "Update the Attribute Rank",
"operationId": "updateAttributeRank",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Attribute id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name"
],
"properties": {
"unique_id": {
"description": "Unique ID",
"type": "string"
},
"name": {
"description": "Name",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttributeRank"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Access denied"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"AttributeRank"
],
"summary": "Delete Attribute Rank record",
"description": "Delete Attribute Rank record",
"operationId": "destroyAttributeRank",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Attribute Rank ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/auto-staffing-jobs": {
"get": {
"tags": [
"AutoStaffingJob"
],
"summary": "Get list of Auto Staffing Jobs",
"description": "Returns list of Auto Staffing Jobs with search and pagination",
"operationId": "getAutoStaffingJobs",
"parameters": [
{
"name": "search",
"in": "query",
"description": "Search term for job name or status",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "Filter by job status",
"required": false,
"schema": {
"type": "string",
"enum": [
"draft",
"pending",
"completed",
"cancelled"
]
}
},
{
"name": "perpage",
"in": "query",
"description": "Number of items per page",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoStaffingJob"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"AutoStaffingJob"
],
"summary": "Create Auto Staffing Job",
"description": "Creates a new Auto Staffing Job",
"operationId": "storeAutoStaffingJob",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"name",
"status"
],
"properties": {
"name": {
"description": "Job name",
"type": "string"
},
"status": {
"description": "Job status",
"type": "string",
"enum": [
"draft",
"pending",
"completed",
"cancelled"
]
},
"campus_ids": {
"description": "Campus IDs",
"type": "array",
"items": {
"type": "integer"
}
},
"college_ids": {
"description": "College IDs",
"type": "array",
"items": {
"type": "integer"
}
},
"dept_ids": {
"description": "Department IDs",
"type": "array",
"items": {
"type": "integer"
}
},
"term_ids": {
"description": "Term IDs",
"type": "array",
"items": {
"type": "integer"
}
},
"academic_year": {
"description": "Academic year",
"type": "string"
},
"ranks": {
"description": "Rank criteria",
"type": "array",
"items": {
"type": "string"
}
},
"tracks": {
"description": "Track criteria",
"type": "array",
"items": {
"type": "string"
}
},
"loads": {
"description": "Load criteria",
"type": "array",
"items": {
"type": "string"
}
},
"affiliations": {
"description": "Affiliation criteria",
"type": "array",
"items": {
"type": "string"
}
},
"designations": {
"description": "Designation criteria",
"type": "array",
"items": {
"type": "string"
}
},
"distinctions": {
"description": "Distinction criteria",
"type": "array",
"items": {
"type": "string"
}
},
"taught_before": {
"description": "Must have taught before",
"type": "boolean"
},
"instruction_role": {
"description": "Instruction role ID",
"type": "integer"
},
"course_start_date_within_days": {
"description": "Course start date within days",
"type": "integer"
},
"date_to_execute": {
"description": "Date to execute",
"type": "string",
"format": "date-time"
},
"send_summary_email": {
"description": "Send summary email",
"type": "boolean"
},
"course_unique_ids": {
"description": "Array of course unique IDs to create job details for",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoStaffingJob"
}
}
}
},
"400": {
"description": "Bad Request"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/auto-staffing-jobs/{id}": {
"get": {
"tags": [
"AutoStaffingJob"
],
"summary": "Get Auto Staffing Job by ID",
"description": "Returns a single Auto Staffing Job with related data",
"operationId": "getAutoStaffingJob",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Auto Staffing Job ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoStaffingJob"
}
}
}
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"AutoStaffingJob"
],
"summary": "Update Auto Staffing Job",
"description": "Updates an existing Auto Staffing Job",
"operationId": "updateAutoStaffingJob",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Auto Staffing Job ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"name": {
"description": "Job name",
"type": "string"
},
"status": {
"description": "Job status",
"type": "string",
"enum": [
"draft",
"pending",
"completed",
"cancelled"
]
},
"campus_ids": {
"description": "Campus IDs",
"type": "array",
"items": {
"type": "integer"
}
},
"college_ids": {
"description": "College IDs",
"type": "array",
"items": {
"type": "integer"
}
},
"dept_ids": {
"description": "Department IDs",
"type": "array",
"items": {
"type": "integer"
}
},
"term_ids": {
"description": "Term IDs",
"type": "array",
"items": {
"type": "integer"
}
},
"academic_year": {
"description": "Academic year",
"type": "string"
},
"ranks": {
"description": "Rank criteria",
"type": "array",
"items": {
"type": "string"
}
},
"tracks": {
"description": "Track criteria",
"type": "array",
"items": {
"type": "string"
}
},
"loads": {
"description": "Load criteria",
"type": "array",
"items": {
"type": "string"
}
},
"affiliations": {
"description": "Affiliation criteria",
"type": "array",
"items": {
"type": "string"
}
},
"designations": {
"description": "Designation criteria",
"type": "array",
"items": {
"type": "string"
}
},
"distinctions": {
"description": "Distinction criteria",
"type": "array",
"items": {
"type": "string"
}
},
"taught_before": {
"description": "Must have taught before",
"type": "boolean"
},
"instruction_role": {
"description": "Instruction role ID",
"type": "integer"
},
"course_start_date_within_days": {
"description": "Course start date within days",
"type": "integer"
},
"date_to_execute": {
"description": "Date to execute",
"type": "string",
"format": "date-time"
},
"send_summary_email": {
"description": "Send summary email",
"type": "boolean"
},
"course_unique_ids": {
"description": "Array of course unique IDs to update job details for",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoStaffingJob"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"AutoStaffingJob"
],
"summary": "Delete Auto Staffing Job",
"description": "Soft deletes an Auto Staffing Job",
"operationId": "deleteAutoStaffingJob",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Auto Staffing Job ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/auto-staffing-job-details": {
"get": {
"tags": [
"AutoStaffingJobDetail"
],
"summary": "Get list of Auto Staffing Job Details",
"description": "Returns list of Auto Staffing Job Details with search and pagination",
"operationId": "getAutoStaffingJobDetails",
"parameters": [
{
"name": "search",
"in": "query",
"description": "Search term for status or status details",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "Filter by detail status",
"required": false,
"schema": {
"type": "string",
"enum": [
"pending",
"matched",
"failed",
"cancelled"
]
}
},
{
"name": "job_id",
"in": "query",
"description": "Filter by auto staffing job ID",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "perpage",
"in": "query",
"description": "Number of items per page",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoStaffingJobDetail"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/auto-staffing-job-details/{id}": {
"get": {
"tags": [
"AutoStaffingJobDetail"
],
"summary": "Get Auto Staffing Job Detail by ID",
"description": "Returns a single Auto Staffing Job Detail with related data",
"operationId": "getAutoStaffingJobDetail",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Auto Staffing Job Detail ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoStaffingJobDetail"
}
}
}
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"delete": {
"tags": [
"AutoStaffingJobDetail"
],
"summary": "Delete Auto Staffing Job Detail",
"description": "Soft deletes an Auto Staffing Job Detail",
"operationId": "deleteAutoStaffingJobDetail",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Auto Staffing Job Detail ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/bulkdataimport": {
"get": {
"tags": [
"BulkDataImport"
],
"summary": "Get list of BulkDataImports",
"description": "Returns list of BulkDataImports",
"operationId": "getBulkDataImports",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkDataImport"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/bulkdataimport/{id}": {
"get": {
"tags": [
"BulkDataImport"
],
"summary": "Get BulkDataImport information by Id",
"description": "Returns BulkDataImport data",
"operationId": "getBulkDataImportById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "BulkDataImport Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkDataImport"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/campus": {
"get": {
"tags": [
"Campus"
],
"summary": "Get list of Campuses",
"description": "Returns a list of Campuses",
"operationId": "getCampuses",
"responses": {
"200": {
"description": "index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Campus"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Campus"
],
"summary": "Add a new Campus",
"description": "Add a new Campus",
"operationId": "storeCampus",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"unique_id"
],
"properties": {
"name": {
"description": "Campus Name",
"type": "string"
},
"unique_id": {
"description": "Campus UniqueID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Campus"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/campus/{unique_id}": {
"get": {
"tags": [
"Campus"
],
"summary": "Get Campus information by UniqueID",
"description": "Returns Campus data",
"operationId": "getCampusByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Campus UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Campus"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Campus"
],
"summary": "Update Campus information",
"description": "Update Campus data",
"operationId": "updateCampus",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Campus UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "Campus Name",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Campus"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Campus"
],
"summary": "Delete Campus information",
"description": "Delete Campus data",
"operationId": "destroyCampus",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Campus UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/college": {
"get": {
"tags": [
"College"
],
"summary": "Get list of Colleges",
"description": "Returns list of Colleges",
"operationId": "getColleges",
"responses": {
"200": {
"description": "Index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/College"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"College"
],
"summary": "Add a new College",
"description": "Add a new College",
"operationId": "storeCollege",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"unique_id"
],
"properties": {
"name": {
"description": "College Name",
"type": "string"
},
"unique_id": {
"description": "College UniqueID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/College"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/college/{unique_id}": {
"get": {
"tags": [
"College"
],
"summary": "Get College information by UniqueID",
"description": "Returns College data",
"operationId": "getCollegeByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "College UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/College"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"College"
],
"summary": "Update A College",
"description": "Update a College entry.",
"operationId": "updateCollege",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "College UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "College Name",
"type": "string"
},
"unique_id": {
"description": "College UniqueID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/College"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"College"
],
"summary": "Delete A College",
"description": "Delete a College entry.",
"operationId": "destroyCollege",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "College UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/contract": {
"get": {
"tags": [
"Contract"
],
"summary": "Get list of Contracts",
"description": "Returns a list of Contracts",
"operationId": "getContracts",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Contract"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Contract"
],
"summary": "Add a new Contract",
"description": "Add a new Contract",
"operationId": "storeContract",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"faculty_unique_id",
"contract_template_unique_id"
],
"properties": {
"name": {
"description": "Contract Name",
"type": "string"
},
"unique_id": {
"description": "Contract Unique ID",
"type": "string"
},
"faculty_unique_id": {
"description": "Faculty Unique ID",
"type": "string"
},
"course_unique_id": {
"description": "Course Unique ID",
"type": "string"
},
"contract_template_unique_id": {
"description": "Contract Template Unique ID",
"type": "string"
},
"expiration_date": {
"description": "Contract Expiration Date",
"type": "string",
"format": "date"
},
"term_id": {
"description": "Contract term id",
"type": "integer"
},
"additional": {
"description": "Array of additional data strings",
"type": "array",
"items": {
"type": "string",
"example": "additonal1"
},
"collectionFormat": "multi"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Contract"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/contract/{id}": {
"get": {
"tags": [
"Contract"
],
"summary": "Get Contract information by ID",
"description": "Returns Ccontract data",
"operationId": "getContractById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Contract ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Contract"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Contract"
],
"summary": "Delete Contract",
"description": "Delete Contract data",
"operationId": "destroyContract",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Contract ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/contract/unique_id/{unique_id}": {
"get": {
"tags": [
"Contract"
],
"summary": "Get Contract information by ID",
"description": "Returns Contract data",
"operationId": "getContractByUniqueId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Contract ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Contract"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Contract"
],
"summary": "Delete Contract",
"description": "Delete Contract data",
"operationId": "destroyContractByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Contract Unique ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/contract-template": {
"get": {
"tags": [
"ContractTemplate"
],
"summary": "Get list of Contract Templates",
"description": "Returns a list of Contract Templates",
"operationId": "getContractTemplate",
"responses": {
"200": {
"description": "index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContractTemplate"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/contract-template/{id}": {
"get": {
"tags": [
"ContractTemplate"
],
"summary": "Get Contract Template by ID",
"description": "Returns Contract Template data",
"operationId": "getContractTemplateById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Contract Template ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContractTemplate"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/contract-template/unique_id/{unique_id}": {
"get": {
"tags": [
"ContractTemplate"
],
"summary": "Get Contract Template information by Unique ID",
"description": "Returns Contract Template data",
"operationId": "getContractTemplateByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Contract Template Unique ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContractTemplate"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/course-compensation": {
"get": {
"tags": [
"CourseCompensation"
],
"summary": "Get list of Course Compensation",
"description": "Returns a list of CoursCompensation",
"operationId": "getCourseCompensation",
"responses": {
"200": {
"description": "index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseCompensation"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"CourseCompensation"
],
"summary": "Add a new Course Compensation",
"description": "Add a new Course Compensation",
"operationId": "storeCourseCompensation",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"unique_id"
],
"properties": {
"name": {
"description": "Course Compensation name",
"type": "string"
},
"unique_id": {
"description": "Course Compensation UniqueID",
"type": "string"
},
"use_enrollment_thresholds": {
"description": "Use Enrollment Thresholds",
"type": "integer"
},
"threshold_number": {
"description": "Threshold Number",
"type": "integer"
},
"amount": {
"description": "Amount",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseCompensation"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/course-compensation/{id}": {
"get": {
"tags": [
"CourseCompensation"
],
"summary": "Get Course Compensation information by ID",
"description": "Returns Course Compensation data",
"operationId": "getByCourseCompensationID",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Course Compensation ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseCompensation"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/course-compensation/{unique_id}": {
"put": {
"tags": [
"CourseCompensation"
],
"summary": "Update Course Compensation information",
"description": "Update Course Compensation data",
"operationId": "updateCourseCompensation",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Course Compensation UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "Course Compensation Name",
"type": "string"
},
"unique_id": {
"description": "Course Compensation UniqueID",
"type": "string"
},
"use_enrollment_thresholds": {
"description": "Use Enrollment Thresholds",
"type": "integer"
},
"threshold_number": {
"description": "Threshold Number",
"type": "integer"
},
"amount": {
"description": "Amount",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseCompensation"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"CourseCompensation"
],
"summary": "Delete Course Compensation information",
"description": "Delete Course Compensation data",
"operationId": "destroyCourseCompensation",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Course Compensation UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/course": {
"get": {
"tags": [
"Course"
],
"summary": "Get list of Courses",
"description": "Returns list of Courses",
"operationId": "getCourses",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Course"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Course"
],
"summary": "Add a new Course",
"description": "Add a new Course",
"operationId": "storeCourse",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"unique_id",
"campus_unique_id",
"college_unique_id",
"department_unique_id",
"name",
"number",
"section",
"term_unique_id",
"academic_year",
"start_date",
"end_date"
],
"properties": {
"unique_id": {
"description": "Course Unique Id",
"type": "string"
},
"status": {
"description": "Status of the course: ACCEPTED = 2, CANCELLED = 4, INCOMPLETE = 0",
"type": "integer"
},
"campus_unique_id": {
"description": "Campus Unique Id",
"type": "string"
},
"number": {
"description": "Number",
"type": "string"
},
"college_unique_id": {
"description": "College Unique Id",
"type": "string"
},
"department_unique_id": {
"description": "Department Unique Id",
"type": "string"
},
"name": {
"description": "Name",
"type": "string"
},
"section": {
"description": "Section",
"type": "string"
},
"term_unique_id": {
"description": "Term Unique Id",
"type": "string"
},
"distinction_unique_id": {
"description": "Course Distinction Unique Id",
"type": "string"
},
"course_designations": {
"description": "Course Designation Ids (Ids must be separated by commas and enclosed by brackets: [10,20])",
"type": "string"
},
"compensation_course_unique_id": {
"description": "Course Compensation Unique Id",
"type": "string"
},
"workload_course_unique_id": {
"description": "Workload Enrollment Modifier Unique Id",
"type": "string"
},
"academic_year": {
"description": "Academic",
"type": "string"
},
"compensation": {
"description": "Compensation",
"type": "decimal"
},
"crn": {
"description": "Custom Reference Number",
"type": "string"
},
"delivery_method": {
"description": "DeliveryMethod",
"type": "array",
"items": {
"type": "string"
}
},
"workload_value": {
"description": "Workload Value",
"type": "integer"
},
"enrollment": {
"description": "Enrollment",
"type": "integer"
},
"enrollment_capacity": {
"description": "Enrollment Capacity",
"type": "integer"
},
"location": {
"description": "Location",
"type": "string"
},
"days_times": {
"description": "Days and Times for Course",
"type": "object",
"example": {
"tuesday": {
"start": "11:09pm",
"end": "02:04pm"
},
"monday": {
"start": "03:04pm",
"end": "10:09pm"
}
}
},
"timezone": {
"description": "Time Zone",
"type": "string"
},
"start_date": {
"description": "Start Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date",
"type": "string",
"format": "date"
},
"grading_week": {
"description": "Grading Week",
"type": "number"
},
"student_credits": {
"description": "Student Credit Hour",
"type": "integer"
},
"prep_grading": {
"description": "Prep week workload to be applied. 1 = Yes, 0 = No",
"type": "integer"
},
"prep_grading_start_date": {
"description": "Prep Grading Start Date",
"type": "string",
"format": "date"
},
"prep_grading_end_date": {
"description": "Prep Grading End Date",
"type": "string",
"format": "date"
},
"prep_grading_workload": {
"description": "Prep Grading Workload Value",
"type": "integer"
},
"course_ignore_days_off": {
"description": "Status (Value can be only one of the following: 0,1.)",
"type": "integer"
},
"site_based_learning": {
"description": "Site Based Learning to be applied. 1 = Yes, 0 = No",
"type": "integer"
},
"course_path": {
"description": "Course Path. (Value can be only one of the following: undergraduate, graduate, noncredit, other)",
"type": "string"
},
"course_status": {
"description": "Course status. (Value can be only one of the following: open, closed)",
"type": "string"
},
"course_faculty_auto_staff_code": {
"description": "Course Faculty Auto Staff Code",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Course"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/course/{unique_id}{?show_staffings=1}": {
"get": {
"tags": [
"Course"
],
"summary": "Get Course information by UniqueID",
"description": "Returns Course data",
"operationId": "getCourseByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Course UniqueID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "show_staffings",
"in": "path",
"description": "Include all course staffings in node `staffings`",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "view",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Course"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/course/by-id/{id}": {
"get": {
"tags": [
"Course"
],
"summary": "Get Course information by Id",
"description": "Returns Course data",
"operationId": "getCourseById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Course Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "view",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Course"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Course"
],
"summary": "Delete Course information",
"description": "Delete Course and its related data. Important: The course will not be deleted, and a warning will be sent\n * if the course is part of an Approved Pay Batch!. When a course is deleted the following related\n * items will also be deleted: Staffings, Staffed instructors, Staffed instructor dates, Locked\n * compensations records, pay items, pay batches",
"operationId": "destroyCourseById",
"parameters": [
{
"name": "course_id",
"in": "path",
"description": "Course ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/course/{unique_id}": {
"put": {
"tags": [
"Course"
],
"summary": "Update A Course",
"description": "Update a Course entry.",
"operationId": "updateCourse",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Course UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [],
"properties": {
"campus_unique_id": {
"description": "Campus Unique Id",
"type": "string"
},
"number": {
"description": "Number",
"type": "string"
},
"status": {
"description": "Status of the course: ACCEPTED = 2, CANCELLED = 4, INCOMPLETE = 0",
"type": "integer"
},
"college_unique_id": {
"description": "College Unique Id",
"type": "string"
},
"department_unique_id": {
"description": "Department Unique Id",
"type": "string"
},
"compensation_course_unique_id": {
"description": "Course Compensation Unique Id",
"type": "string"
},
"workload_course_unique_id": {
"description": "Workload Enrollment Modifier Unique Id",
"type": "string"
},
"name": {
"description": "Name",
"type": "string"
},
"section": {
"description": "Section",
"type": "string"
},
"term_unique_id": {
"description": "Term Unique Id",
"type": "string"
},
"distinction_unique_id": {
"description": "Course Distinction Unique Id",
"type": "string"
},
"course_designations": {
"description": "Course Designation Ids (Ids must be separated by commas and enclosed by brackets: [10,20])",
"type": "string"
},
"academic_year": {
"description": "Academic",
"type": "string"
},
"compensation": {
"description": "Compensation",
"type": "decimal"
},
"crn": {
"description": "Custom Reference Number",
"type": "string"
},
"deadline": {
"description": "Deadline",
"type": "string"
},
"delivery_method": {
"description": "DeliveryMethod",
"type": "array",
"items": {
"type": "string"
}
},
"workload_value": {
"description": "Workload Value",
"type": "integer"
},
"enrollment": {
"description": "Enrollment",
"type": "integer"
},
"enrollment_capacity": {
"description": "Enrollment Capacity",
"type": "integer"
},
"location": {
"description": "Location",
"type": "string"
},
"days_times": {
"description": "Days and Times for Course",
"type": "object",
"example": {
"tuesday": {
"start": "11:09pm",
"end": "02:04pm"
},
"monday": {
"start": "03:04pm",
"end": "10:09pm"
}
}
},
"timezone": {
"description": "Time Zone",
"type": "string"
},
"start_date": {
"description": "Start Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date",
"type": "string",
"format": "date"
},
"grading_week": {
"description": "Grading Week",
"type": "number"
},
"student_credits": {
"description": "Student Credit Hour",
"type": "integer"
},
"prep_grading": {
"description": "Prep week workload to be applied. 1 = Yes, 0 = No",
"type": "integer"
},
"prep_grading_start_date": {
"description": "Prep Grading Start Date",
"type": "string",
"format": "date"
},
"prep_grading_end_date": {
"description": "Prep Grading End Date",
"type": "string",
"format": "date"
},
"prep_grading_workload": {
"description": "Prep Grading Workload Value",
"type": "integer"
},
"course_ignore_days_off": {
"description": "Status (Value can be only one of the following: 0,1.)",
"type": "integer"
},
"site_based_learning": {
"description": "Site Based Learning to be applied. 1 = Yes, 0 = No",
"type": "integer"
},
"course_path": {
"description": "Course Path. (Value can be only one of the following: undergraduate, graduate, noncredit, other.)",
"type": "string"
},
"course_status": {
"description": "Course status. (Value can be only one of the following: open, closed)",
"type": "string"
},
"course_faculty_auto_staff_code": {
"description": "Course Faculty Auto Staff Code",
"type": "string"
},
"description": {
"description": "Course Description",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Course"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Course"
],
"summary": "Delete Course information",
"description": "Delete Course and its related data. Important: The course will not be deleted, and a warning will be sent\n * if the course is part of an Approved Pay Batch!. When a course is deleted the following related\n * items will also be deleted: Staffings, Staffed instructors, Staffed instructor dates, Locked\n * compensations records, pay items, pay batches",
"operationId": "destroyCourse",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Course UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/course-outcome": {
"get": {
"tags": [
"CourseOutcome"
],
"summary": "Get list of CourseOutcomes",
"description": "Returns list of CourseOutcomes",
"operationId": "getCourseOutcome",
"responses": {
"200": {
"description": "Index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseOutcome"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"CourseOutcome"
],
"summary": "Add a new CourseOutcome",
"description": "Add a new CourseOutcome",
"operationId": "storeCourseOutcome",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"course_unique_id"
],
"properties": {
"course_unique_id": {
"description": "Course UniqueID",
"type": "string"
},
"average_attendance": {
"description": "Average Attendance",
"type": "number",
"format": "float"
},
"engagement_score": {
"description": "Engagement Score",
"type": "number",
"format": "float"
},
"average_interactions": {
"description": "Average Interactions",
"type": "number",
"format": "float"
},
"a": {
"description": "A",
"type": "number",
"format": "float"
},
"b": {
"description": "B",
"type": "number",
"format": "float"
},
"c": {
"description": "C",
"type": "number",
"format": "float"
},
"d": {
"description": "D",
"type": "number",
"format": "float"
},
"f": {
"description": "F",
"type": "number",
"format": "float"
},
"s": {
"description": "S",
"type": "number",
"format": "float"
},
"u": {
"description": "U",
"type": "number",
"format": "float"
},
"w": {
"description": "W",
"type": "number",
"format": "float"
},
"wf": {
"description": "WF",
"type": "number",
"format": "float"
},
"i": {
"description": "I",
"type": "number",
"format": "float"
},
"gpa": {
"description": "GPA",
"type": "number",
"format": "float"
},
"mean": {
"description": "Mean",
"type": "number",
"format": "float"
},
"faculty_unique_id_or_faculty_email": {
"description": "Faculty UniqueId Or Faculty Email",
"type": "string"
},
"student_eval_score": {
"description": "Student Eval Score",
"type": "number",
"format": "float"
},
"course_score": {
"description": "Course Score",
"type": "number",
"format": "float"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseOutcome"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/course-outcome/getByCourseUniqueId/{course_unique_id}": {
"get": {
"tags": [
"CourseOutcome"
],
"summary": "Get list of Course Outcome By Course UniqueID",
"description": "Returns list of Course Texts",
"operationId": "getCourseOutcomeByCourseUniqueId",
"parameters": [
{
"name": "course_unique_id",
"in": "path",
"description": "Course UniqueId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseOutcome"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/course-outcome/{id}": {
"get": {
"tags": [
"CourseOutcome"
],
"summary": "Get CourseOutcome information by UniqueID",
"description": "Returns CourseOutcome data",
"operationId": "getByCourseOutcomeId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "CourseOutcome UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Show",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseOutcome"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"CourseOutcome"
],
"summary": "Update CourseOutcome information",
"description": "Update CourseOutcome data",
"operationId": "updateCourseOutcome",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Course Outcome ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"course_unique_id"
],
"properties": {
"course_unique_id": {
"description": "Course UniqueID",
"type": "string"
},
"average_attendance": {
"description": "Average Attendance",
"type": "number",
"format": "float"
},
"engagement_score": {
"description": "Engagement Score",
"type": "number",
"format": "float"
},
"average_interactions": {
"description": "Average Interactions",
"type": "number",
"format": "float"
},
"a": {
"description": "A",
"type": "number",
"format": "float"
},
"b": {
"description": "B",
"type": "number",
"format": "float"
},
"c": {
"description": "C",
"type": "number",
"format": "float"
},
"d": {
"description": "D",
"type": "number",
"format": "float"
},
"f": {
"description": "F",
"type": "number",
"format": "float"
},
"s": {
"description": "S",
"type": "number",
"format": "float"
},
"u": {
"description": "U",
"type": "number",
"format": "float"
},
"w": {
"description": "W",
"type": "number",
"format": "float"
},
"wf": {
"description": "WF",
"type": "number",
"format": "float"
},
"i": {
"description": "I",
"type": "number",
"format": "float"
},
"gpa": {
"description": "GPA",
"type": "number",
"format": "float"
},
"mean": {
"description": "Provider",
"type": "number",
"format": "float"
},
"faculty_unique_id_or_faculty_email": {
"description": "Faculty UniqueId Or Faculty Email",
"type": "string"
},
"student_eval_score": {
"description": "Student Eval Score",
"type": "number",
"format": "float"
},
"course_score": {
"description": "Course Score",
"type": "number",
"format": "float"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseOutcome"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"CourseOutcome"
],
"summary": "Delete CourseOutcome information",
"description": "Delete CourseOutcome data",
"operationId": "destroyCourseOutcome",
"parameters": [
{
"name": "id",
"in": "path",
"description": "CourseOutcome id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/course-reflection": {
"get": {
"tags": [
"CourseReflection"
],
"summary": "Get list of Course Reflection",
"description": "Returns list of Course Reflection",
"operationId": "GetCourseReflection",
"responses": {
"200": {
"description": "Index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseReflection"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"CourseReflection"
],
"summary": "Add a Course Reflection",
"description": "Add a Course Reflection",
"operationId": "storeCourseReflection",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"course_unique_id",
"faculty_unique_id"
],
"properties": {
"course_unique_id": {
"description": "Course UniqueId",
"type": "string"
},
"faculty_unique_id": {
"description": "Faculty UniqueId",
"type": "string"
},
"type": {
"description": "Type (Values for Type can be only one of the following: Pedagogy/Andragogy, Course Content, Experiential/Application, Student Evaluations Other, General Reflections, Teaching Effectiveness, Innovations And Advising, Teaching And Mentoring, Pedagogical Innovation.",
"type": "string"
},
"title": {
"description": "Title",
"type": "string"
},
"reflection": {
"description": "Reflection",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseReflection"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/course-reflection/{id}": {
"get": {
"tags": [
"CourseReflection"
],
"summary": "Get Course Reflection information by ID",
"description": "Returns Course Reflection data",
"operationId": "getByCourseReflectionId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Course Reflection ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseReflection"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"CourseReflection"
],
"summary": "Update Course Reflection information",
"description": "Update Course Reflection data",
"operationId": "updateCourseReflection",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Course Reflection UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"course_unique_id",
"faculty_unique_id"
],
"properties": {
"course_unique_id": {
"description": "Course UniqueId",
"type": "string"
},
"faculty_unique_id": {
"description": "Faculty UniqueId",
"type": "string"
},
"type": {
"description": "Type (Values for Type can be only one of the following: Pedagogy/Andragogy, Course Content, Experiential/Application, Student Evaluations Other, General Reflections, Teaching Effectiveness, Innovations And Advising, Teaching And Mentoring, Pedagogical Innovation.",
"type": "string"
},
"title": {
"description": "Title",
"type": "string"
},
"reflection": {
"description": "Reflection",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseReflection"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"CourseReflection"
],
"summary": "Delete Course Reflection information",
"description": "Delete Course Reflection data",
"operationId": "destroyCourseReflection",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Course Reflection ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/course-text": {
"get": {
"tags": [
"CourseText"
],
"summary": "Get list of Course Texts",
"description": "Returns list of Course Texts",
"operationId": "getCourseTexts",
"responses": {
"200": {
"description": "Index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseText"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"CourseText"
],
"summary": "Add a new Course Text",
"description": "Add a new Course Text",
"operationId": "storeCourseText",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"course_unique_id",
"name",
"edition",
"author",
"publisher",
"text_type",
"text_status",
"desk_copy_needed",
"reason"
],
"properties": {
"course_unique_id": {
"description": "Course UniqueID",
"type": "string"
},
"name": {
"description": "Name",
"type": "string"
},
"isbn": {
"description": "ISBN",
"type": "string"
},
"edition": {
"description": "Edition",
"type": "string"
},
"author": {
"description": "Author",
"type": "string"
},
"publisher": {
"description": "Publisher",
"type": "string"
},
"publisher_email": {
"description": "Publisher Email",
"type": "string"
},
"text_type": {
"description": "Text Type (Values for Text Type can be only one of the following: Digital, Physical, Supplies, Supplemental, Other.)",
"type": "string"
},
"text_status": {
"description": "Text Status",
"type": "string"
},
"desk_copy_needed": {
"description": "Desk Copy Needed? (Values for Desk Copy Needed can be only one of the following: Yes, No, N/A.)",
"type": "string"
},
"reason": {
"description": "Reason (Values for Reason can be only one of the following: New Edition/Text, New Staffing, Other.)",
"type": "string"
},
"reason_other": {
"description": "Another Reason",
"type": "string"
},
"ebook_isbn": {
"description": "Ebook ISBN",
"type": "string"
},
"comments": {
"description": "Comment",
"type": "string"
},
"academic_year": {
"description": "Academic Year",
"type": "string"
},
"course_number": {
"description": "Course Number",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseText"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/course-text/getByCourseUniqueId/{course_unique_id}": {
"get": {
"tags": [
"CourseText"
],
"summary": "Get list of Course Text By Course UniqueID",
"description": "Returns list of Course Texts",
"operationId": "getByCourseUniqueId",
"parameters": [
{
"name": "course_unique_id",
"in": "path",
"description": "Course UniqueId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseText"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/course-text/{id}": {
"get": {
"tags": [
"CourseText"
],
"summary": "Get Course Text information by Id",
"description": "Returns Course Text",
"operationId": "getByCourseTextId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Course Text Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseText"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"CourseText"
],
"summary": "Update a Course Text",
"description": "Update a Course Text",
"operationId": "updateCourseText",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Course Text Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"course_unique_id",
"name",
"edition",
"author",
"publisher",
"text_type",
"text_status",
"desk_copy_needed",
"reason"
],
"properties": {
"course_unique_id": {
"description": "Course UniqueID",
"type": "string"
},
"name": {
"description": "Name",
"type": "string"
},
"isbn": {
"description": "ISBN",
"type": "string"
},
"edition": {
"description": "Edition",
"type": "string"
},
"author": {
"description": "Author",
"type": "string"
},
"publisher": {
"description": "Publisher",
"type": "string"
},
"publisher_email": {
"description": "Publisher Email",
"type": "string"
},
"text_type": {
"description": "Text Type (Values for Text Type can be only one of the following: Digital, Physical, Supplies, Supplemental, Other.)",
"type": "string"
},
"text_status": {
"description": "Text Status",
"type": "string"
},
"desk_copy_needed": {
"description": "Desk Copy Needed? (Values for Desk Copy Needed can be only one of the following: Yes, No, N/A.)",
"type": "string"
},
"reason": {
"description": "Reason (Values for Reason can be only one of the following: New Edition/Text, New Staffing, Other.)",
"type": "string"
},
"reason_other": {
"description": "Another Reason",
"type": "string"
},
"ebook_isbn": {
"description": "Ebook ISBN",
"type": "string"
},
"comments": {
"description": "Comment",
"type": "string"
},
"academic_year": {
"description": "Academic Year",
"type": "string"
},
"course_number": {
"description": "Course Number",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseText"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"CourseText"
],
"summary": "Delete Course Text information",
"description": "Delete Course Text data",
"operationId": "destroyCourseText",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Course Text id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/credential": {
"get": {
"tags": [
"Credential"
],
"summary": "Get list of All Credentials",
"description": "Returns list of All Credentials",
"operationId": "getAllCredentials",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Credential"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/faculty/{faculty_id}/credential": {
"get": {
"tags": [
"Credential"
],
"summary": "Get list of Credentials",
"description": "Returns list of Credentials of a Faculty",
"operationId": "getCredentials",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Credential"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Credential"
],
"summary": "Add a new Credential to a Faculty",
"description": "Add a new Credential to a Faculty",
"operationId": "storeCredential",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"faculty_unique_id",
"faculty_id",
"title"
],
"properties": {
"faculty_unique_id": {
"description": "Faculty UniqueID - required without Faculty ID",
"type": "string"
},
"faculty_id": {
"description": "Faculty ID - required without Faculty UniqueID",
"type": "string"
},
"degree": {
"description": "Degree Name",
"type": "string"
},
"major": {
"description": "Major",
"type": "string"
},
"institution": {
"description": "Granting Institution",
"type": "string"
},
"address": {
"description": "Address",
"type": "string"
},
"terminal": {
"description": "Terminal",
"type": "string"
},
"date_conferred": {
"description": "Date Conferred",
"type": "string",
"format": "date"
},
"title": {
"description": "Title",
"type": "string"
},
"highest_degree_earned": {
"description": "Highest Degree Earned",
"type": "string"
},
"qualifying_credential": {
"description": "Qualifying credential",
"type": "integer"
}
},
"type": "object",
"example": {
"faculty_id": "10854",
"title": "The Title of 123"
}
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty/by-unique-id/{faculty_unique_id}/credential": {
"get": {
"tags": [
"Credential"
],
"summary": "Get list of Credentials of a Faculty identified by the Faculty's UniqueID",
"description": "Returns list of Credentials",
"operationId": "getCredentialsByFacultyUniqueID",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Credential"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Credential"
],
"summary": "Add a new Credential to a Faculty identified by UniqueID",
"description": "Add a new Credential to a Faculty identified by UniqueID",
"operationId": "storeCredentialByFacultyUniqueID",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"faculty_unique_id",
"faculty_id",
"title"
],
"properties": {
"faculty_unique_id": {
"description": "Faculty UniqueID - required without Faculty ID",
"type": "string"
},
"faculty_id": {
"description": "Faculty ID - required without Faculty UniqueID",
"type": "string"
},
"degree": {
"description": "Degree Name",
"type": "string"
},
"major": {
"description": "Major",
"type": "string"
},
"institution": {
"description": "Granting Institution",
"type": "string"
},
"address": {
"description": "Address",
"type": "string"
},
"terminal": {
"description": "Terminal",
"type": "string"
},
"date_conferred": {
"description": "Date Conferred",
"type": "string",
"format": "date"
},
"title": {
"description": "Title",
"type": "string"
},
"highest_degree_earned": {
"description": "Highest Degree Earned",
"type": "string"
},
"qualifying_credential": {
"description": "Qualifying credential",
"type": "integer"
}
},
"type": "object",
"example": {
"faculty_id": "10854",
"title": "The Title of 123"
}
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty/by-unique-id/{faculty_unique_id}/credential/{id}": {
"get": {
"tags": [
"Credential"
],
"summary": "Get list of Credential By Faculty UniqueID",
"description": "Returns list of Credentials for a Faculty based on the Faculty UniqueID",
"operationId": "getByFacultyUniqueId",
"parameters": [
{
"name": "faculty_unique_id",
"in": "path",
"description": "Faculty UniqueId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"description": "Credential Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Credential"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Credential"
],
"summary": "Update A Credential",
"description": "Update a Credential entry.",
"operationId": "updateCredentialByFacultyUniqueId",
"parameters": [
{
"name": "faculty_id",
"in": "path",
"description": "Faculty Unique ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "id",
"in": "path",
"description": "Credential ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"faculty_unique_id",
"faculty_id",
"title"
],
"properties": {
"faculty_unique_id": {
"description": "Faculty UniqueID - required without Faculty ID",
"type": "string"
},
"faculty_id": {
"description": "Faculty ID - required without Faculty UniqueID",
"type": "string"
},
"degree": {
"description": "Degree Name",
"type": "string"
},
"major": {
"description": "Major",
"type": "string"
},
"institution": {
"description": "Granting Institution",
"type": "string"
},
"address": {
"description": "Address",
"type": "string"
},
"terminal": {
"description": "Terminal",
"type": "string"
},
"date_conferred": {
"description": "Date Conferred",
"type": "string",
"format": "date"
},
"title": {
"description": "Title",
"type": "string"
},
"highest_degree_earned": {
"description": "Highest Degree Earned",
"type": "string"
},
"qualifying_credential": {
"description": "Qualifying credential",
"type": "integer"
}
},
"type": "object",
"example": {
"faculty_id": "10854",
"title": "The Title of 123"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Credential"
],
"summary": "Delete Credential information By Faculty UniqueId and Credential ID",
"description": "Delete Credential data",
"operationId": "destroyCredentialByFacultyUniqueID",
"parameters": [
{
"name": "faculty_unique_id",
"in": "path",
"description": "Faculty UniqueID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "id",
"in": "path",
"description": "Credential ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty/{faculty_id}/credential/{id}": {
"get": {
"tags": [
"Credential"
],
"summary": "Get Faculty Credential information by ID",
"description": "Returns Credential data",
"operationId": "getFacultyCredentialById",
"parameters": [
{
"name": "faculty_id",
"in": "path",
"description": "Faculty Unique ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "id",
"in": "path",
"description": "Credential ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Credential"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Credential"
],
"summary": "Update A Credential",
"description": "Update a Credential of a Faculty entry.",
"operationId": "updateCredential",
"parameters": [
{
"name": "faculty_id",
"in": "path",
"description": "Faculty ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "id",
"in": "path",
"description": "Credential ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"faculty_unique_id",
"faculty_id",
"title"
],
"properties": {
"faculty_unique_id": {
"description": "Faculty UniqueID - required without Faculty ID",
"type": "string"
},
"faculty_id": {
"description": "Faculty ID - required without Faculty UniqueID",
"type": "string"
},
"degree": {
"description": "Degree Name",
"type": "string"
},
"major": {
"description": "Major",
"type": "string"
},
"institution": {
"description": "Granting Institution",
"type": "string"
},
"address": {
"description": "Address",
"type": "string"
},
"terminal": {
"description": "Terminal",
"type": "string"
},
"date_conferred": {
"description": "Date Conferred",
"type": "string",
"format": "date"
},
"title": {
"description": "Title",
"type": "string"
},
"highest_degree_earned": {
"description": "Highest Degree Earned",
"type": "string"
},
"qualifying_credential": {
"description": "Qualifying credential",
"type": "integer"
}
},
"type": "object",
"example": {
"faculty_id": "10854",
"title": "The Title of 123"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Credential"
],
"summary": "Delete Credential information",
"description": "Delete Credential data",
"operationId": "destroyCredential",
"parameters": [
{
"name": "faculty_id",
"in": "path",
"description": "The Faculty ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "id",
"in": "path",
"description": "Credential ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/days-off": {
"get": {
"tags": [
"DaysOff"
],
"summary": "Get list of Days Off",
"description": "Returns list of Days Off",
"operationId": "getDaysOff",
"responses": {
"200": {
"description": "Index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DaysOff"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"DaysOff"
],
"summary": "Add a Day Off",
"description": "Add a Day Off",
"operationId": "storeDaysOff",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"day_off"
],
"properties": {
"day_off": {
"description": "Day Off",
"type": "string",
"format": "date"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DaysOff"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/days-off/{id}": {
"get": {
"tags": [
"DaysOff"
],
"summary": "Get Day Off information by id",
"description": "Returns Day Off data",
"operationId": "getByDaysOffId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Day Off Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Show",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DaysOff"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"DaysOff"
],
"summary": "Update Day Off information",
"description": "Update Day Off data",
"operationId": "updateDaysOff",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Day Off id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"day_off"
],
"properties": {
"day_off": {
"description": "day Off",
"type": "string",
"format": "date"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DaysOff"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"DaysOff"
],
"summary": "Delete Day Off information",
"description": "Delete Day Off data",
"operationId": "destroyDaysOff",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Day Off Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/department": {
"get": {
"tags": [
"Department"
],
"summary": "Get list of Departments",
"description": "Returns list of Departments",
"operationId": "getDepartment",
"responses": {
"200": {
"description": "Index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Department"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Department"
],
"summary": "Add a new Department",
"description": "Add a new Department",
"operationId": "storeDepartment",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"unique_id"
],
"properties": {
"name": {
"description": "Department Name",
"type": "string"
},
"unique_id": {
"description": "Department UniqueID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Department"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/department/{unique_id}": {
"get": {
"tags": [
"Department"
],
"summary": "Get Department information by UniqueID",
"description": "Returns Department data",
"operationId": "getByDepartmentUniqueID",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Department UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Department"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Department"
],
"summary": "Update A Department",
"description": "Update a Department entry.",
"operationId": "updateDepartment",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Department UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name"
],
"properties": {
"unique_id": {
"description": "Department UniqueID",
"type": "integer"
},
"name": {
"description": "Department Name",
"type": "string"
},
"department_unique_id": {
"description": "Department UniqueID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Department"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Department"
],
"summary": "Delete A Department",
"description": "Delete a Department entry.",
"operationId": "destroyDepartment",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Department UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/employment": {
"get": {
"tags": [
"Employment"
],
"summary": "Get list of Employment",
"description": "Returns list of Employment",
"operationId": "getEmployment",
"responses": {
"200": {
"description": "Index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Employment"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Employment"
],
"summary": "Add a new Employment",
"description": "Add a new Employment",
"operationId": "storeEmployment",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"title",
"experience_type",
"faculty_unique_id"
],
"properties": {
"title": {
"description": "Employment Title",
"type": "string"
},
"faculty_unique_id": {
"description": "Faculty UniqueID",
"type": "string"
},
"experience_type": {
"description": "Experience Type (Values of Experience Type should be 1 to 6) ",
"type": "integer"
},
"description": {
"description": "Description",
"type": "string"
},
"start_date": {
"description": "Start Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date",
"type": "string",
"format": "date"
},
"org": {
"description": "Organization",
"type": "string"
},
"qualifying_experience": {
"description": "Qualifying experience",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Employment"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/employment/getByFacultyUniqueId/{faculty_unique_id}": {
"get": {
"tags": [
"Employment"
],
"summary": "Get list of Employment History By Faculty Member's UniqueID",
"description": "Returns list of Employment History",
"operationId": "getEmploymentByFacultyUniqueId",
"parameters": [
{
"name": "faculty_unique_id",
"in": "path",
"description": "Faculty UniqueId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Employment"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/employment/{id}": {
"get": {
"tags": [
"Employment"
],
"summary": "Get Employment information by Id",
"description": "Returns Employment data",
"operationId": "getByEmploymentId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Employment id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Employment"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Employment"
],
"summary": "Update A Employment",
"description": "Update a Employment entry.",
"operationId": "updateEmployment",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Employment Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"title",
"experience_type",
"faculty_unique_id"
],
"properties": {
"title": {
"description": "Employment Title",
"type": "string"
},
"faculty_unique_id": {
"description": "Faculty UniqueID",
"type": "string"
},
"experience_type": {
"description": "Experience Type (Values of Experience Type should be 1 to 6) ",
"type": "integer"
},
"description": {
"description": "Description",
"type": "string"
},
"start_date": {
"description": "Start Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date",
"type": "string",
"format": "date"
},
"organization": {
"description": "Organization",
"type": "string",
"format": "date"
},
"qualifying_experience": {
"description": "Qualifying experience",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Employment"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Employment"
],
"summary": "Delete A Employment",
"description": "Delete a Employment entry.",
"operationId": "destroyEmployment",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Employment Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty-base-rate/{unique_id}": {
"get": {
"tags": [
"FacultyBaseRate"
],
"summary": "Get list of Faculty Base Rate ",
"description": "Returns Faculty Base Rate at the time of the query.",
"operationId": "getFacultyBaseRate",
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/faculty-compensation": {
"get": {
"tags": [
"FacultyCompensation"
],
"summary": "Get list of FacultyCompensations",
"description": "Returns a list of FacultyCompensations",
"operationId": "getFacultyCompensations",
"responses": {
"200": {
"description": "index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacultyCompensation"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"FacultyCompensation"
],
"summary": "Add a new FacultyCompensation",
"description": "Add a new FacultyCompensation",
"operationId": "storeFacultyCompensation",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name",
"rank",
"track",
"load",
"college_id",
"campus_id",
"dept_id",
"faculty_distinction_id"
],
"properties": {
"university_id": {
"description": "University Id",
"type": "integer"
},
"name": {
"description": "FacultyCompensation Name",
"type": "string"
},
"unique_id": {
"description": "FacultyCompensation UniqueId",
"type": "string"
},
"compensation_type_id": {
"description": "FacultyCompensationType Id",
"type": "integer"
},
"compensation_sub_type_id": {
"description": "FacultyCompensation SubType Id",
"type": "integer"
},
"base_rate": {
"description": "BaseRate",
"type": "string"
},
"rank": {
"description": "Rank Id",
"type": "integer"
},
"rank_modifier": {
"description": "Rank Modifier",
"type": "integer"
},
"rank_amount": {
"description": "Rank Amount",
"type": "string"
},
"track": {
"description": "Track Id",
"type": "integer"
},
"track_modifier": {
"description": "Track Modifier",
"type": "integer"
},
"track_amount": {
"description": "Track Amount",
"type": "string"
},
"load_status": {
"description": "Load Status",
"type": "integer"
},
"load_status_modifier": {
"description": "Load Status Modifier",
"type": "integer"
},
"load_status_amount": {
"description": "Load Status Amount",
"type": "string"
},
"campus_id": {
"description": "Campus Id",
"type": "integer"
},
"campus_modifier": {
"description": "Campus Modifier",
"type": "integer"
},
"campus_amount": {
"description": "Campus Amount",
"type": "string"
},
"college_id": {
"description": "College Id",
"type": "integer"
},
"college_modifier": {
"description": "College Modifier",
"type": "integer"
},
"college_amount": {
"description": "College Amount",
"type": "string"
},
"dept_id": {
"description": "Dept Id",
"type": "integer"
},
"dept_modifier": {
"description": "Dept Modifier",
"type": "integer"
},
"dept_amount": {
"description": "Dept Amount",
"type": "string"
},
"terminal_degree": {
"description": "Terminal Degree",
"type": "integer"
},
"terminal_degree_modifier": {
"description": "Terminal Degree Modifier",
"type": "integer"
},
"terminal_degree_amount": {
"description": "Terminal Degree Amount",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"state_modifier": {
"description": "State Modifier",
"type": "integer"
},
"state_amount": {
"description": "State Amount",
"type": "string"
},
"faculty_distinction": {
"description": "Faculty Distinction",
"type": "integer"
},
"faculty_distinction_modifier": {
"description": "Faculty Distinction Modifier",
"type": "integer"
},
"faculty_distinction_amount": {
"description": "Faculty Distinction Amount",
"type": "string"
},
"highest_degree_earned": {
"description": "Highest Degree Earned",
"type": "integer"
},
"highest_degree_earned_modifier": {
"description": "Highest Degree Earned Modifier",
"type": "integer"
},
"highest_degree_earned_amount": {
"description": "Highest Degree Earned Amount",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Campus"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty-compensation/{unique_id}": {
"get": {
"tags": [
"FacltyCompensation"
],
"summary": "Get FacltyCompensation information by UniqueID",
"description": "Returns FacltyCompensation data",
"operationId": "showFacltyCompensation",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "FacltyCompensation UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Campus"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"FacultyCompensation"
],
"summary": "Update FacultyCompensation information",
"description": "Update FacultyCompensation data",
"operationId": "updateFacultyCompensation",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "FacultyCompensation UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"rank",
"track",
"load",
"college_id",
"campus_id",
"dept_id",
"faculty_distinction_id"
],
"properties": {
"university_id": {
"description": "University Id",
"type": "integer"
},
"name": {
"description": "FacultyCompensation Name",
"type": "string"
},
"unique_id": {
"description": "FacultyCompensation UniqueId",
"type": "string"
},
"compensation_type_id": {
"description": "FacultyCompensationType Id",
"type": "integer"
},
"compensation_sub_type_id": {
"description": "FacultyCompensation SubType Id",
"type": "integer"
},
"base_rate": {
"description": "BaseRate",
"type": "string"
},
"rank": {
"description": "Rank Id",
"type": "integer"
},
"rank_modifier": {
"description": "Rank Modifier",
"type": "integer"
},
"rank_amount": {
"description": "Rank Amount",
"type": "string"
},
"track": {
"description": "Track Id",
"type": "integer"
},
"track_modifier": {
"description": "Track Modifier",
"type": "integer"
},
"track_amount": {
"description": "Track Amount",
"type": "string"
},
"load_status": {
"description": "Load Status",
"type": "integer"
},
"load_status_modifier": {
"description": "Load Status Modifier",
"type": "integer"
},
"load_status_amount": {
"description": "Load Status Amount",
"type": "string"
},
"campus_id": {
"description": "Campus Id",
"type": "integer"
},
"campus_modifier": {
"description": "Campus Modifier",
"type": "integer"
},
"campus_amount": {
"description": "Campus Amount",
"type": "string"
},
"college_id": {
"description": "College Id",
"type": "integer"
},
"college_modifier": {
"description": "College Modifier",
"type": "integer"
},
"college_amount": {
"description": "College Amount",
"type": "string"
},
"dept_id": {
"description": "Dept Id",
"type": "integer"
},
"dept_modifier": {
"description": "Dept Modifier",
"type": "integer"
},
"dept_amount": {
"description": "Dept Amount",
"type": "string"
},
"terminal_degree": {
"description": "Terminal Degree",
"type": "integer"
},
"terminal_degree_modifier": {
"description": "Terminal Degree Modifier",
"type": "integer"
},
"terminal_degree_amount": {
"description": "Terminal Degree Amount",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"state_modifier": {
"description": "State Modifier",
"type": "integer"
},
"state_amount": {
"description": "State Amount",
"type": "string"
},
"faculty_distinction": {
"description": "Faculty Distinction",
"type": "integer"
},
"faculty_distinction_modifier": {
"description": "Faculty Distinction Modifier",
"type": "integer"
},
"faculty_distinction_amount": {
"description": "Faculty Distinction Amount",
"type": "string"
},
"highest_degree_earned": {
"description": "Highest Degree Earned",
"type": "integer"
},
"highest_degree_earned_modifier": {
"description": "Highest Degree Earned Modifier",
"type": "integer"
},
"highest_degree_earned_amount": {
"description": "Highest Degree Earned Amount",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacultyCompensation"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"FacultyCompensation"
],
"summary": "Delete FacultyCompensation information",
"description": "Delete FacultyCompensation data",
"operationId": "destroyFacultyCompensation",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "FacultyCompensation UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty": {
"get": {
"tags": [
"Faculty"
],
"summary": "Get list of Faculty",
"description": "Returns list of Faculty.",
"operationId": "getFaculty",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Faculty"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Faculty"
],
"summary": "Add a new Faculty",
"description": "Add a new Faculty",
"operationId": "store",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"campus_unique_id",
"college_unique_id",
"department_unique_id",
"firstname",
"lastname",
"email"
],
"properties": {
"unique_id": {
"description": "Unique Id for the Faculty",
"type": "string"
},
"campus_unique_id": {
"description": "Primary Campus",
"type": "string"
},
"college_unique_id": {
"description": "Primary College",
"type": "string"
},
"department_unique_id": {
"description": "Primary Department",
"type": "string"
},
"faculty_code": {
"description": "Faculty Code",
"type": "string"
},
"other_code": {
"description": "Other Code",
"type": "string"
},
"faculty_identifier": {
"description": "Faculty Identifier",
"type": "string"
},
"firstname": {
"description": "First Name",
"type": "string"
},
"middlename": {
"description": "Middle Name",
"type": "string"
},
"lastname": {
"description": "Last Name",
"type": "string"
},
"email": {
"description": "Email",
"type": "string"
},
"office_address": {
"description": "Office Address",
"type": "string"
},
"office_city": {
"description": "Office City",
"type": "string"
},
"office_state": {
"description": "Office State",
"type": "string"
},
"office_zip": {
"description": "Office Zip",
"type": "string"
},
"phone": {
"description": "Primary Phone",
"type": "string"
},
"office_country": {
"description": "Office Country",
"type": "string"
},
"home_address": {
"description": "Home Address",
"type": "string"
},
"home_city": {
"description": "Home City",
"type": "string"
},
"home_state": {
"description": "Home State",
"type": "string"
},
"home_zip": {
"description": "Home Zip",
"type": "string"
},
"home_country": {
"description": "Home Country",
"type": "string"
},
"secondary_email": {
"description": "Secondary Email",
"type": "string"
},
"mobilephone": {
"description": "Mobile Phone",
"type": "string"
},
"homephone": {
"description": "Home Phone",
"type": "string"
},
"date_transcript_verified": {
"description": "Date Transcript Verified",
"type": "string",
"format": "date"
},
"start_date": {
"description": "Start Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date",
"type": "string",
"format": "date"
},
"tenure_status": {
"description": "Tenure Status",
"type": "string"
},
"tenure_date": {
"description": "Tenure Date",
"type": "string",
"format": "date"
},
"cip_code": {
"description": "CIP Code",
"type": "number",
"format": "float"
},
"race_id": {
"description": "Race Id",
"type": "integer"
},
"ethnicity_id": {
"description": "Ethnicity",
"type": "integer"
},
"diversity": {
"description": "Diversity 0 = no answer, 1 = Diverse, 2 = Not-Diverse",
"type": "string"
},
"gender_id": {
"description": "Gender",
"type": "integer"
},
"professional_certs_earned": {
"description": "Professional Certs Earned",
"type": "string"
},
"dob": {
"description": "Date Of Birth",
"type": "string",
"format": "date"
},
"us_citizen": {
"description": "Credentail 2 Institution",
"type": "integer"
},
"languages": {
"description": "Language",
"type": "string"
},
"prefix": {
"description": "Prefix",
"type": "string"
},
"suffix": {
"description": "Suffix",
"type": "string"
},
"supervisor_unique_id": {
"description": "Supervisor Unique Id",
"type": "string"
},
"other_email": {
"description": "other_email",
"type": "string"
},
"historical_credits": {
"description": "Faculty Historical Credits",
"type": "number"
},
"payroll_id": {
"description": "Payroll ID",
"type": "string"
},
"faculty_role": {
"description": "Faculty role [0=Faculty Only|1=SBL Only|2=Both]",
"type": "integer"
},
"sbl_organizations": {
"description": "Site Based Learning Organizations ex. `[1,34,67]`",
"type": "object",
"example": "[\n * 1,43,65\n * ]"
},
"employee_id": {
"description": "Employee ID",
"type": "string"
},
"do_not_staff": {
"description": "Is faculty restricted from being staffed? Default 0 = no, Set to 1 for yes",
"type": "integer"
},
"fte_value": {
"description": "Tracking FTE Data",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Faculty"
}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects",
"write:projects"
]
}
]
}
},
"/v1/faculty/unique_id/{unique_id}": {
"get": {
"tags": [
"Faculty"
],
"summary": "Get Faculty information by UniqueID",
"description": "Returns Faculty data",
"operationId": "showFacultyByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Faculty UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Faculty"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Faculty"
],
"summary": "Update A Faculty",
"description": "Update a Faculty entry.",
"operationId": "updateByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Faculty UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"campus_unique_id",
"college_unique_id",
"department_unique_id",
"firstname",
"lastname",
"email"
],
"properties": {
"campus_unique_id": {
"description": "Primary Campus",
"type": "string"
},
"college_unique_id": {
"description": "Primary College",
"type": "string"
},
"department_unique_id": {
"description": "Primary Department",
"type": "string"
},
"faculty_code": {
"description": "Faculty Code",
"type": "string"
},
"other_code": {
"description": "Other Code",
"type": "string"
},
"faculty_identifier": {
"description": "Faculty Identifier",
"type": "string"
},
"firstname": {
"description": "First Name",
"type": "string"
},
"middlename": {
"description": "Middle Name",
"type": "string"
},
"lastname": {
"description": "Last Name",
"type": "string"
},
"email": {
"description": "Email",
"type": "string"
},
"office_address": {
"description": "Office Address",
"type": "string"
},
"office_city": {
"description": "Office City",
"type": "string"
},
"office_state": {
"description": "Office State",
"type": "string"
},
"office_zip": {
"description": "Office Zip",
"type": "string"
},
"phone": {
"description": "Primary Phone",
"type": "string"
},
"office_country": {
"description": "Office Country",
"type": "string"
},
"home_address": {
"description": "Home Address",
"type": "string"
},
"home_city": {
"description": "Home City",
"type": "string"
},
"home_state": {
"description": "Home State",
"type": "string"
},
"home_zip": {
"description": "Home Zip",
"type": "string"
},
"home_country": {
"description": "Home Country",
"type": "string"
},
"email2": {
"description": "Secondary Email",
"type": "string"
},
"mobilephone": {
"description": "Mobile Phone",
"type": "string"
},
"homephone": {
"description": "Home Phone",
"type": "string"
},
"date_transcript_verified": {
"description": "Date Transcript Verified",
"type": "string",
"format": "date"
},
"start_date": {
"description": "Start Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date",
"type": "string",
"format": "date"
},
"tenure_status": {
"description": "Tenure Status",
"type": "string"
},
"tenure_date": {
"description": "Tenure Date",
"type": "string",
"format": "date"
},
"cip_code": {
"description": "CIP Code",
"type": "number",
"format": "float"
},
"race": {
"description": "Race",
"type": "string"
},
"ethnicity_id": {
"description": "Ethnicity",
"type": "integer"
},
"diversity": {
"description": "Diversity 0 = no answer, 1 = Diverse, 2 = Not-Diverse",
"type": "integer"
},
"gender_id": {
"description": "Gender",
"type": "integer"
},
"professional_certs_earned": {
"description": "Professional Certs Earned",
"type": "string"
},
"credentail_2_degree": {
"description": "Credentail 2 Degree",
"type": "string"
},
"date_of_birth": {
"description": "Date Of Birth",
"type": "string",
"format": "date"
},
"us_citizen": {
"description": "Credentail 2 Institution",
"type": "boolean"
},
"languages": {
"description": "Languages known",
"type": "string"
},
"prefix": {
"description": "Prefix",
"type": "string"
},
"suffix": {
"description": "Suffix",
"type": "string"
},
"supervisor_unique_id": {
"description": "Supervisor Unique Id",
"type": "string"
},
"active": {
"description": "Active",
"type": "integer"
},
"other_email": {
"description": "other_email",
"type": "string"
},
"payroll_id": {
"description": "Payroll ID",
"type": "string"
},
"faculty_role": {
"description": "Faculty role [0=Faculty Only|1=SBL Only|2=Both]",
"type": "integer"
},
"sbl_organizations": {
"description": "Site Based Learning Organizations ex. `[1,34,67]`",
"type": "object",
"example": "[\n * 1,43,65\n * ]"
},
"employee_id": {
"description": "Employee ID",
"type": "string"
},
"do_not_staff": {
"description": "Is faculty restricted from being staffed? Default 0 = no, Set to 1 for yes",
"type": "integer"
},
"fte_value": {
"description": "Tracking FTE Data",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Faculty"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Faculty"
],
"summary": "Delete Faculty information",
"description": "Delete Faculty data",
"operationId": "deleteByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Faculty UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty/{id}": {
"get": {
"tags": [
"Faculty"
],
"summary": "Get Faculty information by UniqueID",
"description": "Returns Faculty data",
"operationId": "showFacultyById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Faculty ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Faculty"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Faculty"
],
"summary": "Update A Faculty",
"description": "Update a Faculty entry.",
"operationId": "updateById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Faculty ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"campus_unique_id",
"college_unique_id",
"department_unique_id",
"firstname",
"lastname",
"email"
],
"properties": {
"unique_id": {
"description": "Faculty Unique Id",
"type": "string"
},
"campus_unique_id": {
"description": "Primary Campus",
"type": "string"
},
"college_unique_id": {
"description": "Primary College",
"type": "string"
},
"department_unique_id": {
"description": "Primary Department",
"type": "string"
},
"faculty_code": {
"description": "Faculty Code",
"type": "string"
},
"other_code": {
"description": "Other Code",
"type": "string"
},
"faculty_identifier": {
"description": "Faculty Identifier",
"type": "string"
},
"firstname": {
"description": "First Name",
"type": "string"
},
"middlename": {
"description": "Middle Name",
"type": "string"
},
"lastname": {
"description": "Last Name",
"type": "string"
},
"Email": {
"description": "Email",
"type": "string"
},
"office_address": {
"description": "Office Address",
"type": "string"
},
"office_city": {
"description": "Office City",
"type": "string"
},
"office_state": {
"description": "Office State",
"type": "string"
},
"office_zip": {
"description": "Office Zip",
"type": "string"
},
"phone": {
"description": "Primary Phone",
"type": "string"
},
"office_country": {
"description": "Office Country",
"type": "string"
},
"home_address": {
"description": "Home Address",
"type": "string"
},
"home_city": {
"description": "Home City",
"type": "string"
},
"home_state": {
"description": "Home State",
"type": "string"
},
"home_zip": {
"description": "Home Zip",
"type": "string"
},
"home_country": {
"description": "Home Country",
"type": "string"
},
"email2": {
"description": "Secondary Email",
"type": "string"
},
"mobilephone": {
"description": "Mobile Phone",
"type": "string"
},
"homephone": {
"description": "Home Phone",
"type": "string"
},
"date_transcript_verified": {
"description": "Date Transcript Verified",
"type": "string",
"format": "date"
},
"start_date": {
"description": "Start Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date",
"type": "string",
"format": "date"
},
"tenure_status": {
"description": "Tenure Status",
"type": "string"
},
"tenure_date": {
"description": "Tenure Date",
"type": "string",
"format": "date"
},
"cip_code": {
"description": "CIP Code",
"type": "number",
"format": "float"
},
"race": {
"description": "Race",
"type": "string"
},
"ethnicity_id": {
"description": "Ethnicity",
"type": "integer"
},
"diversity": {
"description": "Diversity 0 = no answer, 1 = Diverse, 2 = Not-Diverse",
"type": "integer"
},
"gender_id": {
"description": "Gender",
"type": "integer"
},
"professional_certs_earned": {
"description": "Professional Certs Earned",
"type": "string"
},
"credentail_2_degree": {
"description": "Credentail 2 Degree",
"type": "string"
},
"date_of_birth": {
"description": "Date Of Birth",
"type": "string",
"format": "date"
},
"us_citizen": {
"description": "Credentail 2 Institution",
"type": "boolean"
},
"languages": {
"description": "Languages known",
"type": "string"
},
"prefix": {
"description": "Prefix",
"type": "string"
},
"suffix": {
"description": "Suffix",
"type": "string"
},
"supervisor_unique_id": {
"description": "Supervisor Unique Id",
"type": "string"
},
"other_email": {
"description": "other_email",
"type": "string"
},
"payroll_id": {
"description": "Payroll ID",
"type": "string"
},
"faculty_role": {
"description": "Faculty role [0=Faculty Only|1=SBL Only|2=Both]",
"type": "integer"
},
"sbl_organizations": {
"description": "Site Based Learning Organizations ex. `[1,34,67]`",
"type": "object",
"example": "[\n * 1,43,65\n * ]"
},
"active": {
"description": "Active",
"type": "integer"
},
"employee_id": {
"description": "Employee ID",
"type": "string"
},
"do_not_staff": {
"description": "Is faculty restricted from being staffed? Default 0 = no, Set to 1 for yes",
"type": "integer"
},
"fte_value": {
"description": "Tracking FTE Data",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Faculty"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Faculty"
],
"summary": "Delete Faculty information",
"description": "Delete Faculty data",
"operationId": "deleteFacultyById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Faculty ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty-distinction": {
"get": {
"tags": [
"FacultyDistinction"
],
"summary": "Get list of Faculty Distinction",
"description": "Returns list of Faculty Distinction.",
"operationId": "getFacultyDistinctions",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacultyDistinction"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"FacultyDistinction"
],
"summary": "Add a new Faculty Distinction",
"description": "Add a new Faculty Distinction",
"operationId": "storeFacultyDistinction",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name"
],
"properties": {
"name": {
"description": "Faculty Distinction Name",
"type": "string"
},
"unique_id": {
"description": "Faculty Distinction Unique ID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacultyDistinction"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty-distinction/unique_id/{unique_id}": {
"get": {
"tags": [
"FacltyDistinction"
],
"summary": "Faclty distinction information by Unique ID",
"description": "Returns faclty distinction data",
"operationId": "showFacultyDistinctionByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Faclty Distinction Unique ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacultyDistinction"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"FacultyDistinction"
],
"summary": "Update Faculty Distinction",
"description": "Update Faculty Distinction",
"operationId": "updateFacultyDistinctionByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Faculty Distinction Unique ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"name": {
"description": "Faculty Distinction Name",
"type": "string"
},
"unique_id": {
"description": "Faculty Distinction UniqueId",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacultyDistinction"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"FacultyDistinction"
],
"summary": "Delete Faculty Distinction",
"description": "Delete Faculty Distinction",
"operationId": "destroyFacultyDistinctionByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Faculty Distinction UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty-distinction/{id}": {
"get": {
"tags": [
"FacltyDistinction"
],
"summary": "Faclty distinction information by ID",
"description": "Returns faclty distinction data",
"operationId": "showFacultyDistinctionById",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Faclty Distinction ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacultyDistinction"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"FacultyDistinction"
],
"summary": "Update Faculty Distinction",
"description": "Update Faculty Distinction",
"operationId": "updateFacultyDistinctionById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Faculty Distinction ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"name": {
"description": "Faculty Distinction Name",
"type": "string"
},
"unique_id": {
"description": "Faculty Distinction UniqueId",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacultyDistinction"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"FacultyDistinction"
],
"summary": "Delete Faculty Distinction",
"description": "Delete Faculty Distinction",
"operationId": "destroyFacultyDistinctionById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Faculty Distinction ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty/qualifying_experience/{unique_id}": {
"get": {
"tags": [
"FacultyQualifyingExperience"
],
"summary": "Get Faculty qualifying information by UniqueID",
"description": "Returns Faculty Qualifying Experience data",
"operationId": "showFacultyQualifyingExperienceByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Faculty UniqueId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/faculty/qualifying_credential/{unique_id}": {
"get": {
"tags": [
"FacultyQualifyingCredential"
],
"summary": "Get Faculty qualifying credential by UniqueId",
"description": "Returns Faculty qualifying credential data",
"operationId": "showFacultyQualifyingCredentialByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Faculty UniqueId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/faculty/distinction/{unique_id}/{date}": {
"get": {
"tags": [
"FacultyDistinction"
],
"summary": "Get Faculty distinction by UniqueId",
"description": "Returns Faculty distinction data",
"operationId": "showFacultyDistinctionByUniqueIdAndDate",
"parameters": [
{
"name": "date",
"in": "path",
"description": "Academic year (format: yyyy-yyyy) or Effective date (format: yyyy-mm-dd)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/faculty-workload/{unique_id}{?start_date}{&end_date}": {
"get": {
"tags": [
"FacultyWorkload"
],
"summary": "Get Faculty workload information by UniqueId and date range",
"description": "Returns Faculty Workload values",
"operationId": "showFacultyWorkloadById",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Faculty Unique Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "start_date",
"in": "path",
"description": "start of date range to get workload for faculty",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "end_date",
"in": "path",
"description": "end of date range to get workload for faculty",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacultyWorkload"
}
}
}
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/faculty/faculty-job-code": {
"get": {
"tags": [
"FacultyJobCode"
],
"summary": "List of Faculty Job Codes",
"description": "Get list of Job Codes assigned to a Faculty",
"operationId": "getFacultyJobCode",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"FacultyJobCode"
],
"summary": "Add new Faculty Job Code",
"description": "Add new Faculty Job Code",
"operationId": "createFacultyJobCode",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"job_role_unique_id",
"faculty_unique_id"
],
"properties": {
"unique_id": {
"description": "Faculty Job Code Unique Id",
"type": "string"
},
"job_code": {
"description": "Faculty Job Code Name",
"type": "string"
},
"job_role_unique_id": {
"description": "Job Role Unique Id",
"type": "string"
},
"faculty_unique_id": {
"description": "Faculty Unique Id",
"type": "string"
},
"department_unique_id": {
"description": "Department Unique Id",
"type": "string"
},
"college_unique_id": {
"description": "College Unique Id",
"type": "string"
},
"campus_unique_id": {
"description": "Campus Unique Id",
"type": "string"
},
"supervisor_unique_id": {
"description": "Supervisor Unique Id",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty/faculty-job-code/by-unique-id/{unique_id}": {
"get": {
"tags": [
"FacultyJobCode"
],
"summary": "Get Faculty Job Code information by Unique Id",
"description": "Returns Facukty Job Code data",
"operationId": "getFacultyJobCodeByUniqueId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Faculty Job Code Unique Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "View"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/faculty/faculty-job-code/{id}": {
"get": {
"tags": [
"FacultyJobCode"
],
"summary": "Get Faculty Job Code information by Id",
"description": "Returns Faculty Job Code data",
"operationId": "getFacultyJobCodeById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Faculty Job Code Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"FacultyJobCode"
],
"summary": "Update Faculty Job Code",
"description": "Update Faculty Job Code",
"operationId": "updateFacultyJobCode",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"unique_id": {
"description": "Faculty Job Code Unique Id",
"type": "string"
},
"job_code": {
"description": "Faculty Job Code Name",
"type": "string"
},
"job_role_unique_id": {
"description": "Job Role Unique Id",
"type": "string"
},
"faculty_unique_id": {
"description": "Faculty Unique Id",
"type": "string"
},
"department_unique_id": {
"description": "Department Unique Id",
"type": "string"
},
"college_unique_id": {
"description": "College Unique Id",
"type": "string"
},
"campus_unique_id": {
"description": "Campus Unique Id",
"type": "string"
},
"supervisor_unique_id": {
"description": "Supervisor Unique Id",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"FacultyJobCode"
],
"summary": "Delete Faculty Job Code",
"description": "Delete Faculty Job Code",
"operationId": "deleteFacultuJobCode",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Faculty Job Code ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Deleted"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty/job-groups": {
"get": {
"tags": [
"JobGroup"
],
"summary": "Get list of Job Groups",
"description": "Returns list of Job Roles",
"operationId": "getJobGroups",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/faculty/job-group/by-unique-id/{unique_id}": {
"get": {
"tags": [
"JobGroup"
],
"summary": "Get Job Group information by Unique Id",
"description": "Returns Job Group data",
"operationId": "getGetJobGroupByUniqueId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job Group Unique Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "View"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/faculty/job-group/{id}": {
"get": {
"tags": [
"JobGroup"
],
"summary": "Get Job Group information by Id",
"description": "Returns Job Group data",
"operationId": "getGetJobGroupById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job Group Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"JobGroup"
],
"summary": "Update Job Group",
"description": "Update Job Group",
"operationId": "updateJobGroup",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job Group ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name"
],
"properties": {
"unique_id": {
"description": "Job Group Unique Id",
"type": "string"
},
"name": {
"description": "Job Group Name",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Updated"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"JobGroup"
],
"summary": "Delete Job Group",
"description": "Delete Job Group",
"operationId": "deleteJobGroup",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job Group ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Deleted"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty/job-group": {
"post": {
"tags": [
"JobGroup"
],
"summary": "Add new Job Group",
"description": "Add new Job Group",
"operationId": "createNewJobGroup",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name"
],
"properties": {
"unique_id": {
"description": "Job Group Unique Id",
"type": "string"
},
"name": {
"description": "Job Group Name",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty/job-roles": {
"get": {
"tags": [
"JobRole"
],
"summary": "Get list of Job JobRoles",
"description": "Returns list of Job Roles",
"operationId": "getJobRoles",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/faculty/job-role/by-unique-id/{unique_id}": {
"get": {
"tags": [
"JobRole"
],
"summary": "Get Job Role information by Unique Id",
"description": "Returns Job Role data",
"operationId": "getGetJobRoleByUniqueId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job Role Unique Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "View"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/faculty/job-role/{id}": {
"get": {
"tags": [
"JobRole"
],
"summary": "Get Job Role information by Id",
"description": "Returns Job Role data",
"operationId": "getGetJobRoleById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job Role Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"JobRole"
],
"summary": "Update Job Role",
"description": "Update Job Role",
"operationId": "updateJobRole",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job Role ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"unique_id": {
"description": "Job Role Unique Id",
"type": "string"
},
"name": {
"description": "Job Role Name",
"type": "string"
},
"job_group_unique_id": {
"description": "Job Group Unique Id",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"JobRole"
],
"summary": "Delete Job Role",
"description": "Delete Job Role",
"operationId": "deleteJobRole",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job Role ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Deleted"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/faculty/job-role": {
"post": {
"tags": [
"JobRole"
],
"summary": "Add new Job Role",
"description": "Add new Job Role",
"operationId": "createNewJobRole",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name",
"job_group_unique_id"
],
"properties": {
"unique_id": {
"description": "Job Role Unique Id",
"type": "string"
},
"name": {
"description": "Job Role Name",
"type": "string"
},
"job_group_unique_id": {
"description": "Job Group Unique Id",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/load-class": {
"get": {
"tags": [
"Load"
],
"summary": "Get list of LoadClasses",
"description": "Returns list of LoadClasses",
"operationId": "getLoadClasses",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Load"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/load-class/{loadModel}": {
"get": {
"tags": [
"Load"
],
"summary": "Get list of LoadClasses",
"description": "Returns list of LoadClasses",
"operationId": "getLoadClassById",
"parameters": [
{
"name": "loadModel",
"in": "path",
"description": "Load Class ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Load"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/pdf-cv-batch/{id}": {
"get": {
"tags": [
"PdfCvBatch"
],
"summary": "Get a single Batch Entry by Id",
"description": "Returns a Batch Entry by Id",
"operationId": "getPdfCvBatchByyId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "PDF CV Batch Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfCvBatch"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/pdf-cv-batch": {
"get": {
"tags": [
"PdfCvBatch"
],
"summary": "Get list of Batch Entries by Id",
"description": "Returns list of Batch Entries by Id",
"operationId": "getPdfCvBatch",
"parameters": [
{
"name": "id",
"in": "path",
"description": "PDF CV Batch Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfCvBatch"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"PdfCvBatch"
],
"summary": "Create a new Cv Batch ",
"description": "Create a new CvBatch ",
"operationId": "storePdfCvBatch ",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"faculty_data"
],
"properties": {
"faculty_data": {
"description": "Array of Faculty Ids to create a CV batch for",
"type": "array",
"items": {
"type": "integer",
"format": "id",
"example": "1, 2, 3, 4"
},
"collectionFormat": "multi"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfCvBatch"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/pdf-cv-batch/{id}/file": {
"get": {
"tags": [
"PdfCvBatch"
],
"summary": "Get Batch File for Faculty CV's",
"description": "Returns zip file containing the batched faculty CV's",
"operationId": "getPdfCvBatchFileById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Batch Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/zip": {}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/pdf-cv/{faculty-id}": {
"get": {
"tags": [
"PdfCv"
],
"summary": "Get CV for Faculty by Id",
"description": "Returns CV based on the Faucluty Id",
"operationId": "getPdfCvByFacultyId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Faculty Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/pdf": {}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/performance-note": {
"get": {
"tags": [
"PerformanceNotes"
],
"summary": "Get list of Performance Notes",
"description": "Returns list of Performance Notes",
"operationId": "getPerformanceNotes",
"responses": {
"200": {
"description": "Index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PerformanceNote"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects"
]
}
]
},
"post": {
"tags": [
"PerformanceNotes"
],
"summary": "Add a new Performance Note",
"description": "Add a new Performance Note",
"operationId": "storePerformanceNotes",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"faculty_unique_id",
"type",
"notes",
"academic_year"
],
"properties": {
"faculty_unique_id": {
"description": "Faculty UniqueID",
"type": "string"
},
"campus": {
"description": "Campus Name or Campus UniqueID ",
"type": "string"
},
"college": {
"description": "College Name or College UniqueID",
"type": "string"
},
"department": {
"description": "Department Name or Department UniqueID",
"type": "string"
},
"course_name": {
"description": "Course Name",
"type": "string"
},
"course_unique_id": {
"description": "Course UniqueID",
"type": "string"
},
"term_unique_id": {
"description": "Term UniqueID",
"type": "string"
},
"type": {
"description": "Type",
"type": "string"
},
"notes": {
"description": "notes",
"type": "string"
},
"public_to_adjunct": {
"description": "Public To Adjunct",
"type": "string"
},
"public_to_other": {
"description": "Public To Other",
"type": "string"
},
"academic_year": {
"description": "Academic Year",
"type": "string"
},
"created": {
"description": "Note Crated At Date (m/d/Y)",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PerformanceNote"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/performance-note/{id}": {
"get": {
"tags": [
"PerformanceNotes"
],
"summary": "Get Performance Note information by id",
"description": "Returns Performance Note data",
"operationId": "getByPerformanceNotesId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Note Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PerformanceNote"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"PerformanceNotes"
],
"summary": "Update Performance Note",
"description": "Update Performance Note",
"operationId": "updatePerformanceNotes",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Note Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"faculty_unique_id",
"type",
"notes",
"academic_year"
],
"properties": {
"faculty_unique_id": {
"description": "Faculty UniqueID",
"type": "string"
},
"campus": {
"description": "Campus Name or Campus UniqueID",
"type": "string"
},
"college": {
"description": "College Name or College UniqueID",
"type": "string"
},
"department": {
"description": "Department Name or Department UniqueID",
"type": "string"
},
"course_unique_id": {
"description": "Course Name UniqueID",
"type": "string"
},
"course_number_unique_id": {
"description": "Course number UniqueID",
"type": "string"
},
"term_unique_id": {
"description": "Term UniqueID",
"type": "string"
},
"type": {
"description": "Type",
"type": "string"
},
"notes": {
"description": "notes",
"type": "string"
},
"public_to_adjunct": {
"description": "Public To Adjunct",
"type": "string"
},
"public_to_other": {
"description": "Public To Other",
"type": "string"
},
"academic_year": {
"description": "Academic Year",
"type": "string"
},
"created": {
"description": "Note Crated At Date (m/d/Y)",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PerformanceNote"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"PerformanceNotes"
],
"summary": "Delete Performance Note information",
"description": "Delete Performance Note data",
"operationId": "destroyPerformanceNotes",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Note Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/pronoun": {
"get": {
"tags": [
"Pronoun"
],
"summary": "Get list of Pronouns",
"description": "Returns list of Pronouns",
"operationId": "getPronouns",
"responses": {
"200": {
"description": "Index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Pronoun"
}
}
}
},
"404": {
"description": "Resource Not Found"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Pronoun"
],
"summary": "Add a new Pronoun",
"description": "Add a new Pronoun",
"operationId": "storePronoun",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "Pronoun Name",
"type": "string"
},
"unique_id": {
"description": "Pronoun UniqueID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Pronoun"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/pronoun/{unique_id}": {
"get": {
"tags": [
"Pronoun"
],
"summary": "Get Pronoun information by UniqueID",
"description": "Returns Pronoun data",
"operationId": "getPronounByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Pronoun UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Pronoun"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Pronoun"
],
"summary": "Update Pronoun information",
"description": "Update Pronoun data",
"operationId": "updatePronoun",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Pronoun UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "Pronoun Name",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Pronoun"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Pronoun"
],
"summary": "Delete Pronoun information",
"description": "Delete Pronoun data",
"operationId": "destroyPronoun",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Pronoun UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/qualification": {
"get": {
"tags": [
"Qualification"
],
"summary": "Get list of Qualifications",
"description": "Returns list of Qualifications",
"operationId": "getQualifications",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Qualification"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Qualification"
],
"summary": "Add a new Qualification",
"description": "Add a new Qualification",
"operationId": "storeQualification",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"campus_unique_id",
"college_unique_id",
"department_unique_id",
"faculty_unique_id",
"coursename",
"coursenum",
"waived_type"
],
"properties": {
"campus_unique_id": {
"description": "Campus Unique ID",
"type": "string"
},
"college_unique_id": {
"description": "College Unique ID",
"type": "string"
},
"department_unique_id": {
"description": "Faculty Unique ID",
"type": "string"
},
"faculty_unique_id": {
"description": "Faculty Unique ID",
"type": "string"
},
"original_course_unique_id": {
"description": "Course Unique ID",
"type": "string"
},
"original_assign_id": {
"description": "Original assign ID",
"type": "integer"
},
"coursekey": {
"description": "Course Key",
"type": "string"
},
"academical": {
"description": "Academical",
"type": "boolean"
},
"academical_terminal": {
"description": "Academical",
"type": "boolean"
},
"academical_onelevel": {
"description": "Academical_masterplus",
"type": "boolean"
},
"experiential": {
"description": "Experiential",
"type": "boolean"
},
"experiential_rationale": {
"description": "Experiential Rationale",
"type": "text"
},
"professional": {
"description": "Professional",
"type": "boolean"
},
"waived": {
"description": "Waived",
"type": "integer"
},
"waived_type": {
"description": "Waived type",
"type": "string"
},
"other": {
"description": "Other",
"type": "integer"
},
"course_name": {
"description": "Course Name",
"type": "string"
},
"course_number": {
"description": "Course Number",
"type": "string"
},
"start_date": {
"description": "State Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date",
"type": "string",
"format": "date"
},
"path": {
"description": "Path",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Access denied"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/qualification/{id}": {
"get": {
"tags": [
"Qualification"
],
"summary": "Get Qualification information by UniqueID",
"description": "Returns Qualification data",
"operationId": "getByQualificationUniqueId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Qualification ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Qualification"
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Access denied"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Qualification"
],
"summary": "Update A Qualification",
"description": "Update a Qualification entry.",
"operationId": "updateQualification",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Qualification ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"campus_unique_id": {
"description": "Campus Unique ID",
"type": "string"
},
"college_unique_id": {
"description": "College Unique ID",
"type": "string"
},
"department_unique_id": {
"description": "Faculty Unique ID",
"type": "string"
},
"faculty_unique_id": {
"description": "Faculty Unique ID",
"type": "string"
},
"original_course_unique_id": {
"description": "Course Unique ID",
"type": "string"
},
"original_assign_id": {
"description": "Original assign ID",
"type": "integer"
},
"coursekey": {
"description": "Course Key",
"type": "string"
},
"academical": {
"description": "Academical",
"type": "boolean"
},
"academical_terminal": {
"description": "Academical",
"type": "boolean"
},
"academical_onelevel": {
"description": "Academical_masterplus",
"type": "boolean"
},
"experiential": {
"description": "Experiential",
"type": "boolean"
},
"experiential_rationale": {
"description": "Experiential Rationale",
"type": "text"
},
"professional": {
"description": "Professional",
"type": "boolean"
},
"waived": {
"description": "Waived",
"type": "integer"
},
"waived_type": {
"description": "Waived type",
"type": "string"
},
"other": {
"description": "Other",
"type": "integer"
},
"course_name": {
"description": "Course Name",
"type": "string"
},
"course_number": {
"description": "Course Number",
"type": "string"
},
"start_date": {
"description": "State Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date",
"type": "string",
"format": "date"
},
"path": {
"description": "Path",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Qualification"
],
"summary": "Delete Qualification information",
"description": "Delete Qualification data",
"operationId": "destroyQualification",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Qualification ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Access Denied"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/qualification/addbulk": {
"post": {
"tags": [
"Qualification"
],
"summary": "Add Qualifications",
"description": "Bulk insert Qualifications",
"operationId": "bulkAddQualification",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"campus_unique_id",
"college_unique_id",
"department_unique_id",
"faculty_unique_id",
"coursename",
"coursenum",
"waived_type"
],
"items": [
{
"description": "Campus Unique ID",
"type": "string",
"property": "campus_unique_id"
},
{
"description": "College Unique ID",
"type": "string",
"property": "college_unique_id"
},
{
"description": "Faculty Unique ID",
"type": "string",
"property": "department_unique_id"
},
{
"description": "Faculty Unique ID",
"type": "string",
"property": "faculty_unique_id"
},
{
"description": "Course Unique ID",
"type": "string",
"property": "original_course_unique_id"
},
{
"description": "Original assign ID",
"type": "integer",
"property": "original_assign_id"
},
{
"description": "Course Key",
"type": "string",
"property": "coursekey"
},
{
"description": "Academical",
"type": "boolean",
"property": "academical"
},
{
"description": "Academical",
"type": "boolean",
"property": "academical_terminal"
},
{
"description": "Academical_masterplus",
"type": "boolean",
"property": "academical_onelevel"
},
{
"description": "Experiential",
"type": "boolean",
"property": "experiential"
},
{
"description": "Experiential Rationale",
"type": "text",
"property": "experiential_rationale"
},
{
"description": "Professional",
"type": "boolean",
"property": "professional"
},
{
"description": "Waived",
"type": "integer",
"property": "waived"
},
{
"description": "Waived type",
"type": "string",
"property": "waived_type"
},
{
"description": "Other",
"type": "integer",
"property": "other"
},
{
"description": "Course Name",
"type": "string",
"property": "course_name"
},
{
"description": "Course Number",
"type": "string",
"property": "course_number"
},
{
"description": "State Date",
"type": "string",
"format": "date",
"property": "start_date"
},
{
"description": "End Date",
"type": "string",
"format": "date",
"property": "end_date"
},
{
"description": "Path",
"type": "string",
"property": "path"
}
],
"example": {
"data": [
{
"campus_unique_id": "",
"college_unique_id": "",
"department_unique_id": "",
"coursename": "",
"coursenum": "",
"waived_type": ""
},
{
"campus_unique_id": "",
"college_unique_id": "",
"department_unique_id": "",
"coursename": "",
"coursenum": "",
"waived_type": ""
}
]
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkDataImport"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/qualification/updatebulk": {
"post": {
"tags": [
"Qualification"
],
"summary": "Update Qualifications",
"description": "Bulk Update Qualifications",
"operationId": "bulkUpdateQualification",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"id"
],
"items": [
{
"description": "Qualification ID",
"type": "string",
"property": "id"
},
{
"description": "Campus Unique ID",
"type": "string",
"property": "campus_unique_id"
},
{
"description": "College Unique ID",
"type": "string",
"property": "college_unique_id"
},
{
"description": "Faculty Unique ID",
"type": "string",
"property": "department_unique_id"
},
{
"description": "Faculty Unique ID",
"type": "string",
"property": "faculty_unique_id"
},
{
"description": "Course Unique ID",
"type": "string",
"property": "original_course_unique_id"
},
{
"description": "Original assign ID",
"type": "integer",
"property": "original_assign_id"
},
{
"description": "Course Key",
"type": "string",
"property": "coursekey"
},
{
"description": "Academical",
"type": "boolean",
"property": "academical"
},
{
"description": "Academical",
"type": "boolean",
"property": "academical_terminal"
},
{
"description": "Academical_masterplus",
"type": "boolean",
"property": "academical_onelevel"
},
{
"description": "Experiential",
"type": "boolean",
"property": "experiential"
},
{
"description": "Experiential Rationale",
"type": "text",
"property": "experiential_rationale"
},
{
"description": "Professional",
"type": "boolean",
"property": "professional"
},
{
"description": "Waived",
"type": "integer",
"property": "waived"
},
{
"description": "Waived type",
"type": "string",
"property": "waived_type"
},
{
"description": "Other",
"type": "integer",
"property": "other"
},
{
"description": "Course Name",
"type": "string",
"property": "course_name"
},
{
"description": "Course Number",
"type": "string",
"property": "course_number"
},
{
"description": "State Date",
"type": "string",
"format": "date",
"property": "start_date"
},
{
"description": "End Date",
"type": "string",
"format": "date",
"property": "end_date"
},
{
"description": "Path",
"type": "string",
"property": "path"
}
],
"example": {
"data": [
{
"id": "",
"campus_unique_id": "",
"college_unique_id": "",
"department_unique_id": "",
"coursename": "",
"coursenum": "",
"waived_type": ""
},
{
"id": "",
"campus_unique_id": "",
"college_unique_id": "",
"department_unique_id": "",
"coursename": "",
"coursenum": "",
"waived_type": ""
}
]
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkDataImport"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/coursedesignations": {
"get": {
"tags": [
"CourseDesignations"
],
"summary": "Get list of Course Designations",
"description": "Returns list of Course Designations",
"operationId": "getCourseDesignations",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseDesignation"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"CourseDesignations"
],
"summary": "Add a new Course Designations",
"description": "Add a new Course Designations",
"operationId": "storeCourseDesignation",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"unique_id"
],
"properties": {
"name": {
"description": "Course Designations Name",
"type": "string"
},
"unique_id": {
"description": "Course Designations UniqueID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/coursedesignations/{unique_id}": {
"get": {
"tags": [
"CourseDesignations"
],
"summary": "Get Course Designations information by UniqueID",
"description": "Returns Course Designations data",
"operationId": "getCourseDesignationByUniqueID",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Course Designations UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseDesignation"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"CourseDesignations"
],
"summary": "Update A Course Designations",
"description": "Update a Course Designations entry.",
"operationId": "updateCourseDesignation",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Course Designations UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name"
],
"properties": {
"unique_id": {
"description": "Course Designations UniqueID",
"type": "integer"
},
"name": {
"description": "Course Designations Name",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"CourseDesignations"
],
"summary": "Delete A Course Designations",
"description": "Delete a Course Designations entry.",
"operationId": "destroyCourseDesignation",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Course Designations UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/coursedesignations/by-id/{id}": {
"get": {
"tags": [
"CourseDesignations"
],
"summary": "Get Course Designations information by ID",
"description": "Returns Course Designations data",
"operationId": "getCourseDesignationById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Course Designations ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CourseDesignation"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"CourseDesignations"
],
"summary": "Update A Course Designations",
"description": "Update a Course Designations entry.",
"operationId": "updateCourseDesignationById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Course Designations ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name"
],
"properties": {
"unique_id": {
"description": "Course Designations UniqueID",
"type": "string"
},
"name": {
"description": "Course Designations Name",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"CourseDesignations"
],
"summary": "Delete A Course Designations",
"description": "Delete a Course Designations entry.",
"operationId": "destroyCourseDesignationById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Course Designations ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/ethnicity": {
"get": {
"tags": [
"Ethnicities"
],
"summary": "Get list of Ethnicities",
"description": "Returns list of Ethnicities",
"operationId": "getEthnicity",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Ethnicity"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Ethnicities"
],
"summary": "Add a new Ethnicity",
"description": "Add a new Ethnicity",
"operationId": "storeEthnicity",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name"
],
"properties": {
"unique_id": {
"description": "Ethnicity UniqueID",
"type": "string"
},
"name": {
"description": "Ethnicity Name",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/ethnicity/{unique_id}": {
"get": {
"tags": [
"Ethnicities"
],
"summary": "Get Ethnicity information by UniqueID",
"description": "Returns Ethnicity data",
"operationId": "getByEthnicityUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Ethnicity UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Ethnicity"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Ethnicities"
],
"summary": "Update A Ethnicity",
"description": "Update a Ethnicity entry.",
"operationId": "updateEthnicity",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Ethnicity UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "Ethnicity Name",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Ethnicities"
],
"summary": "Delete Ethnicity information",
"description": "Delete Ethnicity data",
"operationId": "destroyEthnicity",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Ethnicity UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/gender": {
"get": {
"tags": [
"Gender"
],
"summary": "Get list of Genders",
"description": "Returns list of Genders",
"operationId": "getGender",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Gender"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Gender"
],
"summary": "Add a new Gender",
"description": "Add a new Gender",
"operationId": "storeGender",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"unique_id"
],
"properties": {
"name": {
"description": "Gender Name",
"type": "string"
},
"unique_id": {
"description": "Gender UniqueID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/gender/{unique_id}": {
"get": {
"tags": [
"Gender"
],
"summary": "Get Gender information by UniqueID",
"description": "Returns Gender data",
"operationId": "getByGenderUniqueID",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Gender UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Gender"
],
"summary": "Update A Gender",
"description": "Update a Gender entry.",
"operationId": "updateGender",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Gender UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name"
],
"properties": {
"name": {
"description": "Gender Name",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Gender"
],
"summary": "Delete A Gender",
"description": "Delete a Gender entry.",
"operationId": "destroyGender",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Gender UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/load-statuses": {
"get": {
"tags": [
"LoadStatuses"
],
"summary": "Get list of Load Statuses",
"description": "Returns list of Load Statuses",
"operationId": "getLoadStatuses",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoadStatus"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"LoadStatuses"
],
"summary": "Add a new Load Status",
"description": "Add a new Load Status",
"operationId": "storeLoadStatus",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name",
"threshold",
"classification"
],
"properties": {
"unique_id": {
"description": "Load Status UniqueID",
"type": "string"
},
"name": {
"description": "Load Status Name",
"type": "string"
},
"threshold": {
"description": "Load Status Threshold",
"type": "integer"
},
"classification": {
"description": "Load Classification",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/load-statuses/{unique_id}": {
"get": {
"tags": [
"LoadStatuses"
],
"summary": "Get Load Status information by UniqueID",
"description": "Returns Load Status data",
"operationId": "getByLoadStatusesUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Load Status UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoadStatus"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"LoadStatuses"
],
"summary": "Update A Load Status",
"description": "Update a Load Status entry.",
"operationId": "updateLoadStatuses",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Load Status UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"threshold",
"classification"
],
"properties": {
"name": {
"description": "Load Status Name",
"type": "string"
},
"threshold": {
"description": "Load Status Threshold",
"type": "integer"
},
"classification": {
"description": "Load Classification",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"LoadStatuses"
],
"summary": "Delete Load Status information",
"description": "Delete Load Status data",
"operationId": "destroyLoadStatuses",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Load Status UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/qualification-group": {
"get": {
"tags": [
"QualificationGroups"
],
"summary": "Get list of Qualification Groups",
"description": "Returns list of Qualification Groups",
"operationId": "getQualificationGroups",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualificationGroup"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"QualificationGroups"
],
"summary": "Add a new Qualification Group",
"description": "Add a new Qualification Group",
"operationId": "storeQualificationGroup",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name"
],
"properties": {
"unique_id": {
"description": "Qualification Group UniqueID",
"type": "string"
},
"name": {
"description": "Qualification Group Name",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/qualification-group/{unique_id}": {
"get": {
"tags": [
"QualificationGroups"
],
"summary": "Get Qualification Group information by UniqueID",
"description": "Returns Qualification Group data",
"operationId": "getByQualificationGroupUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Qualification Group UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualificationGroup"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"QualificationGroups"
],
"summary": "Update A Qualification Group",
"description": "Update a Qualification Group entry.",
"operationId": "updateQualificationGroup",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Qualification Group UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "Qualification Group Name",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"QualificationGroups"
],
"summary": "Delete Qualification Group information",
"description": "Delete Qualification Group data",
"operationId": "destroyQualificationGroup",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Qualification Group UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/race": {
"get": {
"tags": [
"Race"
],
"summary": "Get list of Races",
"description": "Returns list of Races",
"operationId": "getRaces",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Race"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Race"
],
"summary": "Add a new Race",
"description": "Add a new Race",
"operationId": "storeRace",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"unique_id"
],
"properties": {
"name": {
"description": "Race Name",
"type": "string"
},
"unique_id": {
"description": "Race UniqueID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/race/{unique_id}": {
"get": {
"tags": [
"Race"
],
"summary": "Get Race information by UniqueID",
"description": "Returns Race data",
"operationId": "getByRaceUniqueID",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Race UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Race"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Race"
],
"summary": "Update A Race",
"description": "Update a Race entry.",
"operationId": "updateRace",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Race UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"name"
],
"properties": {
"name": {
"description": "Race Name",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Race"
],
"summary": "Delete A Race",
"description": "Delete a Race entry.",
"operationId": "destroyRace",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Race UniqueID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/rank": {
"get": {
"tags": [
"Rank"
],
"summary": "Get list of Ranks",
"description": "Returns list of Ranks",
"operationId": "getRank",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rank"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Rank"
],
"summary": "Add a new Rank",
"description": "Add a new Rank",
"operationId": "storeRank",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"unique_id"
],
"properties": {
"name": {
"description": "Rank Name",
"type": "string"
},
"unique_id": {
"description": "Rank UniqueID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/rank/{unique_id}": {
"get": {
"tags": [
"Rank"
],
"summary": "Get rank information by UniqueID",
"description": "Returns rank data",
"operationId": "getByRankUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Rank UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rank"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Rank"
],
"summary": "Update A Rank",
"description": "Update a Rank entry.",
"operationId": "updateRank",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Rank UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "Rank Name",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Rank"
],
"summary": "Delete A Rank",
"description": "Delete a rank entry.",
"operationId": "destroyRank",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Rank UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/rank/addbulk": {
"post": {
"tags": [
"Rank"
],
"summary": "Add Rank",
"description": "Bulk Insert Rank data",
"operationId": "bulkAddRank",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Rank UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"name, unique_id"
],
"type": "array",
"items": [
{
"description": "Rank Name",
"type": "string",
"property": "name"
},
{
"description": "Rank Unique Id",
"type": "string",
"property": "unique_id"
}
],
"example": {
"data": [
{
"unique_id": "123",
"name": "One Two Three"
},
{
"unique_id": "234",
"name": "Two Three Four"
}
]
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkDataImport"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/track": {
"get": {
"tags": [
"Track"
],
"summary": "Get list of Tracks",
"description": "Returns list of Tracks",
"operationId": "getTracks",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Track"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Track"
],
"summary": "Add a new Track",
"description": "Add a new Track",
"operationId": "storeTrack",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"unique_id"
],
"properties": {
"name": {
"description": "Track Name",
"type": "string"
},
"unique_id": {
"description": "Track UniqueID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/settings/track/{unique_id}": {
"get": {
"tags": [
"Track"
],
"summary": "Get Track information by UniqueID",
"description": "Returns Track data",
"operationId": "getByTrackUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Track UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Track"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Track"
],
"summary": "Update A Track",
"description": "Update a Track entry.",
"operationId": "updateTrack",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Track UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "Track Name",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Track"
],
"summary": "Delete A Track",
"description": "Delete a Track entry.",
"operationId": "destroyTrack",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Track UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/sbl/organization": {
"get": {
"tags": [
"SiteBasedLearningOrganization"
],
"summary": "Get list of SiteBasedOrganizations",
"description": "Returns list of SiteBasedOrganizations",
"operationId": "getSiteBasedOrganization",
"responses": {
"200": {
"description": "Index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SiteBasedLearningOrganization"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/staffing": {
"get": {
"tags": [
"Staffing"
],
"summary": "Get list of Staffings",
"description": "Returns list of Staffings",
"operationId": "getStaffing",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "Index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Staffing"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Staffing"
],
"summary": "Add a new Staffing",
"description": "Add a new Staffing",
"operationId": "storeStaffing",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id",
"course_unique_id",
"college_unique_id",
"campus_unique_id",
"dept_unique_id",
"status",
"dead_line"
],
"properties": {
"course_unique_id": {
"description": "Course Unique_id",
"type": "string"
},
"college_unique_id": {
"description": "College Unique_id",
"type": "string"
},
"campus_unique_id": {
"description": "Campus Unique_id",
"type": "string"
},
"dept_unique_id": {
"description": "Department Unique_id",
"type": "string"
},
"unique_id": {
"description": "Staffing UniqueID",
"type": "string"
},
"deadline": {
"description": "Dead Line - deprecated",
"type": "string",
"format": "date",
"deprecated": true
},
"Status": {
"description": "Available Status -\n * ASSIGNMENT_INCOMPLETE: 0\n * ASSIGNMENT_INVITED: 1\n * ASSIGNMENT_ACCEPTED: 2\n * ASSIGNMENT_REJECTED: 3\n * ASSIGNMENT_CANCELLED: 4\n * ASSIGNMENT_EXPIRED: 5\n * ASSIGNMENT_STAYED: 6\n * ASSIGNMENT_REMOVED: 7\n * ",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Staffing"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/staffing/{unique_id}": {
"get": {
"tags": [
"Staffing"
],
"summary": "Get Staffing information by UniqueID",
"description": "Returns Staffing data",
"operationId": "getByStaffingUniqueID",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Staffing UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Staffing"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Staffing"
],
"summary": "Update A Staffing",
"description": "Update a Staffing by Unique Id.",
"operationId": "updateStaffingByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Staffing UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"unique_id"
],
"properties": {
"course_unique_id": {
"description": "Course Unique_id",
"type": "string"
},
"college_unique_id": {
"description": "College Unique_id",
"type": "string"
},
"campus_unique_id": {
"description": "Campus Unique_id",
"type": "string"
},
"dept_unique_id": {
"description": "Department Unique_id",
"type": "string"
},
"unique_id": {
"description": "Staffing UniqueID",
"type": "string"
},
"dead_line": {
"description": "Dead Line",
"type": "string",
"format": "date"
},
"status": {
"description": "status",
"type": "integer"
},
"status_reason": {
"description": "Reason for the status",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Staffing"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Staffing"
],
"summary": "Delete A Staffing",
"description": "Delete a Staffing entry.",
"operationId": "destroyStaffingByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Staffing UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/staffing/by-id/{id}": {
"get": {
"tags": [
"Staffing"
],
"summary": "Get Staffing information by `id`",
"description": "Returns Staffing data",
"operationId": "getByStaffingId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Staffing Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Staffing"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Staffing"
],
"summary": "Update A Staffing By Id",
"description": "Update a Staffing entry.",
"operationId": "updateStaffingById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Staffing `id`",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"id"
],
"properties": {
"course_unique_id": {
"description": "Course Unique_id",
"type": "string"
},
"college_unique_id": {
"description": "College Unique_id",
"type": "string"
},
"campus_unique_id": {
"description": "Campus Unique_id",
"type": "string"
},
"dept_unique_id": {
"description": "Department Unique_id",
"type": "string"
},
"unique_id": {
"description": "Staffing UniqueID",
"type": "string"
},
"dead_line": {
"description": "Dead Line",
"type": "string",
"format": "date"
},
"Status": {
"description": "Available Status -\n * ASSIGNMENT_INCOMPLETE: 0\n * ASSIGNMENT_INVITED: 1\n * ASSIGNMENT_ACCEPTED: 2\n * ASSIGNMENT_REJECTED: 3\n * ASSIGNMENT_CANCELLED: 4\n * ASSIGNMENT_EXPIRED: 5\n * ASSIGNMENT_STAYED: 6\n * ASSIGNMENT_REMOVED: 7\n * ",
"type": "integer"
},
"status_reason": {
"description": "Reason for the status",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Staffing"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Staffing"
],
"summary": "Delete A Staffing",
"description": "Delete a Staffing entry by ID",
"operationId": "destroyStaffingById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Staffing ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/staffing-instructor": {
"get": {
"tags": [
"StaffingInstructor"
],
"summary": "Get list of Staffing Instructors",
"description": "Returns list of Staffing Instructors",
"operationId": "getStaffingInstructors",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaffingInstructor"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"StaffingInstructor"
],
"summary": "Add a new Staffing Instructor",
"description": "Add a new Staffing Instructor",
"operationId": "storeStaffingInstructor",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"staffing_unique_id",
"faculty_unique_id",
"instruction_role_unique_id"
],
"properties": {
"unique_id": {
"description": "Unique Id",
"type": "string"
},
"staffing_unique_id": {
"description": "Staffing UniqueID",
"type": "string"
},
"faculty_unique_id": {
"description": "Faculty UniqueID",
"type": "string"
},
"instruction_role_unique_id": {
"description": "Instruction Role UniqueID",
"type": "string"
},
"status_reason": {
"description": "Status Reason",
"type": "string"
},
"Status": {
"description": "Available Status -\n * ASSIGNMENT_INCOMPLETE: 0\n * ASSIGNMENT_INVITED: 1\n * ASSIGNMENT_ACCEPTED: 2\n * ASSIGNMENT_REJECTED: 3\n * ASSIGNMENT_CANCELLED: 4\n * ASSIGNMENT_EXPIRED: 5\n * ASSIGNMENT_STAYED: 6\n * ASSIGNMENT_REMOVED: 7\n * ",
"type": "integer"
},
"rejectreason": {
"description": "Reject Reason (Values for Reject Reason can be only one of the following: schedule, geography, delivery, compensation, other.)",
"type": "string"
},
"is_primary": {
"description": "Primary Instructor (Values for Primary Instructor can be only one of the following: 1, 0)",
"type": "integer"
},
"instructor_ignore_days_off": {
"description": "Status (Value for instructor_ignore_days_off can be only one of the following: 0,1.)",
"type": "integer"
},
"deadline": {
"description": "Deadline for Instructor to accept Staffing",
"type": "string",
"format": "date"
},
"workload": {
"description": "If set overrides the course workload value",
"type": "numeric"
},
"faculty_job_code_unique_id": {
"description": "Unique ID of the Faculty Job Code",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaffingInstructor"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/staffing-instructor/{id}": {
"get": {
"tags": [
"StaffingInstructor"
],
"summary": "Get Staffing Instructor information by ID",
"description": "Returns Staffing Instructor data",
"operationId": "getStaffingInstructorById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Staffing Instructor ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaffingInstructor"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"StaffingInstructor"
],
"summary": "Update A Staffing Instructor",
"description": "Update a Staffing Instructor entry.",
"operationId": "updateStaffingInstructor",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Staffing Instructor ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"staffing_unique_id": {
"description": "Staffing UniqueID",
"type": "string"
},
"faculty_unique_id": {
"description": "Faculty UniqueID",
"type": "string"
},
"instruction_role_unique_id": {
"description": "Instruction Role UniqueID",
"type": "string"
},
"Status": {
"description": "Available Status -\n * ASSIGNMENT_INCOMPLETE: 0\n * ASSIGNMENT_INVITED: 1\n * ASSIGNMENT_ACCEPTED: 2\n * ASSIGNMENT_REJECTED: 3\n * ASSIGNMENT_CANCELLED: 4\n * ASSIGNMENT_EXPIRED: 5\n * ASSIGNMENT_STAYED: 6\n * ASSIGNMENT_REMOVED: 7\n * ",
"type": "integer"
},
"status_reason": {
"description": "Reason for status",
"type": "string"
},
"rejectreason": {
"description": "Reject Reason (Values for Reject Reason can be only one of the following: schedule, geography, delivery, compensation, other.)",
"type": "string"
},
"primary_instructor": {
"description": "Primary Instructor (Values for Primary Instructor can be only one of the following: Y, N.)",
"type": "string"
},
"instructor_ignore_days_off": {
"description": "Status (Value for instructor_ignore_days_off can be only one of the following: 0,1.)",
"type": "integer"
},
"is_primary": {
"description": "Primary Instructor (Values for Primary Instructor can be only one of the following: 1, 0)",
"type": "integer"
},
"deadline": {
"description": "Deadline for Instructor to accept Staffing",
"type": "string",
"format": "date"
},
"workload": {
"description": "If set overrides the course workload value",
"type": "numeric"
},
"faculty_job_code_unique_id": {
"description": "Unique ID of the Faculty Job Code",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaffingInstructor"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"StaffingInstructor"
],
"summary": "Delete A Staffing Instructor",
"description": "Delete a Staffing Instructor entry.",
"operationId": "destroyStaffingInstructor",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Staffing Instructor ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/staffing-instructor/{staffing_instructor_id}/staffing-instructor-date": {
"get": {
"tags": [
"StaffingInstructorDate"
],
"summary": "Get list of Staffing Instructor Dates",
"description": "Returns list of Staffing Instructor Dates",
"operationId": "getStaffingInstructorDates",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaffingInstructorDate"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"StaffingInstructorDate"
],
"summary": "Add a new Staffing Instructor Date",
"description": "Add a new Staffing Instructor Date",
"operationId": "storeStaffingInstructorDate",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"staffing_instructor_id",
"start_date",
"end_date"
],
"properties": {
"staffing_instructor_id": {
"description": "Staffing Instructor Id",
"type": "integer"
},
"start_date": {
"description": "Start Date of the Staffing Assignment for the Instructor",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date of the Staffing Assignment for the Instructor",
"type": "string",
"format": "date"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaffingInstructorDate"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/staffing-instructor/{staffing_instructor_id}/staffing-instructor-date/{id}": {
"get": {
"tags": [
"StaffingInstructorDate"
],
"summary": "Get Staffing Instructor information by ID",
"description": "Returns Staffing Instructor data",
"operationId": "getStaffingInstructorDateById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Staffing Instructor Date ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaffingInstructorDate"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"delete": {
"tags": [
"StaffingInstructorDate"
],
"summary": "Delete A Staffing Instructor Date",
"description": "Delete a Staffing Instructor Date entry.",
"operationId": "destroyStaffingInstructorDate",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Staffing Instructor Date Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/staffing-instructor/{staffing_instructor_id}/staffing-instructor-date/{staffing_instructor_date_id}": {
"put": {
"tags": [
"StaffingInstructorDate"
],
"summary": "Update A Staffing Instructor Date",
"description": "Update a Staffing Instructor Date entry.",
"operationId": "updateStaffingInstructorDate",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Staffing Instructor Date",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"start_date": {
"description": "Start Date of the Staffing Assignment for the Instructor",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date of the Staffing Assignment for the Instructor",
"type": "string",
"format": "date"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaffingInstructor"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/student/application/questions": {
"get": {
"tags": [
"StudentApplicationQuestion"
],
"summary": "Get list of Students",
"description": "Returns list of StudentApplicationQuestion",
"operationId": "getStudentApplicationQuestion",
"responses": {
"200": {
"description": "Index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudentApplicationQuestion"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"StudentApplicationQuestion"
],
"summary": "Add a new StudentApplicationQuestion",
"description": "Add a new StudentApplicationQuestion",
"operationId": "storeStudentApplicationQuestion",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"question"
],
"properties": {
"question": {
"description": "The Question",
"type": "string"
},
"slug": {
"description": "The slug",
"type": "string"
},
"type": {
"description": "The question type",
"type": "string"
},
"designations": {
"description": "the designation ids",
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudentApplicationQuestion"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"v1/student/application/questions/{id}": {
"get": {
"tags": [
"StudentApplicationQuestion"
],
"summary": "Get StudentApplicationQuestion information by ID",
"description": "Returns StudentApplicationQuestion data",
"operationId": "getStudentApplicationQuestionById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "StudentApplicationQuestion ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudentApplicationQuestion"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"StudentApplicationQuestion"
],
"summary": "Update A StudentApplicationQuestion",
"description": "Update a StudentApplicationQuestion entry.",
"operationId": "updateStudentApplicationQuestion",
"parameters": [
{
"name": "id",
"in": "path",
"description": "StudentApplicationQuestion ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"question": {
"description": "The Question",
"type": "string"
},
"slug": {
"description": "The slug",
"type": "string"
},
"type": {
"description": "The question type",
"type": "string"
},
"designations": {
"description": "the designation ids",
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudentApplicationQuestion"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"StudentApplicationQuestion"
],
"summary": "Delete A StudentApplicationQuestion",
"description": "Delete a StudentApplicationQuestion entry.",
"operationId": "destroyStudentApplicationQuestion",
"parameters": [
{
"name": "id",
"in": "path",
"description": "StudentApplicationQuestion ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"v1/student/application/questions/addbulk": {
"post": {
"tags": [
"StudentApplicationQuestion"
],
"summary": "Add StudentApplicationQuestion",
"description": "Bulk Insert StudentApplicationQuestion data",
"operationId": "bulkAddStudentApplicationQuestion",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": [
{
"description": "StudentApplicationQuestion's ID",
"type": "integer",
"property": "id"
},
{
"description": "The text of the question",
"type": "string",
"property": "question"
},
{
"description": "The type of the question. must be valid StudentApplicationQuestionType",
"type": "string",
"property": "type"
}
],
"example": {
"data": [
{
"id": 5,
"question": "The text of the question?"
},
{
"id": 19,
"type": "student"
}
]
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkDataImport"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"v1/student/application/questions/updatebulk": {
"post": {
"tags": [
"StudentApplicationQuestion"
],
"summary": "Update Bulk StudentApplicationQuestion",
"description": "Bulk Update StudentApplicationQuestion data",
"operationId": "bulkUpdateStudentApplicationQuestion",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"id"
],
"type": "array",
"items": [
{
"description": "StudentApplicationQuestion's text",
"type": "string",
"property": "question"
},
{
"description": "StudentApplicationQuestion Id",
"type": "integer",
"property": "id"
},
{
"description": "Designation Ids (Ids must be separated by commas and enclosed by brackets: [10,20])",
"type": "string",
"property": "designations"
},
{
"description": "Valid StudentApplicationQuestionType",
"type": "string",
"property": "type"
}
],
"example": {
"data": [
{
"id": 30,
"question": "The text to update"
},
{
"id": 6,
"type": "student"
}
]
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkDataImport"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/student": {
"get": {
"tags": [
"Student"
],
"summary": "Get list of Students",
"description": "Returns list of Students",
"operationId": "getStudent",
"responses": {
"200": {
"description": "Index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Student"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Student"
],
"summary": "Add a new Student",
"description": "Add a new Student",
"operationId": "storeStudent",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"last_name",
"first_name",
"unique_id",
"email",
"dept_id",
"password"
],
"properties": {
"unique_id": {
"description": "Student Unique ID",
"type": "string"
},
"dept_id": {
"description": "Departament Id",
"type": "integer"
},
"designations": {
"description": "Designation Ids (Ids must be separated by commas and enclosed by brackets: [10,20])",
"type": "string"
},
"first_name": {
"description": "Student first name",
"type": "string"
},
"last_name": {
"description": "Student last name",
"type": "string"
},
"email": {
"description": "Email address",
"type": "string"
},
"password": {
"description": "Password",
"type": "string"
},
"phone": {
"description": "Primary Phone Number",
"type": "string"
},
"address": {
"description": "Address",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"zip": {
"description": "Zip Code",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Student"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/student/{unique_id}": {
"get": {
"tags": [
"Student"
],
"summary": "Get Student information by UniqueID",
"description": "Returns student data",
"operationId": "getstudentByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "student UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Student"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Student"
],
"summary": "Update A Student",
"description": "Update a Student entry.",
"operationId": "updateStudentByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Student Unique ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"unique_id": {
"description": "Student's unqiue ID",
"type": "string"
},
"dept_id": {
"description": "Departament Id",
"type": "integer"
},
"designations": {
"description": "Designation Ids (Ids must be separated by commas and enclosed by brackets: [10,20])",
"type": "string"
},
"first_name": {
"description": "Student first name",
"type": "string"
},
"last_name": {
"description": "Student last name",
"type": "string"
},
"email": {
"description": "Email address",
"type": "string"
},
"password": {
"description": "Student password",
"type": "string"
},
"phone": {
"description": "Primary Phone Number",
"type": "string"
},
"address": {
"description": "Address",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"zip": {
"description": "Zip Code",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Student"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Student"
],
"summary": "Delete A Student",
"description": "Delete a Student entry.",
"operationId": "destroyStudent",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "College UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/student/by-id/{id}": {
"get": {
"tags": [
"Student"
],
"summary": "Get Student information by ID",
"description": "Returns student data",
"operationId": "getstudentById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "student ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "View",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Student"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Student"
],
"summary": "Update A Student",
"description": "Update a Student entry.",
"operationId": "updateStudent",
"parameters": [
{
"name": "id",
"in": "path",
"description": "student ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"unique_id": {
"description": "Student's unqiue ID",
"type": "string"
},
"dept_id": {
"description": "Departament Id",
"type": "integer"
},
"designations": {
"description": "Designation Ids (Ids must be separated by commas and enclosed by brackets: [10,20])",
"type": "string"
},
"first_name": {
"description": "Student first name",
"type": "string"
},
"last_name": {
"description": "Student last name",
"type": "string"
},
"email": {
"description": "Email address",
"type": "string"
},
"password": {
"description": "Student password",
"type": "string"
},
"phone": {
"description": "Primary Phone Number",
"type": "string"
},
"address": {
"description": "Address",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"zip": {
"description": "Zip Code",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Student"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/student/addbulk": {
"post": {
"tags": [
"Student"
],
"summary": "Add Student",
"description": "Bulk Insert Student data",
"operationId": "bulkAddStudent",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Student UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"unique_id",
"first_name",
"last_name",
"email",
"password"
],
"type": "array",
"items": [
{
"description": "Student's unqiue ID",
"type": "string",
"property": "unique_id"
},
{
"description": "Departament Id",
"type": "integer",
"property": "dept_id"
},
{
"description": "Designation Ids (Ids must be separated by commas and enclosed by brackets: [10,20])",
"type": "string",
"property": "designations"
},
{
"description": "Student first name",
"type": "string",
"property": "first_name"
},
{
"description": "Student last name",
"type": "string",
"property": "last_name"
},
{
"description": "Email address",
"type": "string",
"property": "email"
},
{
"description": "Student password",
"type": "string",
"property": "password"
},
{
"description": "Primary Phone Number",
"type": "string",
"property": "phone"
},
{
"description": "Address",
"type": "string",
"property": "address"
},
{
"description": "City",
"type": "string",
"property": "city"
},
{
"description": "State",
"type": "string",
"property": "state"
},
{
"description": "Zip Code",
"type": "string",
"property": "zip"
}
],
"example": {
"data": [
{
"unique_id": "123",
"first_name": "first name",
"last_name": "last name",
"email": "test@email.com",
"password": "secret",
"address": "address name",
"city": "city name",
"zip": "125698",
"phone": "123654"
},
{
"unique_id": "456",
"first_name": "first name1",
"last_name": "last name2",
"email": "user@mail.net",
"password": "secret",
"address": "address name",
"city": "city name",
"zip": "125698",
"phone": "123654"
}
]
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkDataImport"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/student/updatebulk": {
"post": {
"tags": [
"Student"
],
"summary": "Add Student",
"description": "Bulk Update Student data",
"operationId": "bulkUpdateStudent",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Student UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"unique_id"
],
"type": "array",
"items": [
{
"description": "Student's unqiue ID",
"type": "string",
"property": "unique_id"
},
{
"description": "Departament Id",
"type": "integer",
"property": "dept_id"
},
{
"description": "Designation Ids (Ids must be separated by commas and enclosed by brackets: [10,20])",
"type": "string",
"property": "designations"
},
{
"description": "Student first name",
"type": "string",
"property": "first_name"
},
{
"description": "Student last name",
"type": "string",
"property": "last_name"
},
{
"description": "Email address",
"type": "string",
"property": "email"
},
{
"description": "Student password",
"type": "string",
"property": "password"
},
{
"description": "Primary Phone Number",
"type": "string",
"property": "phone"
},
{
"description": "Address",
"type": "string",
"property": "address"
},
{
"description": "City",
"type": "string",
"property": "city"
},
{
"description": "State",
"type": "string",
"property": "state"
},
{
"description": "Zip Code",
"type": "string",
"property": "zip"
}
],
"example": {
"data": [
{
"unique_id": "123",
"first_name": "first name",
"last_name": "last name",
"email": "test@email.com",
"password": "secret",
"address": "address name",
"city": "city name",
"zip": "125698",
"phone": "123654"
},
{
"unique_id": "456",
"first_name": "first name1",
"last_name": "last name2",
"email": "user@mail.net",
"password": "secret",
"address": "address name",
"city": "city name",
"zip": "125698",
"phone": "123654"
}
]
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkDataImport"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/student-course": {
"get": {
"tags": [
"StudentCourse"
],
"summary": "Get list of Student Courses",
"description": "Returns list of Student Courses",
"operationId": "getStudentCourses",
"responses": {
"200": {
"description": "index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudentCourse"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"StudentCourse"
],
"summary": "Add a new Student Course",
"description": "Add a new Student Course",
"operationId": "storeStudentCourse",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"student_id",
"faculty_supervisor_id",
"sbl_organization_id",
"course_id"
],
"properties": {
"student_id": {
"description": "Student ID - /v1/student/{unique_id} API endpoint to obtain the id",
"type": "integer"
},
"faculty_supervisor_id": {
"description": "Faculty Supervisor Id - /v1/faculty/unique_id/{unique_id} API endpoint to obtain the id",
"type": "integer"
},
"sbl_organization_id": {
"description": "Site Based Learning Organization Id - /v1/sbl/organization/{unique_id} API endpoint to obtain the id",
"type": "integer"
},
"course_id": {
"description": "Course Id - /v1/course/{unique_id} API endpoint to obtain the id",
"type": "integer"
},
"application_id": {
"description": "Application Id - optional",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudentCourse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/student-course/by-unique-id": {
"get": {
"tags": [
"StudentCourse"
],
"summary": "Get Student Course information by unique Ids. ",
"description": "Returns Student Course data",
"operationId": "getStudentCourseByUniqueId",
"parameters": [
{
"name": "student_unique_id",
"in": "query",
"description": "Student Unique ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "course_unique_id",
"in": "query",
"description": "Course Unique Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sbl_organization_unique_id",
"in": "query",
"description": "Organization Unique Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "supervisor_unique_id",
"in": "query",
"description": "Faculty Supervisor Unique Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "view",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudentCourse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"StudentCourse"
],
"summary": "Add a new Student Course",
"description": "Add a new Student Course",
"operationId": "storeStudentCourseByUniqueId",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"student_unique_id",
"faculty_supervisor_unique_id",
"sbl_organization_unique_id",
"course_unique_id"
],
"properties": {
"student_unique_id": {
"description": "Student Unique Id",
"type": "string"
},
"faculty_supervisor_unique_id": {
"description": "Faculty Supervisor Unique Id ",
"type": "string"
},
"sbl_organization_unique_id": {
"description": "Site Based Learning Organization Unique Id ",
"type": "string"
},
"course_unique_id": {
"description": "Course Unique Id ",
"type": "string"
},
"application_id": {
"description": "Application Id - optional",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudentCourse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/student-course/{id}": {
"get": {
"tags": [
"StudentCourse"
],
"summary": "Get Student Course information by Id",
"description": "Returns Student Course data",
"operationId": "getStudentCourseById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Student Course ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "view",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudentCourse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"StudentCourse"
],
"summary": "Update A Student Course",
"description": "Update a Student Course entry.",
"operationId": "updateStudentCourse",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Student Course ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [],
"properties": {
"student_id": {
"description": "Student ID - /v1/student/{unique_id} API endpoint to obtain the id",
"type": "integer"
},
"faculty_supervisor_id": {
"description": "Faculty Supervisor Id - /v1/faculty/unique_id/{unique_id} API endpoint to obtain the id",
"type": "integer"
},
"sbl_organization_id": {
"description": "Site Based Learning Organization Id - /v1/sbl/organization/{unique_id} API endpoint to obtain the id",
"type": "integer"
},
"course_id": {
"description": "Course Id - /v1/course/{unique_id} API endpoint to obtain the id",
"type": "integer"
},
"application_id": {
"description": "Application Id - optional",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudentCourse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"StudentCourse"
],
"summary": "Delete Student Course information",
"description": "Delete Student Course data",
"operationId": "destroyStudentCourse",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Student Course ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/term": {
"get": {
"tags": [
"Term"
],
"summary": "Get list of Terms",
"description": "Returns list of Terms",
"operationId": "getTerms",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Term"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"Term"
],
"summary": "Add a new Term",
"description": "Add a new Term",
"operationId": "storeTerm",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"start_date",
"end_date",
"census_date",
"year",
"unique_id"
],
"properties": {
"name": {
"description": "Term Name",
"type": "string"
},
"start_date": {
"description": "Term Start Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "Term End Date",
"type": "string",
"format": "date"
},
"census_date": {
"description": "Term Census Date",
"type": "string",
"format": "date"
},
"year": {
"description": "Term Academic Year",
"type": "string"
},
"unique_id": {
"description": "Term UniqueID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/term/{unique_id}": {
"get": {
"tags": [
"Term"
],
"summary": "Get Term information by UniqueID",
"description": "Returns Term data",
"operationId": "getByTermUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Term UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Term"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Term"
],
"summary": "Update Term information",
"description": "Update Term data",
"operationId": "updateTerm",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Term UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"start_date",
"end_date",
"census_date",
"year"
],
"properties": {
"name": {
"description": "Term Name",
"type": "string"
},
"start_date": {
"description": "Term Start Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "Term End Date",
"type": "string",
"format": "date"
},
"census_date": {
"description": "Term Census Date",
"type": "string",
"format": "date"
},
"year": {
"description": "Term Academic Year",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Term"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"Term"
],
"summary": "Delete Term information",
"description": "Delete Term data",
"operationId": "destroyTerm",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Term UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/term/by-id/{term_id}": {
"get": {
"tags": [
"Term"
],
"summary": "Get Term information by Id",
"description": "Returns Term data",
"operationId": "getByTermId",
"parameters": [
{
"name": "term_id",
"in": "path",
"description": "Term Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Term"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"Term"
],
"summary": "Update Term information",
"description": "Update Term data",
"operationId": "updateTermById",
"parameters": [
{
"name": "term_id",
"in": "path",
"description": "Term Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"start_date",
"end_date",
"census_date",
"year"
],
"properties": {
"name": {
"description": "Term Name",
"type": "string"
},
"start_date": {
"description": "Term Start Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "Term End Date",
"type": "string",
"format": "date"
},
"census_date": {
"description": "Term Census Date",
"type": "string",
"format": "date"
},
"year": {
"description": "Term Academic Year",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Term"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/time-card-entry": {
"get": {
"tags": [
"TimeCardEntry"
],
"summary": "Get list of Time Card Entries",
"description": "Returns list of Time Card Entries",
"operationId": "getTimeCardEntriesList",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeCardEntry"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"TimeCardEntry"
],
"summary": "Add new Time Card Entry",
"description": "Add new Time Card Entry",
"operationId": "createNewTimeCardEntry",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"time_card_period_id",
"logged_date",
"logged_start_time",
"logged_end_time"
],
"properties": {
"time_card_period_id": {
"description": "Time Card Period Id",
"type": "string"
},
"logged_date": {
"description": "Logged date of the entry in format YYYY-MM-DD",
"type": "string",
"format": "date"
},
"logged_start_time": {
"description": "Logged Start Time in format HH:MM AM/PM (12 hour format: 10:00 AM) ",
"type": "string"
},
"logged_end_time": {
"description": "Logged End Time in format HH:MM AM/PM (12 hour format: 1:00 PM) ",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/time-card-entry/{id}": {
"get": {
"tags": [
"TimeCardEntry"
],
"summary": "Get list of Time Card Entries by Id",
"description": "Returns list of Time Card Entries by Id",
"operationId": "getTimeCardEntriesById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job Role Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeCardEntry"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"TimeCardEntry"
],
"summary": "Update Time Card Entry",
"description": "Update Time Card Entry",
"operationId": "updateNewTimeCardEntry",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"logged_date",
"logged_start_time",
"logged_end_time"
],
"properties": {
"logged_date": {
"description": "Logged date of the entry in format YYYY-MM-DD",
"type": "string",
"format": "date"
},
"logged_start_time": {
"description": "Logged Start Time in format HH:MM AM/PM (12 hour format: 10:00 AM) ",
"type": "string"
},
"logged_end_time": {
"description": "Logged End Time in format HH:MM AM/PM (12 hour format: 1:00 PM) ",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"TimeCardEntry"
],
"summary": "Delete Time Card Entry information",
"description": "Delete Time Card Entry data",
"operationId": "deleteTimeCardEntryById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "TimeCardEntry ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/time-card-period": {
"get": {
"tags": [
"TimeCardPeriod"
],
"summary": "Get list of Time Card Periods",
"description": "Returns list of Time Card Periods",
"operationId": "getTimeCardPeriodsList",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeCardPeriod"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"TimeCardPeriod"
],
"summary": "Add a Time Card Period",
"description": "Add a Time Card Period. Time Card Period acts as the container to hold all of the time entroes for a given period of time (1 week, 2 weeks, etc).",
"operationId": "storeTimeCardPeriod",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"time_card_staffing_id"
],
"properties": {
"time_card_staffing_id": {
"description": "The Id of the Time Card Staffig to create the Time Card Period",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeCardPeriod"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/time-card-period/{id}": {
"get": {
"tags": [
"TimeCardPeriod"
],
"summary": "Get Time Card Period information by Id",
"description": "Returns Time Card Period data",
"operationId": "showTimeCardPeriodgById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Time Card Period Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeCardPeriod"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"TimeCardPeriod"
],
"summary": "Update Time Card Period information",
"description": "Update Time Card Period data",
"operationId": "updateTimeCardPeriod",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Time Card Period Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"time_card_staffing_id": {
"description": "Time Card Staffing associated with Time Card Period",
"type": "integer"
},
"start_date": {
"description": "Date Time Card Period is started",
"type": "string",
"format": "date"
},
"end_date": {
"description": "Date Time Card Period is ended",
"type": "string",
"format": "date"
},
"due_date": {
"description": "Date Time Card Period is due",
"type": "string",
"format": "date"
},
"completed_date": {
"description": "Date Time Card Period is complete",
"type": "string",
"format": "date"
},
"signed_on": {
"description": "Date Time Card Period is signed by Faculty",
"type": "string",
"format": "date"
},
"status": {
"description": "Time Card Period status",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeCardPeriod"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"TimeCardPeriod"
],
"summary": "Delete Time Card Period information",
"description": "Delete Time Card Period data",
"operationId": "deleteTimeCardPeriodById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "TimeCardPeriod ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/time-card-staffing": {
"get": {
"tags": [
"TimeCardStaffing"
],
"summary": "Get list of Time Card Staffings",
"description": "Returns list of Time Card Staffings",
"operationId": "getTimeCardStaffingList",
"parameters": [
{
"$ref": "#/components/parameters/filter[]"
}
],
"responses": {
"200": {
"description": "index",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeCardStaffing"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"TimeCardStaffing"
],
"summary": "Add a Time Card Staffing",
"description": "Add a Time Card Staffing. Time Card Staffing acts as the container to hold time card data for a specific instructor and set of periods.",
"operationId": "storeTimeCardStaffing",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"staffing_insteuctor_id"
],
"properties": {
"staffing_instrcutor_id": {
"description": "The Id of the Staffing Instructor to create the Time Card Staffing",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeCardStaffing"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/time-card-staffing/{id}": {
"get": {
"tags": [
"TimeCardStaffing"
],
"summary": "Get TIme Card Staffing information by Id",
"description": "Returns Time Card Staffing data",
"operationId": "showTimeCardStaffingById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Time Card Staffing Id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeCardStaffing"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"TimeCardStaffing"
],
"summary": "Update Time Card Staffing information",
"description": "Update Time Card Staffing data",
"operationId": "updateTimeCardStaffing",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Time Card Staffing id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"staffing_instructor_id": {
"description": "Course Id to Associate with Time Card Staffing",
"type": "integer"
},
"completed_date": {
"description": "Date Time Card Staffing is complete",
"type": "string",
"format": "date"
},
"status": {
"description": "Time Card Staffing status",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeCardStaffing"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"TimeCardStaffing"
],
"summary": "Delete Time Card Staffing information",
"description": "Delete Time Card Staffing data",
"operationId": "deleteTimeCardStaffingById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "TimeCardStaffing ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/user": {
"get": {
"tags": [
"User"
],
"summary": "Get list of Users",
"description": "Returns list of Users",
"operationId": "getUsers",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"post": {
"tags": [
"User"
],
"summary": "Add a new User",
"description": "Add a new User",
"operationId": "storeUser",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"campus",
"college",
"department",
"role",
"firstname",
"lastname",
"email",
"unique_id"
],
"properties": {
"campus": {
"description": "Campus Name or Campus unique id",
"type": "string"
},
"college": {
"description": "College Name or College unique id",
"type": "string"
},
"department": {
"description": "Department Name or Department unique id",
"type": "string"
},
"role": {
"description": "Role Name",
"type": "string"
},
"firstname": {
"description": "User First Name",
"type": "string"
},
"lastname": {
"description": "User Last Name",
"type": "string"
},
"email": {
"description": "User Email",
"type": "string"
},
"password": {
"description": "Password",
"type": "string"
},
"address": {
"description": "User Address",
"type": "string"
},
"city": {
"description": "User City",
"type": "string"
},
"state": {
"description": "User State",
"type": "string"
},
"zip": {
"description": "User Zipcode",
"type": "string"
},
"phone": {
"description": "User Phone Number",
"type": "string"
},
"unique_id": {
"description": "User UniqueID",
"type": "string"
},
"employee_id": {
"description": "User Employee Id",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/user/{unique_id}": {
"get": {
"tags": [
"User"
],
"summary": "Get User information by UniqueID",
"description": "Returns User data",
"operationId": "getByUserUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "User UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"User"
],
"summary": "Update A User",
"description": "Update a User entry.",
"operationId": "updateUser",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "User UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"campus",
"college",
"department",
"role",
"firstname",
"lastname",
"email"
],
"properties": {
"campus": {
"description": "Campus Name or Campus unique id",
"type": "string"
},
"college": {
"description": "College Name or College unique id",
"type": "string"
},
"department": {
"description": "Department Name or Department unique id",
"type": "string"
},
"role": {
"description": "Role Name",
"type": "string"
},
"firstname": {
"description": "User First Name",
"type": "string"
},
"lastname": {
"description": "User Last Name",
"type": "string"
},
"email": {
"description": "User Email",
"type": "string"
},
"password": {
"description": "Password",
"type": "string"
},
"address": {
"description": "User Address",
"type": "string"
},
"city": {
"description": "User City",
"type": "string"
},
"state": {
"description": "User State",
"type": "string"
},
"zip": {
"description": "User Zipcode",
"type": "string"
},
"phone": {
"description": "User Phone Number",
"type": "string"
},
"unique_id": {
"description": "User UniqueID",
"type": "string"
},
"employee_id": {
"description": "Employee Id",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"User"
],
"summary": "Delete User information",
"description": "Delete User data",
"operationId": "destroyUser",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "User UniqueID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/user/{id}": {
"get": {
"tags": [
"User"
],
"summary": "Get User information by Id",
"description": "Returns User data",
"operationId": "getByUserId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "User Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
},
"put": {
"tags": [
"User"
],
"summary": "Update A User By Id",
"description": "Update a User entry.",
"operationId": "updateUserById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "User Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [],
"properties": {
"campus": {
"description": "Campus unique id",
"type": "string"
},
"college": {
"description": "College unique id",
"type": "string"
},
"department": {
"description": "Department unique id",
"type": "string"
},
"role": {
"description": "Role Name",
"type": "string"
},
"firstname": {
"description": "User First Name",
"type": "string"
},
"lastname": {
"description": "User Last Name",
"type": "string"
},
"email": {
"description": "User Email",
"type": "string"
},
"password": {
"description": "Password",
"type": "string"
},
"address": {
"description": "User Address",
"type": "string"
},
"city": {
"description": "User City",
"type": "string"
},
"state": {
"description": "User State",
"type": "string"
},
"zip": {
"description": "User Zipcode",
"type": "string"
},
"phone": {
"description": "User Phone Number",
"type": "string"
},
"unique_id": {
"description": "User UniqueID",
"type": "string"
},
"employee_id": {
"description": "Employee Id",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
},
"delete": {
"tags": [
"User"
],
"summary": "Delete User information",
"description": "Delete User data",
"operationId": "destroyUserById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "User Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"passport": [
"write:projects",
"read:projects"
]
}
]
}
},
"/v1/workload-aggregate/faculty-by-unique-id/{facultyUniqueId}": {
"get": {
"tags": [
"FacultyWorkloadAggregate"
],
"summary": "Get Faculty workload aggregate by unique id",
"description": "Returns Faculty workload aggregate data",
"operationId": "getFacultyWorkloadAggregateByUniqueId",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Faculty Unique ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "start_date",
"in": "path",
"description": "start date to get workload",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "end_date",
"in": "path",
"description": "end date to get workload",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "view",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacultyWorkloadAggregate"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/workload-aggregate/faculty-by-id/{facultyId}": {
"get": {
"tags": [
"FacultyWorkloadAggregate"
],
"summary": "Get Faculty workload aggregate by id",
"description": "Returns Faculty workload aggregate data",
"operationId": "getFacultyWorkloadAggregateById",
"parameters": [
{
"name": "unique_id",
"in": "path",
"description": "Faculty ID",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "start_date",
"in": "path",
"description": "start date to get workload",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "end_date",
"in": "path",
"description": "end date to get workload",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "view",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacultyWorkloadAggregate"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
},
"/v1/workload-aggregate/get-all": {
"get": {
"tags": [
"FacultyWorkloadAggregate"
],
"summary": "Get list of All Faculty Workload",
"description": "Returns list of Faculty Workload",
"operationId": "getAllFacultyWorkload",
"parameters": [
{
"name": "start_date",
"in": "path",
"description": "start date to get workload",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "end_date",
"in": "path",
"description": "end date to get workload",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacultyWorkloadAggregate"
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"passport": [
"read:projects"
]
}
]
}
}
},
"components": {
"schemas": {
"FacultyWorkload": {
"type": "object",
"allOf": [
{
"required": [
"faculty_name",
"faculty_unique_id",
"total_workload",
"total_converted_workload",
"original_workload",
"start_date",
"end_date",
"staffings",
"courses"
],
"properties": {
"faculty_name": {
"description": "Faculty Name",
"type": "string"
},
"faculty_unique_id": {
"description": "Faculty UniqueId",
"type": "string"
},
"total_workload": {
"description": "Total Workload",
"type": "number"
},
"total_converted_workload": {
"description": "Total Converted Workload",
"type": "number"
},
"original_workload": {
"description": "Original Workload",
"type": "number"
},
"start_date": {
"description": "Start Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date",
"type": "string",
"format": "date"
},
"staffings": {
"description": "Staffings",
"type": "array",
"items": {
"$ref": "#/components/schemas/Staffing"
}
},
"courses": {
"description": "Courses",
"type": "array",
"items": {
"$ref": "#/components/schemas/Course"
}
}
},
"type": "object"
}
]
},
"Activity": {
"description": "Activity resource. Default required fields: faculty_unique_id, title_of_activity, type, subtype_id, start_date. Note: Institutions may configure additional required fields via APL configuration.",
"type": "object",
"allOf": [
{
"required": [
"faculty_unique_id",
"title_of_activity",
"type",
"subtype_id",
"start_date"
],
"properties": {
"id": {
"description": "Internal activity ID",
"type": "integer"
},
"faculty_unique_id": {
"description": "Faculty unique ID associated with the activity. How faculty and activity are linked",
"type": "string"
},
"title_of_activity": {
"description": "Title of the activity",
"type": "string"
},
"type": {
"description": "Activity type name (e.g., Teaching, Scholarship, Service)",
"type": "string"
},
"type_id": {
"description": "Activity type ID",
"type": "integer"
},
"sub_type": {
"description": "Subtype name of the activity",
"type": "string"
},
"subtype_id": {
"description": "Subtype ID (always required)",
"type": "integer"
},
"tertiary_type": {
"description": "Tertiary Type name of the activity",
"type": "string"
},
"tertiarytype_id": {
"description": "Tertiary Type ID",
"type": "integer"
},
"count": {
"description": "Count",
"type": "integer"
},
"hours": {
"description": "Hours spent on the activity",
"type": "number",
"format": "float"
},
"dollars": {
"description": "Dollar amount associated with the activity entry",
"type": "number",
"format": "float"
},
"start_date": {
"description": "Start Date of the activity (always required)",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date of the activity",
"type": "string",
"format": "date"
},
"academic_year": {
"description": "Academic Year the activity took place in. Used for reporting purposes",
"type": "string"
},
"unique_id": {
"description": "Unique ID associated with the activity entry",
"type": "string"
},
"description": {
"description": "Description of the activity",
"type": "string"
},
"contributors": {
"description": "Contributors associated with the activity entry",
"type": "string"
},
"link": {
"description": "Link associated with the activity",
"type": "string"
},
"provider": {
"description": "Activity provider",
"type": "string"
},
"advisees": {
"description": "Number of advisees served",
"type": "integer"
},
"grantor": {
"description": "Activity grantor",
"type": "string"
},
"role": {
"description": "Role of the faculty for a particular activity",
"type": "string"
},
"journal_name": {
"description": "Journal name",
"type": "string"
},
"acceptance_rate": {
"description": "Acceptance rate for scholarship activities",
"type": "string"
},
"circulation": {
"description": "The circulation of the scholarship activity logged",
"type": "string"
},
"selection_method": {
"description": "The selection method of the scholarship activity logged",
"type": "string"
},
"citation": {
"description": "Citation number for scholarship activities",
"type": "string"
},
"tertiary_fields": {
"description": "Dynamic tertiary fields stored as key-value pairs. Available fields depend on activity type and are defined in activity_types_fields table.",
"type": "object"
},
"created": {
"description": "Date the activity was created",
"type": "string",
"format": "date"
}
},
"type": "object"
}
]
},
"ActivityStatus": {
"type": "object",
"allOf": [
{
"required": [
"faculty_unique_id",
"activity_unique_id",
"status",
"year"
],
"properties": {
"activity_unique_id": {
"description": "Activity Unique ID",
"type": "string"
},
"faculty_unique_id": {
"description": "Faculty Unique ID",
"type": "string"
},
"status": {
"description": "Activity Status(Values for Status can be only one of the following: Pending, InProgress, Accepted, Submitted, Revision, Completed)",
"type": "string",
"default": "Pending"
},
"year": {
"description": "Academic Year",
"type": "string"
},
"comments": {
"description": "Comments",
"type": "string"
},
"status_date": {
"description": "Status Date",
"type": "string",
"format": "date"
},
"created": {
"description": "Created Date",
"type": "string",
"format": "date"
},
"college": {
"$ref": "#/components/schemas/College"
},
"department": {
"$ref": "#/components/schemas/Department"
},
"campus": {
"$ref": "#/components/schemas/Campus"
}
},
"type": "object"
}
]
},
"Adjunct": {
"type": "object",
"allOf": [
{
"required": [
"unique_id"
],
"properties": {
"id": {
"description": "Faculty Id",
"type": "integer"
},
"supervisor_id": {
"description": "Faculty Supervisor Id",
"type": "integer"
},
"pronoun_id": {
"description": "Pronoun Id",
"type": "integer"
},
"firstname": {
"description": "Faculty first name",
"type": "string"
},
"lastname": {
"description": "Faculty last name",
"type": "string"
},
"certification": {
"description": "Certification",
"type": "string"
},
"email": {
"description": "Faculty Email",
"type": "string"
},
"address": {
"description": "Address",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"zip": {
"description": "Zip",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
},
"active": {
"description": "Active",
"type": "integer"
},
"deleted": {
"description": "Deleted",
"type": "boolean"
},
"referral_id": {
"description": "Referral Id",
"type": "integer"
},
"resetpwd": {
"description": "Reset Password",
"type": "integer"
},
"created": {
"description": "Created",
"type": "string",
"format": "date-time"
},
"refer_status": {
"description": "Refer Status",
"type": "integer"
},
"diversity": {
"description": "Diversity",
"type": "integer"
},
"oldinfo": {
"description": "Oldinfo",
"type": "string"
},
"source": {
"description": "Source",
"type": "string"
},
"fbtoken": {
"description": "fbtoken",
"type": "string"
},
"fbid": {
"description": "fbid",
"type": "string"
},
"reset_pwd": {
"description": "reset_pwd",
"type": "string"
},
"taughthigher": {
"description": "Taught Higher",
"type": "integer"
},
"campus_id": {
"description": "Campus Id",
"type": "integer"
},
"college_id": {
"description": "College Id",
"type": "integer"
},
"dept_id": {
"description": "Department Id",
"type": "integer"
},
"campaign_id": {
"description": "Campaign Id",
"type": "integer"
},
"updated": {
"description": "Last Updated",
"type": "string",
"format": "date-time"
},
"wizard": {
"description": "Wizard",
"type": "integer"
},
"code": {
"description": "Code",
"type": "string"
},
"identifier": {
"description": "Identifier",
"type": "string"
},
"email2": {
"description": "Email 2",
"type": "string"
},
"mobilephone": {
"description": "Mobile Phone",
"type": "string"
},
"homephone": {
"description": "Home Phone",
"type": "string"
},
"date_transcript_verified": {
"description": "Date Transcript Verified",
"type": "string",
"format": "date-time"
},
"unique_id": {
"description": "Unique Id",
"type": "string"
},
"start_date": {
"description": "Start Date",
"type": "string",
"format": "date-time"
},
"end_date": {
"description": "End Date",
"type": "string",
"format": "date"
},
"gender_id": {
"description": "Gender Id",
"type": "integer"
},
"race_id": {
"description": "Race Id",
"type": "integer"
},
"ethnicity_id": {
"description": "Ethnicity Id",
"type": "integer"
},
"other_code": {
"description": "Other Code",
"type": "string"
},
"cip_code": {
"description": "CIP Code",
"type": "string"
},
"address2": {
"description": "Address 2",
"type": "string"
},
"city2": {
"description": "City 2",
"type": "string"
},
"state2": {
"description": "State 2",
"type": "string"
},
"zip2": {
"description": "Zip 2",
"type": "string"
},
"tenure_date": {
"description": "Tenure Date",
"type": "string",
"format": "date"
},
"tenure_status": {
"description": "Tenure Status",
"type": "integer"
},
"sso_email": {
"description": "SSO Email",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"country2": {
"description": "Country 2",
"type": "string"
},
"middlename": {
"description": "Middlename",
"type": "string"
},
"dob": {
"description": "D.O.B",
"type": "string",
"format": "date"
},
"us_citizen": {
"description": "US Citizen",
"type": "integer"
},
"languages": {
"description": "Languages",
"type": "object",
"example": [
"english",
"spanish"
]
},
"prefix": {
"description": "Prefix",
"type": "string"
},
"suffix": {
"description": "Suffix",
"type": "string"
},
"defaultyear": {
"description": "Faculty Logged in Academic Year",
"type": "string"
},
"email3": {
"description": "Email 3",
"type": "string"
},
"signature_data": {
"description": "Faculty Signature ",
"type": "string"
},
"payroll_id": {
"description": "Payroll Id",
"type": "string"
},
"preferred_name": {
"description": "Preferred Name",
"type": "string"
},
"pre_tenure": {
"description": "Pre Tenure",
"type": "string",
"format": "date"
},
"post_tenure": {
"description": "Post Tenure",
"type": "string",
"format": "date"
},
"tenure_eligible": {
"description": "Tenure Eligible",
"type": "string",
"format": "date"
},
"promotion": {
"description": "Promotion",
"type": "string",
"format": "date"
},
"graduate_faculty_status": {
"description": "Graduate Faculty Status",
"type": "string",
"format": "date"
},
"historical_credits": {
"description": "Historical Credits",
"type": "number"
},
"supervisor_name": {
"description": "Supervisor Name",
"type": "string"
},
"employee_id": {
"description": "Employee ID",
"type": "string"
},
"fte_value": {
"description": "Tracking FTE Data",
"type": "string"
}
},
"type": "object"
}
]
},
"Attribute": {
"type": "object",
"allOf": [
{
"required": [
"faculty_unique_id",
"academic_year"
],
"properties": {
"faculty_unique_id": {
"description": "Faculty unique ID. Ties attribute to faculty",
"type": "string"
},
"faculty_id": {
"description": "Faculty Id. Ties attribute to faculty",
"type": "integer"
},
"academic_year": {
"description": "Academic Year attribute applies to",
"type": "string"
},
"rank": {
"description": "Faculty rank. Values are configurable in the faculty attributes configuration",
"type": "string"
},
"track": {
"description": "Faculty track. Values are configurable in the faculty attributes configuration",
"type": "integer"
},
"track_name": {
"description": "Faculty track. Values are configurable in the faculty attributes configuration",
"type": "string"
},
"load": {
"description": "Faculty load class. Values are configurable in the faculty attributes configuration",
"type": "integer"
},
"load_name": {
"description": "Faculty load class. Values are configurable in the faculty attributes configuration",
"type": "string"
},
"loadstatus": {
"description": "Faculty load status. Values are configurable in the faculty attributes configuration",
"type": "integer"
},
"loadstatus_name": {
"description": "Faculty load status. Values are configurable in the faculty attributes configuration",
"type": "string"
},
"compensation_mode": {
"description": "Faculty compensation mode. Available values include:",
"type": "string"
},
"qualification_group": {
"description": "AACSB qualification groups for reporting",
"type": "integer"
},
"qualification_group_name": {
"description": "AACSB qualification groups for reporting",
"type": "string"
},
"effective_date": {
"description": "Effective Date",
"type": "string",
"format": "date"
},
"compensation_faculty_unique_id": {
"description": "Attribute compensation faculty unique ID",
"type": "string"
},
"faculty_distinction_unique_id": {
"description": "Attribute faculty distinction unique ID",
"type": "string"
},
"affiliation_unique_id": {
"description": "Affiliation unique ID",
"type": "string"
},
"affiliation_name": {
"description": "Affiliation name",
"type": "string"
},
"attribute": {
"$ref": "#/components/schemas/Attribute"
}
},
"type": "object"
}
]
},
"AttributeLoad": {
"type": "object",
"allOf": [
{
"required": [
"unique_id",
"name"
],
"properties": {
"id": {
"description": "Id",
"type": "integer"
},
"name": {
"description": "Name",
"type": "string"
},
"unique_id": {
"description": "UniqueId",
"type": "string"
},
"class id": {
"description": "Class Id",
"type": "integer"
},
"threshold": {
"description": "threshold",
"type": "integer"
}
},
"type": "object"
}
]
},
"AttributeRank": {
"type": "object",
"allOf": [
{
"required": [
"unique_id",
"name"
],
"properties": {
"id": {
"description": "Id",
"type": "integer"
},
"name": {
"description": "Name",
"type": "string"
},
"unique_id": {
"description": "UniqueId",
"type": "string"
}
},
"type": "object"
}
]
},
"AutoStaffingJob": {
"type": "object",
"allOf": [
{
"required": [
"id",
"university_id",
"name",
"status",
"created_at",
"updated_at"
],
"properties": {
"id": {
"description": "Auto Staffing Job ID",
"type": "integer"
},
"university_id": {
"description": "University ID",
"type": "integer"
},
"created_by_user_id": {
"description": "User ID who created the job",
"type": "integer"
},
"name": {
"description": "Job name",
"type": "string"
},
"status": {
"description": "Job status",
"type": "string",
"enum": [
"draft",
"pending",
"completed",
"cancelled"
]
},
"campus_ids": {
"description": "Array of campus IDs",
"type": "array",
"items": {
"type": "integer"
}
},
"college_ids": {
"description": "Array of college IDs",
"type": "array",
"items": {
"type": "integer"
}
},
"dept_ids": {
"description": "Array of department IDs",
"type": "array",
"items": {
"type": "integer"
}
},
"term_ids": {
"description": "Array of term IDs",
"type": "array",
"items": {
"type": "integer"
}
},
"academic_year": {
"description": "Academic year",
"type": "string"
},
"ranks": {
"description": "Array of rank criteria",
"type": "array",
"items": {
"type": "string"
}
},
"tracks": {
"description": "Array of track criteria",
"type": "array",
"items": {
"type": "string"
}
},
"loads": {
"description": "Array of load criteria",
"type": "array",
"items": {
"type": "string"
}
},
"affiliations": {
"description": "Array of affiliation criteria",
"type": "array",
"items": {
"type": "string"
}
},
"designations": {
"description": "Array of designation criteria",
"type": "array",
"items": {
"type": "string"
}
},
"distinctions": {
"description": "Array of distinction criteria",
"type": "array",
"items": {
"type": "string"
}
},
"taught_before": {
"description": "Whether faculty must have taught before",
"type": "boolean"
},
"instruction_role": {
"description": "Instruction role ID",
"type": "integer"
},
"course_start_date_within_days": {
"description": "Course start date within days",
"type": "integer"
},
"date_to_execute": {
"description": "Date to execute the job",
"type": "string",
"format": "date-time"
},
"executed_at": {
"description": "Date when job was executed",
"type": "string",
"format": "date-time"
},
"send_summary_email": {
"description": "Whether to send summary email",
"type": "boolean"
},
"created_at": {
"description": "Creation timestamp",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "Last update timestamp",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "Deletion timestamp",
"type": "string",
"format": "date-time"
},
"course_unique_ids": {
"description": "Array of course unique IDs associated with this job",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
}
]
},
"AutoStaffingJobDetail": {
"type": "object",
"allOf": [
{
"required": [
"id",
"bulk_auto_staffing_job_id",
"course_id",
"status",
"created_at",
"updated_at"
],
"properties": {
"id": {
"description": "Auto Staffing Job Detail ID",
"type": "integer"
},
"bulk_auto_staffing_job_id": {
"description": "Auto Staffing Job ID",
"type": "integer"
},
"adjunct_id": {
"description": "Adjunct ID",
"type": "integer"
},
"course_id": {
"description": "Course ID",
"type": "integer"
},
"faculty_staffing_id": {
"description": "Faculty Staffing ID",
"type": "integer"
},
"staffing_id": {
"description": "Staffing ID",
"type": "integer"
},
"status": {
"description": "Detail status",
"type": "string",
"enum": [
"pending",
"matched",
"failed",
"cancelled"
]
},
"status_details": {
"description": "Status details",
"type": "string"
},
"workload_value": {
"description": "Workload value",
"type": "number",
"format": "float"
},
"created_at": {
"description": "Creation timestamp",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "Last update timestamp",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "Deletion timestamp",
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
]
},
"BulkDataImport": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"description": "BulkDataImport Id",
"type": "integer"
},
"import_status": {
"description": "Import Status",
"type": "string"
},
"import_type": {
"description": "Import Type",
"type": "string"
},
"data_object": {
"description": "Data Object",
"type": "string"
},
"objects_imported": {
"description": "Objects Imported",
"type": "integer"
},
"objects_updated": {
"description": "Objects Updated",
"type": "integer"
},
"objects_skipped": {
"description": "Objects Skipped",
"type": "integer"
},
"message": {
"description": "Message",
"type": "string"
},
"completed_at": {
"description": "Task completion",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "last updated",
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
]
},
"Campus": {
"type": "object",
"allOf": [
{
"required": [
"unique_id",
"name"
],
"properties": {
"id": {
"description": "Campus Id",
"type": "integer"
},
"university_id": {
"description": "University Id",
"type": "integer"
},
"name": {
"description": "Campus Name",
"type": "string"
},
"unique_id": {
"description": "Campus UniqueId",
"type": "string"
}
},
"type": "object"
}
]
},
"College": {
"type": "object",
"allOf": [
{
"required": [
"name",
"unique_id"
],
"properties": {
"id": {
"description": "College Id",
"type": "integer"
},
"name": {
"description": "College name. Values are configurable in the College configuration",
"type": "string"
},
"unique_id": {
"description": "Campus unique ID",
"type": "string"
},
"college": {
"$ref": "#/components/schemas/College"
}
},
"type": "object"
}
]
},
"Contract": {
"type": "object",
"allOf": [
{
"required": [
"unique_id",
"name"
],
"properties": {
"id": {
"description": "Contract Id",
"type": "integer"
},
"university_id": {
"description": "University Id",
"type": "integer"
},
"adjunct_id": {
"description": "Adjunct ID",
"type": "integer"
},
"name": {
"description": "Contract Name",
"type": "string"
},
"unique_id": {
"description": "Contract Unique ID",
"type": "string"
},
"course_id": {
"description": "Course ID",
"type": "integer"
},
"course_path_id": {
"description": "Course Path ID",
"type": "integer"
},
"contract_type_id": {
"description": "Contract Type ID",
"type": "integer"
},
"contract_template_id": {
"description": "Contract Template ID",
"type": "integer"
},
"contract_status_id": {
"description": "Contract Status ID",
"type": "integer"
},
"faculty_compensation": {
"description": "Faculty Compensation",
"type": "number"
},
"expiration_date": {
"description": "Expiration Date",
"type": "string",
"format": "date-time"
},
"sent_date": {
"description": "Sent Date",
"type": "string",
"format": "date-time"
},
"executed_date": {
"description": "Executed date",
"type": "string",
"format": "date-time"
},
"cancelled_date": {
"description": "Cancelled Date",
"type": "string",
"format": "date-time"
},
"remote_file_path": {
"description": "Remote file path",
"type": "string"
},
"term_id": {
"description": "Term ID",
"type": "integer"
},
"additional": {
"description": "Array of additional custom data points",
"type": "array",
"items": {
"type": "string",
"example": "additonal1"
},
"collectionFormat": "multi"
},
"created": {
"description": "Created",
"type": "string",
"format": "date-time"
},
"updated": {
"description": "Updated",
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
]
},
"ContractTemplate": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"description": "Contract Id",
"type": "integer"
},
"university_id": {
"description": "University Id",
"type": "integer"
},
"name": {
"description": "Contract Template Name",
"type": "string"
},
"unique_id": {
"description": "Contract UniqueId",
"type": "string"
},
"contract_type_id": {
"description": "Contract Type ID",
"type": "integer"
},
"address": {
"description": "Address",
"type": "integer"
},
"include_representative_signature": {
"description": "Include Representative Signature",
"type": "integer"
},
"created": {
"description": "Created at",
"type": "string",
"format": "date-time"
},
"updated": {
"description": "Updated at",
"type": "string",
"format": "date-time"
},
"template_body": {
"description": "Template Body",
"type": "string"
},
"notification_email": {
"description": "Notification Email",
"type": "string"
},
"legal_language": {
"description": "Legal Language",
"type": "string"
},
"require_signature": {
"description": "Require Signature",
"type": "integer"
},
"digitally_accepted": {
"description": "Digitally accepted",
"type": "integer"
},
"information_only": {
"description": "Information only",
"type": "integer"
}
},
"type": "object"
}
]
},
"Course": {
"type": "object",
"allOf": [
{
"required": [
"unique_id",
"campus",
"college",
"department",
"name",
"number",
"section",
"term_name",
"academic_year"
],
"properties": {
"id": {
"description": "Course Id",
"type": "integer"
},
"unique_id": {
"description": "Course UniqueId",
"type": "string"
},
"status": {
"description": "Status of the course: ACCEPTED = 2, CANCELLED = 4, INCOMPLETE = 0",
"type": "integer"
},
"compensation_course_id": {
"description": "Compensation Course Id",
"type": "string"
},
"compensation_course_unique_id": {
"description": "Course Compensation Unique Id",
"type": "string"
},
"workload_course_id": {
"description": "Workload Course Id",
"type": "string"
},
"workload_course_unique_id": {
"description": "Workload Enrollment Modifier Unique Id",
"type": "string"
},
"campus": {
"$ref": "#/components/schemas/Campus"
},
"number": {
"description": "Number",
"type": "string"
},
"college": {
"$ref": "#/components/schemas/College"
},
"department": {
"$ref": "#/components/schemas/Department"
},
"name": {
"description": "Name",
"type": "string"
},
"section": {
"description": "Section",
"type": "string"
},
"term": {
"$ref": "#/components/schemas/Term"
},
"academic_year": {
"description": "Academic",
"type": "string"
},
"compensation": {
"description": "Compensation",
"type": "decimal"
},
"crn": {
"description": "Custom Reference Number",
"type": "string"
},
"deadline": {
"description": "Deadline",
"type": "string"
},
"delivery_method": {
"description": "DeliveryMethod",
"type": "array",
"items": {
"type": "string"
}
},
"credithours": {
"description": "Credits",
"type": "integer"
},
"workload_value": {
"description": "Workload Value",
"type": "integer"
},
"enrollment": {
"description": "Enrollment",
"type": "integer"
},
"enrollment_capacity": {
"description": "Enrollment Capacity",
"type": "integer"
},
"location": {
"description": "Location",
"type": "string"
},
"days_times": {
"description": "Days and Times for Course",
"type": "object",
"example": {
"tuesday": {
"start": "11:09pm",
"end": "02:04pm"
},
"monday": {
"start": "03:04pm",
"end": "10:09pm"
}
}
},
"timezone": {
"description": "Time Zone",
"type": "string"
},
"start_date": {
"description": "Start Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date",
"type": "string",
"format": "date"
},
"grading_week": {
"description": "Grading Week",
"type": "number"
},
"student_credits": {
"description": "Student Credit Hour",
"type": "integer"
},
"prep_grading": {
"description": "Prep week workload to be applied. 1 = Yes, 0 = No",
"type": "integer"
},
"prep_grading_start_date": {
"description": "Prep Grading Start Date",
"type": "string",
"format": "date"
},
"prep_grading_end_date": {
"description": "Prep Grading End Date",
"type": "string",
"format": "date"
},
"prep_grading_workload": {
"description": "Prep Grading Workload Value",
"type": "integer"
},
"distinction": {
"description": "Course Distinction",
"type": "string"
},
"designations": {
"description": "Course Designations",
"type": "object"
},
"description": {
"description": "Course Description",
"type": "string"
},
"site_based_learning": {
"description": "Site Based Learning to be applied",
"type": "integer"
},
"course_ignore_days_off": {
"description": "Ignore Days Off Status (Value can be only one of the following: 0,1.)",
"type": "integer"
},
"course_path": {
"description": "Course Path",
"type": "string"
},
"course_status": {
"description": "Course status. (Value can be only one of the following: open, closed)",
"type": "string"
},
"course_faculty_auto_staff_code": {
"description": "Course Faculty Auto Staff Code",
"type": "string"
},
"deleted": {
"description": "boolean object was deleted",
"type": "integer"
},
"created": {
"description": "datetime object was created",
"type": "string",
"format": "date-time"
},
"updated": {
"description": "datetime object was last updated",
"type": "string",
"format": "date-time"
},
"staffings": {
"description": "if `show_staffings=1 is set in query parameter show staffing records`",
"type": "object",
"example": [
{
"id": 2,
"course_id": 105182,
"university_id": 1,
"college_id": 3,
"campus_id": 1,
"dept_id": 4,
"deleted": 0,
"created": "2021-01-25T03:48:18.000000Z",
"status": 2,
"deadline": null,
"offering": 0,
"staffing_user_id": 7128,
"status_reason": null,
"updated": "2021-04-09T14:23:05.000000Z",
"unique_id": "",
"faculty_dates": []
}
]
}
},
"type": "object"
}
]
},
"CourseCompensation": {
"type": "object",
"allOf": [
{
"required": [
"name",
"unique_id"
],
"properties": {
"id": {
"description": "Course Compensation Id",
"type": "integer"
},
"unique_id": {
"description": "Course Compensation Unique Id",
"type": "string"
},
"name": {
"description": "Course Compensation name",
"type": "string"
},
"course_compensation_type_id": {
"description": "Course Compensation Type",
"type": "integer"
},
"designation_id": {
"description": "Designation Id",
"type": "integer"
},
"designation_value": {
"description": "Designation Value",
"type": "number",
"format": "float"
},
"designation_modifier": {
"description": "Designation Modifier",
"type": "integer"
},
"primary_instructor": {
"description": "Primary Instructor",
"type": "integer"
},
"primary_instructor_value": {
"description": "Primary Instructor Value",
"type": "number",
"format": "float"
},
"primary_instructor_modifier": {
"description": "Primary Instructor Modifier",
"type": "integer"
},
"intruction_role_id": {
"description": "Intruction Role Id",
"type": "integer"
},
"intruction_role_value": {
"description": "Intruction Role Value",
"type": "number",
"format": "float"
},
"intruction_role_modifier": {
"description": "Intruction Role Modifier",
"type": "integer"
},
"distinction_id": {
"description": "Distinction Id",
"type": "integer"
},
"distinction_value": {
"description": "Distinction Value",
"type": "number",
"format": "float"
},
"distinction_modifier": {
"description": "Distinction Modifier",
"type": "integer"
},
"courses_previously_taught": {
"description": "Courses Previously Taught",
"type": "integer"
},
"courses_previously_taught_value": {
"description": "Courses Previously Taught Value",
"type": "number",
"format": "float"
},
"courses_previously_taught_modifier": {
"description": "Courses Previously Taught Modifier",
"type": "integer"
},
"prior_experience": {
"description": "Prior Experience",
"type": "integer"
},
"prior_experience_value": {
"description": "Prior Experience Value",
"type": "number",
"format": "float"
},
"prior_experience_modifier": {
"description": "Prior Experience Modifier",
"type": "integer"
},
"term_id": {
"description": "Term Id",
"type": "integer"
},
"term_value": {
"description": "Term Value",
"type": "number",
"format": "float"
},
"term_modifier": {
"description": "Term Modifier",
"type": "integer"
},
"total_terms": {
"description": "Total Terms",
"type": "integer"
},
"total_terms_value": {
"description": "Total Terms Value",
"type": "number",
"format": "float"
},
"total_terms_modifier": {
"description": "Total Terms Modifier",
"type": "integer"
},
"use_enrollment_thresholds": {
"description": "Use Enrollment Thresholds",
"type": "integer"
},
"threshold_number": {
"description": "Threshold Number",
"type": "object"
}
},
"type": "object"
}
]
},
"CourseOutcome": {
"type": "object",
"allOf": [
{
"required": [
"course_unique_id"
],
"properties": {
"course_unique_id": {
"description": "Course unique ID. Ties course outcomes to course",
"type": "string"
},
"average_attendance": {
"description": "Average course attendance ",
"type": "number",
"format": "float"
},
"engagement_score": {
"description": "Engagmenet score - flexible field to import course outcomes data",
"type": "number",
"format": "float"
},
"average_interactions": {
"description": "Average interactions - flexible field to import course outcomes data",
"type": "number",
"format": "float"
},
"a": {
"description": "Number of A's recieved",
"type": "number",
"format": "float"
},
"b": {
"description": "Number of B's recieved",
"type": "number",
"format": "float"
},
"c": {
"description": "Number of C's recieved",
"type": "number",
"format": "float"
},
"d": {
"description": "Number of D's received",
"type": "number",
"format": "float"
},
"f": {
"description": "Number of F's received",
"type": "number",
"format": "float"
},
"s": {
"description": "Number of S's recieved (satisfactory)",
"type": "number",
"format": "float"
},
"u": {
"description": "Number of U's received (unsatifactory)",
"type": "number",
"format": "float"
},
"w": {
"description": "Number of W's recieved (withdrew)",
"type": "number",
"format": "float"
},
"wf": {
"description": "Number of WF's recieved (withdrawn fail)",
"type": "number",
"format": "float"
},
"i": {
"description": "Number of I's received (incomplete)",
"type": "number",
"format": "float"
},
"gpa": {
"description": "Avergae GPA",
"type": "number",
"format": "float"
},
"mean": {
"description": "Arbitrary data field for a Student Mean Score",
"type": "number",
"format": "float"
},
"faculty_unique_id": {
"description": "Faculty staffed to course - use faculty unique ID",
"type": "string"
},
"student_eval_score": {
"description": "Mean student evaluation score related to course",
"type": "number",
"format": "float"
},
"course_score": {
"description": "Course score. Flexible field to import a score/number related to the course",
"type": "number",
"format": "float"
},
"course-outcome": {
"$ref": "#/components/schemas/CourseOutcome"
},
"campus": {
"$ref": "#/components/schemas/Campus"
},
"college": {
"$ref": "#/components/schemas/College"
},
"department": {
"$ref": "#/components/schemas/Department"
},
"course": {
"$ref": "#/components/schemas/Course"
}
},
"type": "object"
}
]
},
"CourseQualification": {
"type": "object",
"allOf": [
{
"required": [
"coursename",
"coursenum"
],
"properties": {
"id": {
"description": "Course Qualification Id",
"type": "integer"
},
"coursename": {
"description": "Coursename",
"type": "string"
},
"coursenum": {
"description": "Coursenum",
"type": "string"
},
"original_assign_id": {
"description": "Original assign id",
"type": "integer"
},
"original_course_id": {
"description": "Original course id",
"type": "integer"
},
"adjunct_id": {
"description": "Adjunct id",
"type": "integer"
},
"coursekey": {
"description": "Course key",
"type": "string"
},
"university_id": {
"description": "University id",
"type": "integer"
},
"college_id": {
"description": "College id",
"type": "integer"
},
"college": {
"$ref": "#/components/schemas/College"
}
},
"type": "object"
}
]
},
"CourseReflection": {
"type": "object",
"allOf": [
{
"required": [
"course_unique_id",
"faculty_unique_id"
],
"properties": {
"id": {
"description": "Reflection Id",
"type": "integer"
},
"type": {
"description": "Type (Values for Type can be only one of the following: Pedagogy/Andragogy, Course Content, Experiential/Application, Student Evaluations Other, General Reflections, Teaching Effectiveness, Innovations And Advising, Teaching And Mentoring, Pedagogical Innovation.",
"type": "string"
},
"title": {
"description": "Title",
"type": "string"
},
"reflection": {
"description": "Reflection",
"type": "string"
},
"faculty": {
"$ref": "#/components/schemas/Faculty"
},
"course": {
"$ref": "#/components/schemas/Course"
}
},
"type": "object"
}
]
},
"CourseText": {
"type": "object",
"allOf": [
{
"required": [
"course_id",
"name",
"isbn",
"edition",
"author",
"publisher",
"publisher_email",
"text_type",
"text_status",
"desk_copy_needed",
"reason",
"reason_other",
"ebook_isbn",
"comments",
"academic_year",
"course_number"
],
"properties": {
"course_id": {
"description": "Course ID. Ties course text to course.",
"type": "integer"
},
"name": {
"description": "Textbook name",
"type": "string"
},
"isbn": {
"description": "Textbook IBSN",
"type": "string"
},
"edition": {
"description": "Textbook edition",
"type": "string"
},
"author": {
"description": "Textbook Author",
"type": "string"
},
"publisher": {
"description": "Textbook Publisher",
"type": "string"
},
"publisher_email": {
"description": "Textbook publisher email address",
"type": "string"
},
"text_type": {
"description": "Values for Text Type can be only one of the following: Digital, Physical, Supplies, Supplemental, Other",
"type": "string"
},
"text_status": {
"description": "Textbook status. Values can be only one of the following: Required, Optional, Other",
"type": "string"
},
"desk_copy_needed": {
"description": "Desk Copy Needed: Values for Desk Copy Needed can be only one of the following: Yes, No, N/A",
"type": "string"
},
"reason": {
"description": "Values for Reason can be only one of the following: New Edition/Text, New Staffing, Other.",
"type": "string"
},
"reason_other": {
"description": "Reason Other should only have a value if the value for the Reason Column is Other, otherwise if the Reason Other Column is populated and the value for reason isn't Other, Reason Other will be ignored.",
"type": "string"
},
"ebook_isbn": {
"description": "Ebook ISBN",
"type": "string"
},
"comments": {
"description": "Commnets about textook",
"type": "string"
},
"academic_year": {
"description": "Acadmic year associated with the textbook requirement",
"type": "string"
},
"course_number": {
"description": "Course number. Ties course to course textbook",
"type": "string"
},
"course-text": {
"$ref": "#/components/schemas/CourseText"
},
"course": {
"$ref": "#/components/schemas/Course"
}
},
"type": "object"
}
]
},
"Credential": {
"type": "object",
"allOf": [
{
"required": [
"faculty_unique_id",
"degree",
"major"
],
"properties": {
"faculty_unique_id": {
"description": "Faculty unique ID. Ties credentials to faculty",
"type": "string"
},
"faculty_id": {
"description": "Faculty ID. Ties credentials to faculty",
"type": "integer"
},
"degree": {
"description": "Degree/Credential earned",
"type": "string"
},
"major": {
"description": "Major/Field of study",
"type": "string"
},
"granting_institution": {
"description": "Degree granting institution",
"type": "string"
},
"address": {
"description": "Address of degree granting institution",
"type": "string"
},
"terminal": {
"description": "Terminal Degree in field of study (terminal/blank)",
"type": "string"
},
"distinction": {
"description": "Distinction",
"type": "string"
},
"date_conferred": {
"description": "Date degree was conferred",
"type": "string",
"format": "date"
},
"dissertation_title": {
"description": "Dissertation title (if applicable)",
"type": "string"
},
"highest_degree_earned": {
"description": "Highest degree earned (yes/no/NA)",
"type": "string"
}
},
"type": "object"
}
]
},
"DaysOff": {
"type": "object",
"allOf": [
{
"required": [
"day_off"
],
"properties": {
"day_off": {
"description": "Days not to be included in faculty workload (holidays).An individual date can be added, per API call, as an exclusion date when dividing up the credit/hours across the start/end course dates",
"type": "string",
"format": "date"
},
"id": {
"description": "id of Day Off",
"type": "integer"
}
},
"type": "object"
}
]
},
"Department": {
"type": "object",
"allOf": [
{
"required": [
"name",
"unique_id"
],
"properties": {
"id": {
"description": "Department Id",
"type": "integer"
},
"name": {
"description": "Deparment name",
"type": "string"
},
"unique_id": {
"description": "Department unique ID",
"type": "string"
}
},
"type": "object"
}
]
},
"Employment": {
"type": "object",
"allOf": [
{
"required": [
"title",
"experience_type",
"faculty_unique_id"
],
"properties": {
"id": {
"description": "Employment Id",
"type": "integer"
},
"title": {
"description": "Job title",
"type": "string"
},
"exptype": {
"description": "Experience Types:
1. Academic
2. Applied
3. Government
4. Internship
5. Professional
6. Other
7. Military ",
"type": "integer"
},
"desc": {
"description": "Description of employment",
"type": "string"
},
"start_date": {
"description": "Start date of employment",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End date of employment",
"type": "string",
"format": "date"
},
"org": {
"description": "Organization name",
"type": "string"
},
"faculty": {
"$ref": "#/components/schemas/Adjunct"
},
"qualifying_experience": {
"description": "Qualifying experience",
"type": "integer"
}
},
"type": "object"
}
]
},
"Faculty": {
"type": "object",
"allOf": [
{
"required": [
"unique_id"
],
"properties": {
"id": {
"description": "Faculty Id",
"type": "integer"
},
"unique_id": {
"description": "Faculty's unqiue ID. The UniqueID field will override the Email field in determining if a Faculty record should be created or updated.",
"type": "string"
},
"faculty_code": {
"description": "Faculty code",
"type": "string"
},
"other_code": {
"description": "Other Code",
"type": "string"
},
"faculty_identifier": {
"description": "Faculty identifier",
"type": "string"
},
"first_name": {
"description": "Faculty first name",
"type": "string"
},
"middle_name": {
"description": "Faculty middle name",
"type": "string"
},
"last_name": {
"description": "Faculty last name",
"type": "string"
},
"firstname": {
"description": "Faculty first name",
"type": "string"
},
"middlename": {
"description": "Faculty middle name",
"type": "string"
},
"lastname": {
"description": "Faculty last name",
"type": "string"
},
"email": {
"description": "Primary email address",
"type": "string"
},
"office_address": {
"description": "Office mailing address",
"type": "string"
},
"office_city": {
"description": "Office city",
"type": "string"
},
"office_state": {
"description": "Office State",
"type": "string"
},
"office_zip": {
"description": "Office Zip Code",
"type": "string"
},
"phone": {
"description": "Primary Phone Number",
"type": "string"
},
"office_country": {
"description": "Office Country",
"type": "string"
},
"home_address": {
"description": "Home Address",
"type": "string"
},
"home_city": {
"description": "Home City",
"type": "string"
},
"home_state": {
"description": "Home State",
"type": "string"
},
"home_zip": {
"description": "Home Zip Code",
"type": "string"
},
"home_country": {
"description": "Home Country",
"type": "string"
},
"secondary_email": {
"description": "Secondary email address",
"type": "string"
},
"mobilephone": {
"description": "Mobile phone number",
"type": "string"
},
"homephone": {
"description": "Home phone number",
"type": "string"
},
"date_transcript_verified": {
"description": "Date faculty's transcript was verified by institution",
"type": "string",
"format": "date"
},
"start_date": {
"description": "Faculty employment start date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "Faculty employment end date",
"type": "string",
"format": "date"
},
"tenure_status": {
"description": "Tenure Status",
"type": "string"
},
"tenure_date": {
"description": "Date faculty recieved tenure (if applicable)",
"type": "string",
"format": "date"
},
"cip_code": {
"description": "CIP Code",
"type": "number",
"format": "float"
},
"race": {
"$ref": "#/components/schemas/Race"
},
"ethnicity": {
"$ref": "#/components/schemas/Ethnicity"
},
"diversity": {
"description": "Diversity (diverse/nondiverse/noanswer)",
"type": "integer"
},
"gender_id": {
"description": "Gender. Values configurable in Diversity configurations",
"type": "integer"
},
"professional_certs_earned": {
"description": "Professional certifications earned",
"type": "string"
},
"dob": {
"description": "Faculty date of birth",
"type": "string",
"format": "date"
},
"us_citizen": {
"description": "Possesion of US citizenship",
"type": "string"
},
"languages": {
"description": "Languages spoken/used",
"type": "object",
"example": [
"english",
"spanish"
]
},
"prefix": {
"description": "Prefix",
"type": "string"
},
"suffix": {
"description": "Suffix",
"type": "string"
},
"other_email": {
"description": "Tertiary email address",
"type": "string"
},
"historical_credits": {
"description": "Faculty Historical Credits",
"type": "number"
},
"supervisor": {
"$ref": "#/components/schemas/Supervisor"
},
"college": {
"$ref": "#/components/schemas/College"
},
"department": {
"$ref": "#/components/schemas/Department"
},
"campus": {
"$ref": "#/components/schemas/Campus"
},
"education": {
"description": "Faculty Education",
"type": "object",
"example": [
{
"id": "integer",
"adjuncts_id": "integer",
"degree": "string",
"field": "string",
"institution": "string",
"terminal": "integer",
"address": "string",
"date_conferred": "2019-04-10",
"title": "string",
"distinction": "string",
"highest_degree_earned": "string",
"deleted": "integer",
"qualifying_credential": "integer"
}
]
},
"profile": {
"$ref": "#/components/schemas/Profile"
},
"payroll_id": {
"description": "Payroll ID",
"type": "string"
},
"active": {
"description": "Active",
"type": "integer"
},
"faculty_role": {
"description": "Faculty role [0=Faculty Only|1=SBL Only|2=Both]",
"type": "integer"
},
"sbl_organizations": {
"description": "Site Based Learning Organizations",
"type": "object"
},
"employee_id": {
"description": "Employee ID",
"type": "string"
},
"do_not_staff": {
"description": "Is faculty restricted from being staffed? Default 0 = no, Set to 1 for yes",
"type": "integer"
},
"fte_value": {
"description": "Tracking FTE Data",
"type": "string"
},
"deleted": {
"description": "Deleted",
"type": "integer"
},
"created": {
"description": "datetime object was created",
"type": "string",
"format": "date-time"
},
"updated": {
"description": "datetime object was last updated",
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
]
},
"FacultyCompensation": {
"type": "object",
"allOf": [
{
"required": [
"unique_id",
"name",
"rank",
"track",
"load",
"college_id",
"campus_id",
"dept_id",
"faculty_distinction_id"
],
"properties": {
"university_id": {
"description": "University Id",
"type": "integer"
},
"name": {
"description": "FacultyCompensation Name",
"type": "string"
},
"unique_id": {
"description": "FacultyCompensation UniqueId",
"type": "string"
},
"compensation_type_id": {
"description": "FacultyCompensationType Id",
"type": "integer"
},
"compensation_sub_type_id": {
"description": "FacultyCompensation SubType Id",
"type": "integer"
},
"base_rate": {
"description": "BaseRate",
"type": "string"
},
"rank": {
"description": "Rank Id",
"type": "integer"
},
"rank_modifier": {
"description": "Rank Modifier",
"type": "integer"
},
"rank_amount": {
"description": "Rank Amount",
"type": "string"
},
"track": {
"description": "Track Id",
"type": "integer"
},
"track_modifier": {
"description": "Track Modifier",
"type": "integer"
},
"track_amount": {
"description": "Track Amount",
"type": "string"
},
"load_status": {
"description": "Load Status",
"type": "integer"
},
"load_status_modifier": {
"description": "Load Status Modifier",
"type": "integer"
},
"load_status_amount": {
"description": "Load Status Amount",
"type": "string"
},
"campus_id": {
"description": "Campus Id",
"type": "integer"
},
"campus_modifier": {
"description": "Campus Modifier",
"type": "integer"
},
"campus_amount": {
"description": "Campus Amount",
"type": "string"
},
"college_id": {
"description": "College Id",
"type": "integer"
},
"college_modifier": {
"description": "College Modifier",
"type": "integer"
},
"college_amount": {
"description": "College Amount",
"type": "string"
},
"dept_id": {
"description": "Dept Id",
"type": "integer"
},
"dept_modifier": {
"description": "Dept Modifier",
"type": "integer"
},
"dept_amount": {
"description": "Dept Amount",
"type": "string"
},
"terminal_degree": {
"description": "Terminal Degree",
"type": "integer"
},
"terminal_degree_modifier": {
"description": "Terminal Degree Modifier",
"type": "integer"
},
"terminal_degree_amount": {
"description": "Terminal Degree Amount",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"state_modifier": {
"description": "State Modifier",
"type": "integer"
},
"state_amount": {
"description": "State Amount",
"type": "string"
},
"faculty_distinction": {
"description": "Faculty Distinction",
"type": "integer"
},
"faculty_distinction_modifier": {
"description": "Faculty Distinction Modifier",
"type": "integer"
},
"faculty_distinction_amount": {
"description": "Faculty Distinction Amount",
"type": "string"
},
"highest_degree_earned": {
"description": "Highest Degree Earned",
"type": "integer"
},
"highest_degree_earned_modifier": {
"description": "Highest Degree Earned Modifier",
"type": "integer"
},
"highest_degree_earned_amount": {
"description": "Highest Degree Earned Amount",
"type": "string"
}
},
"type": "object"
}
]
},
"FacultyDistinction": {
"type": "object",
"allOf": [
{
"required": [
"unique_id",
"name"
],
"properties": {
"id": {
"description": "Campus Id",
"type": "integer"
},
"university_id": {
"description": "University Id",
"type": "integer"
},
"name": {
"description": "Campus Name",
"type": "string"
},
"unique_id": {
"description": "Campus UniqueId",
"type": "string"
}
},
"type": "object"
}
]
},
"FacultyWorkloadAggregate": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"type": "number"
},
"firstname": {
"description": "First name of user",
"type": "string"
},
"lastname": {
"description": "Last name of user",
"type": "string"
},
"email": {
"description": "Email address of user",
"type": "string"
},
"unique_id": {
"description": "User unique ID",
"type": "string"
},
"start_date": {
"description": "start date of the range, if provided",
"type": "string",
"format": "date"
},
"end_date": {
"description": "end date of the range, if provided",
"type": "string",
"format": "date"
},
"workload": {
"description": "Workload value for the given range or all",
"type": "number"
}
},
"type": "object"
}
]
},
"FacultyJobCode": {
"type": "object",
"allOf": [
{
"required": [
"unique_id",
"name"
],
"properties": {
"id": {
"description": "Faculty Job Code Id",
"type": "integer"
},
"adjunct_id": {
"description": "Faculty Id",
"type": "integer"
},
"adjunct_full_name": {
"description": "Faculty Full Name",
"type": "string"
},
"department_id": {
"description": "Department Id",
"type": "integer"
},
"department_name": {
"description": "Department Name",
"type": "string"
},
"college_id": {
"description": "College Id",
"type": "integer"
},
"college_name": {
"description": "College Name",
"type": "string"
},
"campus_id": {
"description": "Campus Id",
"type": "integer"
},
"campus_name": {
"description": "Campus Name",
"type": "string"
},
"job_role_id": {
"description": "Job Role Id",
"type": "integer"
},
"job_role_name": {
"description": "Job Role Name",
"type": "string"
},
"job_group_id": {
"description": "Job Group Id",
"type": "integer"
},
"job_group_name": {
"description": "Job Group Name",
"type": "string"
},
"supervisor_id": {
"description": "Supervisor Id",
"type": "integer"
},
"supervisor_full_name": {
"description": "Supervisor Full Name",
"type": "string"
},
"unique_id": {
"description": "Job Code Unique ID",
"type": "string"
},
"job_code": {
"description": "Job Code Name",
"type": "string"
},
"created_at": {
"description": "Datetime object was created",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "Datetime object was last updated",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "Datetime object was deleted",
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
]
},
"JobGroup": {
"type": "object",
"allOf": [
{
"required": [
"unique_id",
"name"
],
"properties": {
"id": {
"description": "Job Group Id",
"type": "integer"
},
"unique_id": {
"description": "Job Group Unique ID",
"type": "string"
},
"name": {
"description": "Job Group Name",
"type": "string"
},
"created_at": {
"description": "Datetime object was created",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "Datetime object was last updated",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "Datetime object was deleted",
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
]
},
"JobRole": {
"type": "object",
"allOf": [
{
"required": [
"unique_id",
"name",
"job_group_id"
],
"properties": {
"id": {
"description": "Job Role Id",
"type": "integer"
},
"unique_id": {
"description": "Job Role Unique ID",
"type": "string"
},
"name": {
"description": "Job Role Name",
"type": "string"
},
"job_group_id": {
"description": "Job Group Id",
"type": "string"
},
"job_group_name": {
"description": "Job Group Name",
"type": "string"
},
"created_at": {
"description": "Datetime object was created",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "Datetime object was last updated",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "Datetime object was deleted",
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
]
},
"Load": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"description": "Load Class Id",
"type": "integer"
},
"key": {
"description": "Load Class Key",
"type": "string"
},
"name": {
"description": "Load Class Name",
"type": "string"
},
"active": {
"description": "active",
"type": "string"
}
},
"type": "object"
}
]
},
"PdfCvBatch": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"description": "Pdf CV Batch Id",
"type": "integer"
},
"status": {
"description": "Status of the pdf cv batch creation: `PENDING = 0, PROCESSING = 1, ERROR = 2, COMPLETE = 3`",
"type": "integer"
},
"faculty_data": {
"description": "Array of faculty ids that went into the creation of the batch",
"type": "array",
"items": {
"type": "integer",
"format": "id",
"example": "1, 2, 3, 4"
},
"collectionFormat": "multi"
},
"file": {
"description": "URL to download the batch Pdf cv",
"type": "string"
},
"message": {
"description": "any additional output describing the pdf cv batch process",
"type": "string"
},
"created_at": {
"description": "Created At",
"type": "string",
"format": "date"
},
"updated_at": {
"description": "Updated At",
"type": "string",
"format": "date"
}
},
"type": "object"
}
]
},
"PerformanceNote": {
"type": "object",
"allOf": [
{
"required": [
"faculty_unique_id",
"type",
"notes",
"academic_year"
],
"properties": {
"faculty_unique_id": {
"description": "Faculty unique ID associated with note. Ties note to faculty",
"type": "string"
},
"course_name": {
"description": "Course name associated with faculty note (optional)",
"type": "string"
},
"course_unique_id": {
"description": "Course unique ID associated with faculty note",
"type": "string"
},
"term_unique_id": {
"description": "Term unique ID assocaited with faculty note (optional)",
"type": "string"
},
"type": {
"description": "Note type: positive/negative (required)",
"type": "string"
},
"notes": {
"description": "Note content",
"type": "string"
},
"public_to_adjunct": {
"description": "Faculty access to note",
"type": "string"
},
"public_to_other": {
"description": "Other instituion user access to note",
"type": "string"
},
"academic_year": {
"description": "Academic Year associated with note",
"type": "string"
},
"performance-note": {
"$ref": "#/components/schemas/PerformanceNote"
},
"campus": {
"$ref": "#/components/schemas/Campus"
},
"college": {
"$ref": "#/components/schemas/College"
},
"department": {
"$ref": "#/components/schemas/Department"
},
"course": {
"$ref": "#/components/schemas/Course"
},
"term": {
"$ref": "#/components/schemas/Term"
},
"faculty": {
"$ref": "#/components/schemas/Faculty"
}
},
"type": "object"
}
]
},
"Profile": {
"type": "object",
"allOf": [
{
"required": [
"id"
],
"properties": {
"id": {
"description": "Profile Id",
"type": "integer"
},
"adjuncts_id": {
"description": "Faculty Id",
"type": "integer"
},
"avatar": {
"description": "Faculty Image/Avatar",
"type": "string"
},
"apl_certified": {
"description": "APL Certified?",
"type": "integer"
},
"completion": {
"description": "Completion",
"type": "integer"
},
"degrees": {
"description": "Faculty Degrees",
"type": "string"
},
"addl_courses": {
"description": "Additional Courses",
"type": "string"
},
"points": {
"description": "Faculty Points",
"type": "integer"
},
"certifications": {
"description": "Faculty Certifications",
"type": "string"
},
"transcript": {
"description": "Faculty Transcript",
"type": "string"
},
"interests": {
"description": "Faculty Interests",
"type": "object",
"example": [
{
"teachshorttermcourse": "1",
"teachcourseinternationally": "1"
}
]
},
"awards": {
"description": "Faculty Awards",
"type": "string"
},
"teaching_interests": {
"description": "Faculty Teaching Interests",
"type": "string"
},
"research_interests": {
"description": "Faculty Research Interests",
"type": "string"
},
"bio": {
"description": "Faculty biography",
"type": "string"
}
},
"type": "object"
}
]
},
"Pronoun": {
"type": "object",
"allOf": [
{
"required": [
"unique_id",
"name"
],
"properties": {
"id": {
"description": "Pronoun Id",
"type": "integer"
},
"name": {
"description": "Pronoun Name",
"type": "string"
},
"unique_id": {
"description": "Pronoun UniqueID",
"type": "string"
},
"pronoun": {
"$ref": "#/components/schemas/Pronoun"
}
},
"type": "object"
}
]
},
"Qualification": {
"type": "object",
"allOf": [
{
"required": [
"faculty_unique_id",
"course_name",
"course_number",
"verification_type",
"verification_reason",
"verification_rationale",
"start_date",
"end_date"
],
"properties": {
"faculty_unique_id": {
"description": "Faculty unique ID. Ties qualifications to faculty.",
"type": "string"
},
"course_name": {
"description": "Course name associated with qualification",
"type": "string"
},
"course_number": {
"description": "Course number associated with qualification",
"type": "string"
},
"verification_type": {
"description": "Qualification verification type",
"type": "string"
},
"verification_reason": {
"description": "Qualification verification reason",
"type": "string"
},
"verification_rationale": {
"description": "Qualification verification rationale",
"type": "string"
},
"start_date": {
"description": "Qualification start date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "Qualification end date",
"type": "string",
"format": "date"
},
"qualification": {
"$ref": "#/components/schemas/Qualification"
}
},
"type": "object"
}
]
},
"CourseDesignation": {
"type": "object",
"allOf": [
{
"required": [
"name",
"unique_id"
],
"properties": {
"id": {
"description": "CourseDesignation Id",
"type": "integer"
},
"name": {
"description": "Course Designations Name",
"type": "string"
},
"unique_id": {
"description": "Course Designations UniqueID",
"type": "string"
},
"course-designation": {
"$ref": "#/components/schemas/CourseDesignation"
}
},
"type": "object"
}
]
},
"Ethnicity": {
"type": "object",
"allOf": [
{
"required": [
"unique_id",
"name"
],
"properties": {
"id": {
"description": "Ethnicity Id",
"type": "integer"
},
"unique_id": {
"description": "Ethnicity UniqueID",
"type": "string"
},
"name": {
"description": "Ethnicity Name",
"type": "string"
},
"ethnicity": {
"$ref": "#/components/schemas/Ethnicity"
}
},
"type": "object"
}
]
},
"Gender": {
"type": "object",
"allOf": [
{
"required": [
"name",
"unique_id"
],
"properties": {
"id": {
"description": "Gender Id",
"type": "integer"
},
"name": {
"description": "Gender Name",
"type": "string"
},
"unique_id": {
"description": "Gender UniqueID",
"type": "string"
},
"gender": {
"$ref": "#/components/schemas/Gender"
}
},
"type": "object"
}
]
},
"LoadStatus": {
"type": "object",
"allOf": [
{
"required": [
"name",
"unique_id"
],
"properties": {
"id": {
"description": "Load Status Id",
"type": "integer"
},
"name": {
"description": "Load Status Name",
"type": "string"
},
"unique_id": {
"description": "Load Status UniqueID",
"type": "string"
},
"load-status": {
"$ref": "#/components/schemas/LoadStatus"
}
},
"type": "object"
}
]
},
"QualificationGroup": {
"type": "object",
"allOf": [
{
"required": [
"name",
"unique_id"
],
"properties": {
"id": {
"description": "Qualification Group Id",
"type": "integer"
},
"name": {
"description": "Qualification Group Name",
"type": "string"
},
"unique_id": {
"description": "Qualification Group UniqueID",
"type": "string"
},
"qualification-group": {
"$ref": "#/components/schemas/QualificationGroup"
}
},
"type": "object"
}
]
},
"Race": {
"type": "object",
"allOf": [
{
"required": [
"name",
"unique_id"
],
"properties": {
"id": {
"description": "Race Id",
"type": "integer"
},
"name": {
"description": "Race Name",
"type": "string"
},
"unique_id": {
"description": "Race UniqueID",
"type": "string"
},
"race": {
"$ref": "#/components/schemas/Race"
}
},
"type": "object"
}
]
},
"Rank": {
"type": "object",
"allOf": [
{
"required": [
"name",
"unique_id"
],
"properties": {
"id": {
"description": "Rank Id",
"type": "integer"
},
"name": {
"description": "Rank Name",
"type": "string"
},
"unique_id": {
"description": "Rank UniqueID",
"type": "string"
},
"rank": {
"$ref": "#/components/schemas/Rank"
}
},
"type": "object"
}
]
},
"Track": {
"type": "object",
"allOf": [
{
"required": [
"name",
"unique_id"
],
"properties": {
"id": {
"description": "Track Id",
"type": "integer"
},
"name": {
"description": "Track Name",
"type": "string"
},
"unique_id": {
"description": "Track UniqueID",
"type": "string"
},
"track": {
"$ref": "#/components/schemas/Track"
}
},
"type": "object"
}
]
},
"Staffing": {
"type": "object",
"allOf": [
{
"required": [
"unique_id",
"course_unique_id",
"college_unique_id",
"campus_unique_id",
"dept_unique_id",
"status",
"dead_line"
],
"properties": {
"id": {
"description": "Staffing Id",
"type": "integer"
},
"unique_id": {
"description": "Staffing Unique_id",
"type": "string"
},
"course": {
"$ref": "#/components/schemas/StaffingCourse"
},
"instructor_count": {
"description": "Nuiber of instructors assigned to Staffing",
"type": "integer"
},
"status": {
"description": "status",
"type": "integer",
"example": {
"status": {
"ASSIGNMENT_INCOMPLETE": 0,
"ASSIGNMENT_INVITED": 1,
"ASSIGNMENT_ACCEPTED": 2,
"ASSIGNMENT_REJECTED": 3,
"ASSIGNMENT_CANCELLED": 4,
"ASSIGNMENT_EXPIRED": 5,
"ASSIGNMENT_STAYED": 6,
"ASSIGNMENT_REMOVED": 7
}
}
},
"deadline": {
"description": "Deadline",
"type": "string",
"format": "date"
},
"offering": {
"description": "Offering",
"type": "integer"
},
"campus": {
"$ref": "#/components/schemas/Campus"
},
"department": {
"$ref": "#/components/schemas/Department"
},
"college": {
"$ref": "#/components/schemas/College"
},
"instructors": {
"description": "Instructors",
"type": "object",
"example": [
{
"id": "integer",
"assign_id": "integer",
"course_id": "integer",
"adjunct_id": "integer",
"instruction_id": "integer",
"university_id": "integer",
"college_id": "integer",
"campus_id": "integer",
"dept_id": "integer",
"deleted": "integer",
"created": "2019-04-10 23:18:52",
"faculty_invited": "2019-04-10 23:18:52",
"faculty_accepted": "2019-04-27 23:18:52",
"status": "integer",
"rejectreason": "string",
"is_primary": "integer",
"reflections": "string",
"updated": "2019-04-27 23:18:52",
"notify": "integer",
"workload_waived": "integer",
"availability_waived": "integer",
"qualification_waived": "integer",
"status_reason": "string",
"compensation_override_value": "numeric",
"compensation_override": "integer",
"compensation_workload_override_value": "numeric",
"compensation_workload_override": "integer",
"instructor_ignore_days_off": "integer",
"staffing_instructor_workload": "numeric"
}
]
},
"deleted": {
"description": "Deleted 1|0",
"type": "integer"
},
"created": {
"description": "datetime object was created",
"type": "string",
"format": "date-time"
},
"updated": {
"description": "datetime object was last updated",
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
]
},
"StaffingCourse": {
"type": "object",
"allOf": [
{
"required": [
"unique_id",
"course_unique_id",
"college_unique_id",
"campus_unique_id",
"dept_unique_id",
"status",
"dead_line"
],
"properties": {
"id": {
"description": "Course Id",
"type": "integer"
},
"number": {
"description": "Course Number",
"type": "string"
},
"name": {
"description": "Course Name",
"type": "string"
},
"college_id": {
"description": "College Id",
"type": "integer"
},
"dept_id": {
"description": "Department Id",
"type": "integer"
},
"campus_id": {
"description": "Campus Id",
"type": "integer"
},
"compensation_course_id": {
"description": "Compensation Id",
"type": "integer"
},
"workload_value": {
"description": "Workload Value",
"type": "number",
"format": "float"
},
"deleted": {
"description": "Deleted",
"type": "integer"
},
"section": {
"description": "Course Section",
"type": "string"
},
"term": {
"description": "Term Id",
"type": "integer"
},
"year": {
"description": "Academic Year",
"type": "string"
},
"compensation": {
"description": "Compensation Value",
"type": "number",
"format": "float"
},
"deliverymethod": {
"description": "Delivery Method",
"type": "object",
"example": [
"inperson"
]
},
"location": {
"description": "Location",
"type": "string"
},
"description": {
"description": "Description",
"type": "string"
},
"daystimes": {
"description": "Days Times",
"type": "object",
"example": [
{
"sunday": {
"start": "",
"end": ""
},
"monday": {
"start": "",
"end": ""
},
"tuesday": {
"start": "",
"end": ""
},
"wednesday": {
"start": "00:06",
"end": "05:06"
},
"thursday": {
"start": "00:01",
"end": "01:04"
},
"friday": {
"start": "",
"end": ""
},
"saturday": {
"start": "",
"end": ""
}
}
]
},
"timezone": {
"description": "Timezone",
"type": "string"
},
"credithours": {
"description": "Credit Hours",
"type": "number",
"format": "float"
},
"enrollment": {
"description": "Enrollment",
"type": "integer"
},
"status": {
"description": "Status",
"type": "integer"
},
"enrollment_capacity": {
"description": "Enrollment Capacity",
"type": "integer"
},
"unique_id": {
"description": "Unique Id",
"type": "string"
},
"crn": {
"description": "crn",
"type": "string"
},
"start_date": {
"description": "Course Start Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "Course End Date",
"type": "string",
"format": "date"
},
"grading_week": {
"description": "Grading Week",
"type": "integer"
},
"student_credits": {
"description": "Student Credits",
"type": "number",
"format": "float"
},
"created": {
"description": "Date Created",
"type": "string",
"format": "date-time"
},
"updated": {
"description": "Date Updated",
"type": "string",
"format": "date-time"
},
"distinction_id": {
"description": "Distinction Id",
"type": "integer"
}
},
"type": "object"
}
]
},
"StaffingInstructor": {
"type": "object",
"allOf": [
{
"required": [
"staffing_unique_id",
"faculty_unique_id",
"instruction_role_unique_id"
],
"properties": {
"id": {
"description": "Staffing Instructor Id",
"type": "integer"
},
"unique_id": {
"description": "Staffing Instructor Unique_id",
"type": "string"
},
"instruction_role_id": {
"description": "Instructor Role Id",
"type": "integer"
},
"instruction_role_unique_id": {
"description": "Instructor Role unique_id",
"type": "string"
},
"course": {
"$ref": "#/components/schemas/StaffingCourse"
},
"adjunct": {
"$ref": "#/components/schemas/Adjunct"
},
"instruction_id": {
"description": "Instruction Role Id",
"type": "integer"
},
"faculty_invited": {
"description": "Date Invited",
"type": "string",
"format": "date-time"
},
"faculty_accepted": {
"description": "Date Accepted",
"type": "string",
"format": "date-time"
},
"faculty_id": {
"description": "Faculty Id",
"type": "integer"
},
"facultyDates": {
"$ref": "#/components/schemas/StaffingInstructorDate"
},
"status": {
"description": "Status",
"type": "integer",
"example": {
"status": {
"ASSIGNMENT_INCOMPLETE": 0,
"ASSIGNMENT_INVITED": 1,
"ASSIGNMENT_ACCEPTED": 2,
"ASSIGNMENT_REJECTED": 3,
"ASSIGNMENT_CANCELLED": 4,
"ASSIGNMENT_EXPIRED": 5,
"ASSIGNMENT_STAYED": 6,
"ASSIGNMENT_REMOVED": 7
}
}
},
"rejectreason": {
"description": "Rejected Reason",
"type": "string"
},
"is_primary": {
"description": "Primary Instructor",
"type": "string"
},
"campus": {
"$ref": "#/components/schemas/Campus"
},
"department": {
"$ref": "#/components/schemas/Department"
},
"college": {
"$ref": "#/components/schemas/College"
},
"instructor_ignore_days_off": {
"description": "Instructor Ignore Days Off",
"type": "integer"
},
"faculty_job_code_id": {
"description": "Faculty Job Code ID",
"type": "integer"
},
"compiled_workload": {
"description": "Compiled Workload after modifiers are taken into account",
"type": "number",
"format": "float"
},
"compiled_workload_updated": {
"description": "Last time the compiled_workload was updated ",
"type": "string",
"format": "date-time"
},
"faculty_job_code_unique_id": {
"description": "Faculty Job Code Unique ID",
"type": "integer"
},
"deleted": {
"description": "Deleted 1|0",
"type": "integer"
},
"created": {
"description": "datetime object was created",
"type": "string",
"format": "date-time"
},
"updated": {
"description": "datetime object was last updated",
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
]
},
"StaffingInstructorDate": {
"type": "object",
"allOf": [
{
"required": [
"staffing_instructor_id"
],
"properties": {
"id": {
"description": "Staffing Instructor Date Id",
"type": "integer"
},
"staffing_instructor_id": {
"description": "Staffing Instructor Id",
"type": "integer"
},
"staffin_id": {
"description": "Staffing Id",
"type": "integer"
},
"start_date": {
"description": "Start Date of the Staffing Assignment for the Instructor",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End Date of the Staffing Assignment for the Instructor",
"type": "string",
"format": "date"
},
"deleted_at": {
"description": "datetime object was deleted",
"type": "string",
"format": "date-time"
},
"created": {
"description": "datetime object was created",
"type": "string",
"format": "date-time"
},
"updated": {
"description": "datetime object was last updated",
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
]
},
"Student": {
"type": "object",
"allOf": [
{
"required": [
"unique_id"
],
"properties": {
"id": {
"description": "Student Id",
"type": "integer"
},
"unique_id": {
"description": "Student's unqiue ID",
"type": "string"
},
"dept_id": {
"description": "Departament Id",
"type": "integer"
},
"university_id": {
"description": "University Id",
"type": "integer"
},
"designations": {
"description": "Designations",
"type": "object"
},
"first_name": {
"description": "Student first name",
"type": "string"
},
"last_name": {
"description": "Student last name",
"type": "string"
},
"email": {
"description": "Email address",
"type": "string"
},
"phone": {
"description": "Primary Phone Number",
"type": "string"
},
"address": {
"description": "Address",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"zip": {
"description": "Zip Code",
"type": "string"
},
"created_at": {
"description": "datetime object was created",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "datetime object was last updated",
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
]
},
"StudentApplicationQuestion": {
"type": "object",
"allOf": [
{
"required": [
"unique_id"
],
"properties": {
"id": {
"description": "StudentApplicationQuestion Id",
"type": "integer"
},
"slug": {
"description": "The unique slug of the question",
"type": "string"
},
"question": {
"description": "The question",
"type": "string"
},
"type": {
"description": "The type of the question",
"type": "string"
},
"created_at": {
"description": "datetime object was created",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "datetime object was last updated",
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
]
},
"SiteBasedLearningOrganization": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"description": "Site Based Learning Organization Id",
"type": "integer"
},
"status": {
"description": "Organization Status: DRAFT = 0; REJECTED = 2; ARCHIVED = 3; APPROVED = 1; CHANGE_REQUESTED = 4;",
"type": "integer"
},
"student_id": {
"description": "Student Id",
"type": "integer"
},
"unique_id": {
"description": "Orangization unqiue Id",
"type": "string"
},
"site_name": {
"description": "Site Name",
"type": "string"
},
"corporate_name": {
"description": "Corporate Name",
"type": "string"
},
"contact_name": {
"description": "Contact Name",
"type": "string"
},
"contact_title": {
"description": "Contact Title",
"type": "string"
},
"contact_email": {
"description": "Contact Email",
"type": "string"
},
"contact_phone": {
"description": "Contact Phone",
"type": "string"
},
"phone": {
"description": "Phone Number",
"type": "string"
},
"fax": {
"description": "Fax",
"type": "string"
},
"website": {
"description": "Website Address",
"type": "string"
},
"address": {
"description": "Stree Address",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"zip": {
"description": "Zip Code",
"type": "string"
},
"setting_type": {
"description": "Setting Type",
"type": "string"
},
"certification": {
"description": "Certifiacations",
"type": "string"
},
"professional_memberships": {
"description": "Professional Memberships",
"type": "string"
},
"state_of_training_site": {
"description": "State of training site",
"type": "string"
},
"parking": {
"description": "Parking",
"type": "string"
},
"working_hours": {
"description": "Working Hours",
"type": "string"
},
"affiliation_agreement": {
"description": "Affiliation agreement",
"type": "boolean"
},
"mission_of_the_organization": {
"description": "Mission of the organization",
"type": "string"
},
"populations_serviced_by_site": {
"description": "Populations serviced by site",
"type": "string"
},
"site_accreditations_licenses": {
"description": "Site accreditations licenses",
"type": "string"
},
"type_of_supervisees_at_site": {
"description": "Type of supervisees at site",
"type": "string"
},
"types_of_professionals_at_site": {
"description": "Types of professionals at site",
"type": "string"
},
"created_at": {
"description": "datetime object was created",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "datetime object was last updated",
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
]
},
"StudentCourse": {
"type": "object",
"allOf": [
{
"required": [
"student_id",
"faculty_supervisor_id",
"sbl_organization_id",
"course_id"
],
"properties": {
"id": {
"description": "Student Course Id",
"type": "integer"
},
"student_id": {
"description": "Student ID - /v1/student/{unique_id} API endpoint to obtain the id",
"type": "integer"
},
"faculty_supervisor_id": {
"description": "Faculty Supervisor Id - /v1/faculty/unique_id/{unique_id} API endpoint to obtain the id",
"type": "integer"
},
"sbl_organization_id": {
"description": "Site Based Learning Organization Id - /v1/sbl/organization/{unique_id} API endpoint to obtain the id",
"type": "integer"
},
"course_id": {
"description": "Course Id - /v1/course/{unique_id} API endpoint to obtain the id",
"type": "integer"
},
"application_id": {
"description": "Application Id - optional",
"type": "integer"
}
},
"type": "object"
}
]
},
"Supervisor": {
"type": "object",
"allOf": [
{
"required": [
"unique_id"
],
"properties": {
"id": {
"description": "Supervisor Id",
"type": "integer"
},
"campus_id": {
"description": "Campus Id",
"type": "integer"
},
"college_id": {
"description": "College Id",
"type": "integer"
},
"dept_id": {
"description": "Dept Id",
"type": "integer"
},
"firstname": {
"description": "Super first name",
"type": "string"
},
"lastname": {
"description": "Super last name",
"type": "string"
},
"email": {
"description": "Supervisor email address",
"type": "string"
},
"address": {
"description": "Supervisor mailing address",
"type": "string"
},
"city": {
"description": "Supervisor City",
"type": "string"
},
"state": {
"description": "Supervisor State",
"type": "string"
},
"zip": {
"description": "Supervisor Zip Code",
"type": "string"
},
"phone": {
"description": "Supervisor Phone Number",
"type": "string"
},
"active": {
"description": "Supervisor Active",
"type": "integer"
},
"owner": {
"description": "Supervisor Is Owner",
"type": "integer"
},
"reset_pwd": {
"description": "Supervisor Reset Password",
"type": "integer"
},
"region": {
"description": "Supervisor Region",
"type": "string"
},
"defaultyear": {
"description": "Supervisor Default Login Academic Year",
"type": "string"
},
"is_support": {
"description": "Supervisor Is Support",
"type": "integer"
},
"unique_id": {
"description": "Supervisor Unique Id",
"type": "string"
}
},
"type": "object"
}
]
},
"Term": {
"type": "object",
"allOf": [
{
"required": [
"name",
"start_date",
"end_date",
"census_date",
"year",
"unique_id"
],
"properties": {
"id": {
"description": "Term Id",
"type": "integer"
},
"name": {
"description": "Term Name",
"type": "string"
},
"start_date": {
"description": "Term Start Date",
"type": "string",
"format": "date"
},
"end_date": {
"description": "Term End Date",
"type": "string",
"format": "date"
},
"census_date": {
"description": "Census date for the term",
"type": "string",
"format": "date"
},
"year": {
"description": "Year associated with the term",
"type": "string"
},
"unique_id": {
"description": "Term unique ID",
"type": "string"
},
"term": {
"$ref": "#/components/schemas/Term"
}
},
"type": "object"
}
]
},
"TimeCardEntry": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"description": "Time Card Entry Id",
"type": "integer"
},
"time_card_period_id": {
"description": "Time Card Period Id",
"type": "integer"
},
"faculty_id": {
"description": "Faculty Id",
"type": "integer"
},
"status": {
"description": "Status of the time card entry",
"type": "integer"
},
"logged_date": {
"description": "Date the time card entry was logged",
"type": "string",
"format": "date"
},
"logged_start_time": {
"description": "Start time of the time card entry",
"type": "string",
"format": "time"
},
"logged_end_time": {
"description": "End time of the time card entry",
"type": "string",
"format": "time"
},
"logged_hours": {
"description": "Hours logged for the time card entry",
"type": "number",
"format": "float"
},
"over_break_threshold": {
"description": "Over break threshold",
"type": "boolean"
},
"created_at": {
"description": "Created At",
"type": "string",
"format": "date"
},
"updated_at": {
"description": "Updated At",
"type": "string",
"format": "date"
},
"deleted_at": {
"description": "Deleted At",
"type": "string",
"format": "date"
}
},
"type": "object"
}
]
},
"TimeCardPeriod": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"description": "Time Card Staffing Id",
"type": "integer"
},
"time_card_staffing_id": {
"description": "Staffing Instructor Id",
"type": "integer"
},
"faculty_id": {
"description": "Time Card Faculty Id",
"type": "integer"
},
"status": {
"description": "Status of the time card period: COMPLETE = 1 , PENIDNG = 0, REOPENED = 2",
"type": "integer"
},
"start_date": {
"description": "Start of the Period",
"type": "string",
"format": "date"
},
"end_date": {
"description": "End of the Period",
"type": "string",
"format": "date"
},
"due_date": {
"description": "Due Date for the time card period",
"type": "string",
"format": "date"
},
"completed_date": {
"description": "Date the time card period was completed",
"type": "string",
"format": "date"
},
"created_at": {
"description": "Datetime object was created",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "Datetime object was last updated",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "Datetime object was deleted",
"type": "string",
"format": "date-time"
}
},
"type": "object"
}
]
},
"TimeCardStaffing": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"description": "Time Card Staffing Id",
"type": "integer"
},
"staffing_instructor_id": {
"description": "Staffing Instructor Id",
"type": "integer"
},
"course_id": {
"description": "Course Id",
"type": "integer"
},
"status": {
"description": "Status COMPLETE = 1, ACTIVE = 2, INCOMPLETE = 3, PENDING = 0",
"type": "integer"
},
"faculty_id": {
"description": "Faculty Id for the Time Card Staffing",
"type": "integer"
},
"completed_date": {
"description": "Datetime Time Card Staffing was completed",
"type": "string",
"format": "date-time"
},
"created_at": {
"description": "Datetime object was created",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "Datetime object was last updated",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "Datetime object was deleted",
"type": "string",
"format": "date-time"
},
"time_card_periods": {
"$ref": "#/components/schemas/TimeCardPeriod"
}
},
"type": "object"
}
]
},
"University": {
"type": "object",
"allOf": [
{
"required": [],
"properties": {
"id": {
"description": "University Id",
"type": "integer"
},
"name": {
"description": "University Name",
"type": "string"
},
"address": {
"description": "University Address",
"type": "string"
},
"city": {
"description": "University City",
"type": "string"
},
"state": {
"description": "University State",
"type": "string"
},
"zip": {
"description": "University Zip",
"type": "string"
},
"phone": {
"description": "University Phone",
"type": "string"
},
"active": {
"description": "Active / Inactive",
"type": "integer"
},
"deleted": {
"description": "Deleted",
"type": "integer"
},
"model": {
"description": "Model",
"type": "integer"
},
"logo": {
"description": "University Logo",
"type": "string"
},
"academic_start_month": {
"description": "Academic Start Month",
"type": "integer"
},
"academic_start_day": {
"description": "Academic Start Day",
"type": "integer"
},
"academic_end_month": {
"description": "Academic End Month",
"type": "integer"
},
"academic_end_day": {
"description": "Academic End Day",
"type": "integer"
},
"threshold_fulltime": {
"description": "Threshold Fulltime",
"type": "integer"
},
"threshold_parttime": {
"description": "Threshold Part time",
"type": "integer"
},
"threshold_credits": {
"description": "Threshold Credits",
"type": "integer"
},
"threshold_scholarship": {
"description": "Threshold Scholarship",
"type": "integer"
},
"evaluations_self": {
"description": "Evaluations Self",
"type": "integer"
},
"evaluations_student": {
"description": "Evaluations Student",
"type": "integer"
},
"evaluations_annual": {
"description": "Evaluations Annual",
"type": "integer"
},
"evaluations_observation": {
"description": "Evaluations Observation",
"type": "integer"
},
"evaluations_attendance": {
"description": "Evaluations Attendance",
"type": "integer"
},
"sftp_directory": {
"description": "SFTP URL",
"type": "string"
},
"sftp_username": {
"description": "SFTP Username",
"type": "string"
},
"sftp_password": {
"description": "SFTP Password",
"type": "string"
},
"wiki_epic": {
"description": "Wiki Epic",
"type": "string"
}
},
"type": "object"
}
]
},
"User": {
"type": "object",
"allOf": [
{
"required": [
"campus",
"college",
"department",
"role",
"firstname",
"lastname",
"email",
"unique_id"
],
"properties": {
"campus": {
"$ref": "#/components/schemas/Campus"
},
"college": {
"$ref": "#/components/schemas/College"
},
"department": {
"$ref": "#/components/schemas/Department"
},
"role": {
"description": "Access role - determines what type of access user has to system.",
"type": "string"
},
"firstname": {
"description": "First name of user",
"type": "string"
},
"lastname": {
"description": "Last name of user",
"type": "string"
},
"email": {
"description": "Email address of user",
"type": "string"
},
"password": {
"description": "Password",
"type": "string"
},
"address": {
"description": "Address of user",
"type": "string"
},
"city": {
"description": "City of user",
"type": "string"
},
"state": {
"description": "State of user",
"type": "string"
},
"zip": {
"description": "Zip of user",
"type": "string"
},
"phone": {
"description": "Phone number of user",
"type": "string"
},
"unique_id": {
"description": "User unique ID",
"type": "string"
},
"employee_id": {
"description": "Employee Id",
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
}
},
"type": "object"
}
]
}
},
"parameters": {
"filter[]": {
"name": "filter[]",
"in": "query",
"description": "Can be filtered using 'filter' query parameters:\n * `filter[created_between]=date1,date2` | `filter[created_after]=date` | `filter[created_before]=date` | `filter[updated_between]=date1,date2` | `filter[updated_after]=date` | `filter[updated_before]=date`.filter by `created` or `updated` datetimes of object. Dates can be formatted as parsable datetime strings. Preferably [ Internet Date/Time Format](https://tools.ietf.org/html/rfc3339#section-5.6) : ex. `/v1/faculty?filter[created_between]=2021-02-25T21:08:22.325Z,2/1/2022 01:23:45`. filter by `created` or `updated` datetimes of object. Dates can be formatted as parsable datetime strings. Preferably [ Internet Date/Time Format](https://tools.ietf.org/html/rfc3339#section-5.6) : ex. `/v1/faculty?filter[created_between]=2021-02-25T21:08:22.325Z,2/1/2022 01:23:45`\n * Deleted records can be shown in the query by adding the filter: `filter[show_deleted]=true`",
"required": false,
"explode": true
},
"filter_deleted[]": {
"name": "filter_deleted[]",
"in": "query",
"description": "Can be filtered using 'filter' query parameters:\n * Deleted records can be shown in the query by adding the filter: `filter[show_deleted]=true`",
"required": false,
"explode": true
}
}
},
"tags": [
{
"name": "Activity",
"description": "Activity"
},
{
"name": "ActivityStatus",
"description": "ActivityStatus"
},
{
"name": "Attribute",
"description": "Attribute"
},
{
"name": "AttributeLoad",
"description": "AttributeLoad"
},
{
"name": "AttributeRank",
"description": "AttributeRank"
},
{
"name": "AutoStaffingJob",
"description": "AutoStaffingJob"
},
{
"name": "AutoStaffingJobDetail",
"description": "AutoStaffingJobDetail"
},
{
"name": "BulkDataImport",
"description": "BulkDataImport"
},
{
"name": "Campus",
"description": "Campus"
},
{
"name": "College",
"description": "College"
},
{
"name": "Contract",
"description": "Contract"
},
{
"name": "ContractTemplate",
"description": "ContractTemplate"
},
{
"name": "CourseCompensation",
"description": "CourseCompensation"
},
{
"name": "Course",
"description": "Course"
},
{
"name": "CourseOutcome",
"description": "CourseOutcome"
},
{
"name": "CourseReflection",
"description": "CourseReflection"
},
{
"name": "CourseText",
"description": "CourseText"
},
{
"name": "Credential",
"description": "Credential"
},
{
"name": "DaysOff",
"description": "DaysOff"
},
{
"name": "Department",
"description": "Department"
},
{
"name": "Employment",
"description": "Employment"
},
{
"name": "FacultyBaseRate",
"description": "FacultyBaseRate"
},
{
"name": "FacultyCompensation",
"description": "FacultyCompensation"
},
{
"name": "FacltyCompensation",
"description": "FacltyCompensation"
},
{
"name": "Faculty",
"description": "Faculty"
},
{
"name": "FacultyDistinction",
"description": "FacultyDistinction"
},
{
"name": "FacltyDistinction",
"description": "FacltyDistinction"
},
{
"name": "FacultyQualifyingExperience",
"description": "FacultyQualifyingExperience"
},
{
"name": "FacultyQualifyingCredential",
"description": "FacultyQualifyingCredential"
},
{
"name": "FacultyWorkload",
"description": "FacultyWorkload"
},
{
"name": "FacultyJobCode",
"description": "FacultyJobCode"
},
{
"name": "JobGroup",
"description": "JobGroup"
},
{
"name": "JobRole",
"description": "JobRole"
},
{
"name": "Load",
"description": "Load"
},
{
"name": "PdfCvBatch",
"description": "PdfCvBatch"
},
{
"name": "PdfCv",
"description": "PdfCv"
},
{
"name": "PerformanceNotes",
"description": "PerformanceNotes"
},
{
"name": "Pronoun",
"description": "Pronoun"
},
{
"name": "Qualification",
"description": "Qualification"
},
{
"name": "CourseDesignations",
"description": "CourseDesignations"
},
{
"name": "Ethnicities",
"description": "Ethnicities"
},
{
"name": "Gender",
"description": "Gender"
},
{
"name": "LoadStatuses",
"description": "LoadStatuses"
},
{
"name": "QualificationGroups",
"description": "QualificationGroups"
},
{
"name": "Race",
"description": "Race"
},
{
"name": "Rank",
"description": "Rank"
},
{
"name": "Track",
"description": "Track"
},
{
"name": "SiteBasedLearningOrganization",
"description": "SiteBasedLearningOrganization"
},
{
"name": "Staffing",
"description": "Staffing"
},
{
"name": "StaffingInstructor",
"description": "StaffingInstructor"
},
{
"name": "StaffingInstructorDate",
"description": "StaffingInstructorDate"
},
{
"name": "StudentApplicationQuestion",
"description": "StudentApplicationQuestion"
},
{
"name": "Student",
"description": "Student"
},
{
"name": "StudentCourse",
"description": "StudentCourse"
},
{
"name": "Term",
"description": "Term"
},
{
"name": "TimeCardEntry",
"description": "TimeCardEntry"
},
{
"name": "TimeCardPeriod",
"description": "TimeCardPeriod"
},
{
"name": "TimeCardStaffing",
"description": "TimeCardStaffing"
},
{
"name": "User",
"description": "User"
},
{
"name": "FacultyWorkloadAggregate",
"description": "FacultyWorkloadAggregate"
}
],
"security": [
{
"passport": {
"type": "oauth2",
"description": "Oauth2 security.",
"flows": {
"password": {
"tokenUrl": "https://api.aplnexted.com/oauth/token",
"scopes": {
"read:projects": "Grants read access",
"write:projects": "Grants write access"
}
}
}
}
}
]
}