From 58c3250b191d0a04dfe98cf2a785842025f45e7d Mon Sep 17 00:00:00 2001
From: SAM CARPENTER <sam.carpenter@wisc.edu>
Date: Thu, 20 Feb 2025 14:31:15 -0600
Subject: [PATCH] create swagger file with modular URL for caseiq
---
EI-IICS-Team/Compliance_CaseIQ/getPeople.json | 546 ------------------
.../Compliance_CaseIQ/getPersonNoJob.json | 370 ++++++++++++
2 files changed, 370 insertions(+), 546 deletions(-)
delete mode 100644 EI-IICS-Team/Compliance_CaseIQ/getPeople.json
create mode 100644 EI-IICS-Team/Compliance_CaseIQ/getPersonNoJob.json
diff --git a/EI-IICS-Team/Compliance_CaseIQ/getPeople.json b/EI-IICS-Team/Compliance_CaseIQ/getPeople.json
deleted file mode 100644
index 81a6159..0000000
--- a/EI-IICS-Team/Compliance_CaseIQ/getPeople.json
+++ /dev/null
@@ -1,546 +0,0 @@
-{
- "swagger" : "2.0",
- "info" : {
- "description" : null,
- "version" : "1.0.0",
- "title" : null,
- "termsOfService" : null,
- "contact" : null,
- "license" : null
- },
- "host" : "api.wisc.edu",
- "basePath" : "/people",
- "schemes" : [ "https" ],
- "paths" : {
- "/" : {
- "get" : {
- "tags" : [ "getPeople" ],
- "summary" : null,
- "description" : null,
- "operationId" : "getPeople",
- "produces" : [ "application/json" ],
- "consumes" : [ "application/json" ],
- "parameters" : [ {
- "name" : "include",
- "in" : "query",
- "description" : null,
- "required" : false,
- "type" : "string"
- }, {
- "name" : "filter[identifiers.value]",
- "in" : "query",
- "description" : null,
- "required" : false,
- "type" : "string"
- }, {
- "name" : "filter[identifiers.name]",
- "in" : "query",
- "description" : null,
- "required" : false,
- "type" : "string"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation",
- "schema" : {
- "$ref" : "#/definitions/getPeople"
- }
- }
- }
- }
- }
- },
- "definitions" : {
- "getPeople##data##attributes" : {
- "properties" : {
- "emailAddress" : {
- "type" : "string"
- },
- "firstName" : {
- "type" : "string"
- },
- "lastName" : {
- "type" : "string"
- },
- "officeAddress" : {
- "type" : "string"
- },
- "officePhoneNumber" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##links" : {
- "properties" : {
- "self" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##meta" : {
- "properties" : {
- "ferpa" : {
- "type" : "boolean"
- }
- }
- },
- "getPeople##data##relationships##addresses##data" : {
- "properties" : {
- "id" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##relationships##addresses##links" : {
- "properties" : {
- "related" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##relationships##addresses" : {
- "properties" : {
- "data" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/getPeople##data##relationships##addresses##data"
- }
- },
- "links" : {
- "$ref" : "#/definitions/getPeople##data##relationships##addresses##links"
- }
- }
- },
- "getPeople##data##relationships##affiliations##links" : {
- "properties" : {
- "related" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##relationships##affiliations" : {
- "properties" : {
- "data" : {
- "type" : "string"
- },
- "links" : {
- "$ref" : "#/definitions/getPeople##data##relationships##affiliations##links"
- }
- }
- },
- "getPeople##data##relationships##emailAddresses##data" : {
- "properties" : {
- "id" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##relationships##emailAddresses##links" : {
- "properties" : {
- "related" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##relationships##emailAddresses" : {
- "properties" : {
- "data" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/getPeople##data##relationships##emailAddresses##data"
- }
- },
- "links" : {
- "$ref" : "#/definitions/getPeople##data##relationships##emailAddresses##links"
- }
- }
- },
- "getPeople##data##relationships##identifiers##data" : {
- "properties" : {
- "id" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##relationships##identifiers##links" : {
- "properties" : {
- "related" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##relationships##identifiers" : {
- "properties" : {
- "data" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/getPeople##data##relationships##identifiers##data"
- }
- },
- "links" : {
- "$ref" : "#/definitions/getPeople##data##relationships##identifiers##links"
- }
- }
- },
- "getPeople##data##relationships##jobs##data" : {
- "properties" : {
- "id" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##relationships##jobs##links" : {
- "properties" : {
- "related" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##relationships##jobs" : {
- "properties" : {
- "data" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/getPeople##data##relationships##jobs##data"
- }
- },
- "links" : {
- "$ref" : "#/definitions/getPeople##data##relationships##jobs##links"
- }
- }
- },
- "getPeople##data##relationships##names##data" : {
- "properties" : {
- "id" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##relationships##names##links" : {
- "properties" : {
- "related" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##relationships##names" : {
- "properties" : {
- "data" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/getPeople##data##relationships##names##data"
- }
- },
- "links" : {
- "$ref" : "#/definitions/getPeople##data##relationships##names##links"
- }
- }
- },
- "getPeople##data##relationships##phoneNumbers##links" : {
- "properties" : {
- "related" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##relationships##phoneNumbers" : {
- "properties" : {
- "data" : {
- "type" : "string"
- },
- "links" : {
- "$ref" : "#/definitions/getPeople##data##relationships##phoneNumbers##links"
- }
- }
- },
- "getPeople##data##relationships##wiscard##data" : {
- "properties" : {
- "id" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##relationships##wiscard##links" : {
- "properties" : {
- "related" : {
- "type" : "string"
- }
- }
- },
- "getPeople##data##relationships##wiscard" : {
- "properties" : {
- "data" : {
- "$ref" : "#/definitions/getPeople##data##relationships##wiscard##data"
- },
- "links" : {
- "$ref" : "#/definitions/getPeople##data##relationships##wiscard##links"
- }
- }
- },
- "getPeople##data##relationships" : {
- "properties" : {
- "addresses" : {
- "$ref" : "#/definitions/getPeople##data##relationships##addresses"
- },
- "affiliations" : {
- "$ref" : "#/definitions/getPeople##data##relationships##affiliations"
- },
- "emailAddresses" : {
- "$ref" : "#/definitions/getPeople##data##relationships##emailAddresses"
- },
- "identifiers" : {
- "$ref" : "#/definitions/getPeople##data##relationships##identifiers"
- },
- "jobs" : {
- "$ref" : "#/definitions/getPeople##data##relationships##jobs"
- },
- "names" : {
- "$ref" : "#/definitions/getPeople##data##relationships##names"
- },
- "phoneNumbers" : {
- "$ref" : "#/definitions/getPeople##data##relationships##phoneNumbers"
- },
- "wiscard" : {
- "$ref" : "#/definitions/getPeople##data##relationships##wiscard"
- }
- }
- },
- "getPeople##data" : {
- "properties" : {
- "attributes" : {
- "$ref" : "#/definitions/getPeople##data##attributes"
- },
- "id" : {
- "type" : "string"
- },
- "links" : {
- "$ref" : "#/definitions/getPeople##data##links"
- },
- "meta" : {
- "$ref" : "#/definitions/getPeople##data##meta"
- },
- "relationships" : {
- "$ref" : "#/definitions/getPeople##data##relationships"
- },
- "type" : {
- "type" : "string"
- }
- }
- },
- "getPeople##included##attributes" : {
- "properties" : {
- "action" : {
- "type" : "string"
- },
- "actionReason" : {
- "type" : "string"
- },
- "beginDate" : {
- "type" : "string"
- },
- "businessTitle" : {
- "type" : "string"
- },
- "costCenterId" : {
- "type" : "string"
- },
- "costCenterName" : {
- "type" : "string"
- },
- "current" : {
- "type" : "boolean"
- },
- "departmentUnit" : {
- "type" : "string"
- },
- "division" : {
- "type" : "string"
- },
- "divisionCode" : {
- "type" : "string"
- },
- "effectiveDate" : {
- "type" : "string"
- },
- "employeeCategory" : {
- "type" : "string"
- },
- "employeeCategoryCode" : {
- "type" : "string"
- },
- "endDate" : {
- "type" : "string"
- },
- "fullTimeEquivalent" : {
- "type" : "string"
- },
- "institution" : {
- "type" : "string"
- },
- "jobCode" : {
- "type" : "string"
- },
- "locationId" : {
- "type" : "string"
- },
- "managedSupervisoryOrganizationIds" : {
- "type" : "string"
- },
- "payBasis" : {
- "type" : "string"
- },
- "position" : {
- "type" : "string"
- },
- "primary" : {
- "type" : "boolean"
- },
- "relatedSupervisoryOrganizationIds" : {
- "type" : "string"
- },
- "source" : {
- "type" : "string"
- },
- "supervisoryOrganizationCode" : {
- "type" : "string"
- },
- "supervisoryOrganizationId" : {
- "type" : "string"
- },
- "supervisoryOrganizationName" : {
- "type" : "string"
- },
- "title" : {
- "type" : "string"
- },
- "workspaceId" : {
- "type" : "string"
- }
- }
- },
- "getPeople##included##relationships##person##data" : {
- "properties" : {
- "id" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- }
- }
- },
- "getPeople##included##relationships##person##links" : {
- "properties" : {
- "related" : {
- "type" : "string"
- }
- }
- },
- "getPeople##included##relationships##person" : {
- "properties" : {
- "data" : {
- "$ref" : "#/definitions/getPeople##included##relationships##person##data"
- },
- "links" : {
- "$ref" : "#/definitions/getPeople##included##relationships##person##links"
- }
- }
- },
- "getPeople##included##relationships##supervisor##data" : {
- "properties" : {
- "id" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- }
- }
- },
- "getPeople##included##relationships##supervisor##links" : {
- "properties" : {
- "related" : {
- "type" : "string"
- }
- }
- },
- "getPeople##included##relationships##supervisor" : {
- "properties" : {
- "data" : {
- "$ref" : "#/definitions/getPeople##included##relationships##supervisor##data"
- },
- "links" : {
- "$ref" : "#/definitions/getPeople##included##relationships##supervisor##links"
- }
- }
- },
- "getPeople##included##relationships" : {
- "properties" : {
- "person" : {
- "$ref" : "#/definitions/getPeople##included##relationships##person"
- },
- "supervisor" : {
- "$ref" : "#/definitions/getPeople##included##relationships##supervisor"
- }
- }
- },
- "getPeople##included" : {
- "properties" : {
- "attributes" : {
- "$ref" : "#/definitions/getPeople##included##attributes"
- },
- "id" : {
- "type" : "string"
- },
- "relationships" : {
- "$ref" : "#/definitions/getPeople##included##relationships"
- },
- "type" : {
- "type" : "string"
- }
- }
- },
- "getPeople##links" : {
- "properties" : {
- "self" : {
- "type" : "string"
- }
- }
- },
- "getPeople" : {
- "properties" : {
- "data" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/getPeople##data"
- }
- },
- "included" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/getPeople##included"
- }
- },
- "links" : {
- "$ref" : "#/definitions/getPeople##links"
- }
- }
- }
- }
-}
\ No newline at end of file
diff --git a/EI-IICS-Team/Compliance_CaseIQ/getPersonNoJob.json b/EI-IICS-Team/Compliance_CaseIQ/getPersonNoJob.json
new file mode 100644
index 0000000..9067242
--- /dev/null
+++ b/EI-IICS-Team/Compliance_CaseIQ/getPersonNoJob.json
@@ -0,0 +1,370 @@
+{
+ "swagger" : "2.0",
+ "info" : {
+ "description" : null,
+ "version" : "1.0.0",
+ "title" : null,
+ "termsOfService" : null,
+ "contact" : null,
+ "license" : null
+ },
+ "host" : "api.wisc.edu",
+ "basePath" : "/people",
+ "schemes" : [ "https" ],
+ "paths" : {
+ "/{personapiid}" : {
+ "get" : {
+ "tags" : [ "getPerson" ],
+ "summary" : null,
+ "description" : null,
+ "operationId" : "getPerson",
+ "produces" : [ "application/json" ],
+ "consumes" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "personapiid",
+ "in" : "path",
+ "description" : null,
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/getPerson"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions" : {
+ "getPerson##data##attributes" : {
+ "properties" : {
+ "continuousServiceDate" : {
+ "type" : "string"
+ },
+ "emailAddress" : {
+ "type" : "string"
+ },
+ "firstName" : {
+ "type" : "string"
+ },
+ "lastName" : {
+ "type" : "string"
+ },
+ "officeAddress" : {
+ "type" : "string"
+ },
+ "officePhoneNumber" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##links" : {
+ "properties" : {
+ "self" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##meta" : {
+ "properties" : {
+ "ferpa" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "getPerson##data##relationships##addresses##data" : {
+ "properties" : {
+ "id" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##relationships##addresses##links" : {
+ "properties" : {
+ "related" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##relationships##addresses" : {
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##addresses##data"
+ }
+ },
+ "links" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##addresses##links"
+ }
+ }
+ },
+ "getPerson##data##relationships##affiliations##links" : {
+ "properties" : {
+ "related" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##relationships##affiliations" : {
+ "properties" : {
+ "data" : {
+ "type" : "string"
+ },
+ "links" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##affiliations##links"
+ }
+ }
+ },
+ "getPerson##data##relationships##emailAddresses##data" : {
+ "properties" : {
+ "id" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##relationships##emailAddresses##links" : {
+ "properties" : {
+ "related" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##relationships##emailAddresses" : {
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##emailAddresses##data"
+ }
+ },
+ "links" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##emailAddresses##links"
+ }
+ }
+ },
+ "getPerson##data##relationships##identifiers##data" : {
+ "properties" : {
+ "id" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##relationships##identifiers##links" : {
+ "properties" : {
+ "related" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##relationships##identifiers" : {
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##identifiers##data"
+ }
+ },
+ "links" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##identifiers##links"
+ }
+ }
+ },
+ "getPerson##data##relationships##jobs##data" : {
+ "properties" : {
+ "id" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##relationships##jobs##links" : {
+ "properties" : {
+ "related" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##relationships##jobs" : {
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##jobs##data"
+ }
+ },
+ "links" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##jobs##links"
+ }
+ }
+ },
+ "getPerson##data##relationships##names##data" : {
+ "properties" : {
+ "id" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##relationships##names##links" : {
+ "properties" : {
+ "related" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##relationships##names" : {
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##names##data"
+ }
+ },
+ "links" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##names##links"
+ }
+ }
+ },
+ "getPerson##data##relationships##phoneNumbers##data" : {
+ "properties" : {
+ "id" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##relationships##phoneNumbers##links" : {
+ "properties" : {
+ "related" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##relationships##phoneNumbers" : {
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##phoneNumbers##data"
+ }
+ },
+ "links" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##phoneNumbers##links"
+ }
+ }
+ },
+ "getPerson##data##relationships##wiscard##data" : {
+ "properties" : {
+ "id" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##relationships##wiscard##links" : {
+ "properties" : {
+ "related" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##data##relationships##wiscard" : {
+ "properties" : {
+ "data" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##wiscard##data"
+ },
+ "links" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##wiscard##links"
+ }
+ }
+ },
+ "getPerson##data##relationships" : {
+ "properties" : {
+ "addresses" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##addresses"
+ },
+ "affiliations" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##affiliations"
+ },
+ "emailAddresses" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##emailAddresses"
+ },
+ "identifiers" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##identifiers"
+ },
+ "jobs" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##jobs"
+ },
+ "names" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##names"
+ },
+ "phoneNumbers" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##phoneNumbers"
+ },
+ "wiscard" : {
+ "$ref" : "#/definitions/getPerson##data##relationships##wiscard"
+ }
+ }
+ },
+ "getPerson##data" : {
+ "properties" : {
+ "attributes" : {
+ "$ref" : "#/definitions/getPerson##data##attributes"
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "links" : {
+ "$ref" : "#/definitions/getPerson##data##links"
+ },
+ "meta" : {
+ "$ref" : "#/definitions/getPerson##data##meta"
+ },
+ "relationships" : {
+ "$ref" : "#/definitions/getPerson##data##relationships"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson##links" : {
+ "properties" : {
+ "self" : {
+ "type" : "string"
+ }
+ }
+ },
+ "getPerson" : {
+ "properties" : {
+ "data" : {
+ "$ref" : "#/definitions/getPerson##data"
+ },
+ "links" : {
+ "$ref" : "#/definitions/getPerson##links"
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
--
GitLab