Skip to content
Snippets Groups Projects
Commit 58c3250b authored by SAM CARPENTER's avatar SAM CARPENTER
Browse files

create swagger file with modular URL for caseiq

parent 142124c7
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
EI-IICS-Team/Compliance_CaseIQ/getPeople.json → EI-IICS-Team/Compliance_CaseIQ/getPersonNoJob.json
+ 370
− 0
View file @ 58c3250b
......@@ -12,38 +12,26 @@
"basePath" : "/people",
"schemes" : [ "https" ],
"paths" : {
"/" : {
"/{personapiid}" : {
"get" : {
"tags" : [ "getPeople" ],
"tags" : [ "getPerson" ],
"summary" : null,
"description" : null,
"operationId" : "getPeople",
"operationId" : "getPerson",
"produces" : [ "application/json" ],
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "include",
"in" : "query",
"name" : "personapiid",
"in" : "path",
"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,
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/getPeople"
"$ref" : "#/definitions/getPerson"
}
}
}
......@@ -51,8 +39,11 @@
}
},
"definitions" : {
"getPeople##data##attributes" : {
"getPerson##data##attributes" : {
"properties" : {
"continuousServiceDate" : {
"type" : "string"
},
"emailAddress" : {
"type" : "string"
},
......@@ -70,21 +61,21 @@
}
}
},
"getPeople##data##links" : {
"getPerson##data##links" : {
"properties" : {
"self" : {
"type" : "string"
}
}
},
"getPeople##data##meta" : {
"getPerson##data##meta" : {
"properties" : {
"ferpa" : {
"type" : "boolean"
}
}
},
"getPeople##data##relationships##addresses##data" : {
"getPerson##data##relationships##addresses##data" : {
"properties" : {
"id" : {
"type" : "string"
......@@ -94,44 +85,44 @@
}
}
},
"getPeople##data##relationships##addresses##links" : {
"getPerson##data##relationships##addresses##links" : {
"properties" : {
"related" : {
"type" : "string"
}
}
},
"getPeople##data##relationships##addresses" : {
"getPerson##data##relationships##addresses" : {
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/getPeople##data##relationships##addresses##data"
"$ref" : "#/definitions/getPerson##data##relationships##addresses##data"
}
},
"links" : {
"$ref" : "#/definitions/getPeople##data##relationships##addresses##links"
"$ref" : "#/definitions/getPerson##data##relationships##addresses##links"
}
}
},
"getPeople##data##relationships##affiliations##links" : {
"getPerson##data##relationships##affiliations##links" : {
"properties" : {
"related" : {
"type" : "string"
}
}
},
"getPeople##data##relationships##affiliations" : {
"getPerson##data##relationships##affiliations" : {
"properties" : {
"data" : {
"type" : "string"
},
"links" : {
"$ref" : "#/definitions/getPeople##data##relationships##affiliations##links"
"$ref" : "#/definitions/getPerson##data##relationships##affiliations##links"
}
}
},
"getPeople##data##relationships##emailAddresses##data" : {
"getPerson##data##relationships##emailAddresses##data" : {
"properties" : {
"id" : {
"type" : "string"
......@@ -141,27 +132,27 @@
}
}
},
"getPeople##data##relationships##emailAddresses##links" : {
"getPerson##data##relationships##emailAddresses##links" : {
"properties" : {
"related" : {
"type" : "string"
}
}
},
"getPeople##data##relationships##emailAddresses" : {
"getPerson##data##relationships##emailAddresses" : {
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/getPeople##data##relationships##emailAddresses##data"
"$ref" : "#/definitions/getPerson##data##relationships##emailAddresses##data"
}
},
"links" : {
"$ref" : "#/definitions/getPeople##data##relationships##emailAddresses##links"
"$ref" : "#/definitions/getPerson##data##relationships##emailAddresses##links"
}
}
},
"getPeople##data##relationships##identifiers##data" : {
"getPerson##data##relationships##identifiers##data" : {
"properties" : {
"id" : {
"type" : "string"
......@@ -171,27 +162,27 @@
}
}
},
"getPeople##data##relationships##identifiers##links" : {
"getPerson##data##relationships##identifiers##links" : {
"properties" : {
"related" : {
"type" : "string"
}
}
},
"getPeople##data##relationships##identifiers" : {
"getPerson##data##relationships##identifiers" : {
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/getPeople##data##relationships##identifiers##data"
"$ref" : "#/definitions/getPerson##data##relationships##identifiers##data"
}
},
"links" : {
"$ref" : "#/definitions/getPeople##data##relationships##identifiers##links"
"$ref" : "#/definitions/getPerson##data##relationships##identifiers##links"
}
}
},
"getPeople##data##relationships##jobs##data" : {
"getPerson##data##relationships##jobs##data" : {
"properties" : {
"id" : {
"type" : "string"
......@@ -201,27 +192,27 @@
}
}
},
"getPeople##data##relationships##jobs##links" : {
"getPerson##data##relationships##jobs##links" : {
"properties" : {
"related" : {
"type" : "string"
}
}
},
"getPeople##data##relationships##jobs" : {
"getPerson##data##relationships##jobs" : {
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/getPeople##data##relationships##jobs##data"
"$ref" : "#/definitions/getPerson##data##relationships##jobs##data"
}
},
"links" : {
"$ref" : "#/definitions/getPeople##data##relationships##jobs##links"
"$ref" : "#/definitions/getPerson##data##relationships##jobs##links"
}
}
},
"getPeople##data##relationships##names##data" : {
"getPerson##data##relationships##names##data" : {
"properties" : {
"id" : {
"type" : "string"
......@@ -231,44 +222,57 @@
}
}
},
"getPeople##data##relationships##names##links" : {
"getPerson##data##relationships##names##links" : {
"properties" : {
"related" : {
"type" : "string"
}
}
},
"getPeople##data##relationships##names" : {
"getPerson##data##relationships##names" : {
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/getPeople##data##relationships##names##data"
"$ref" : "#/definitions/getPerson##data##relationships##names##data"
}
},
"links" : {
"$ref" : "#/definitions/getPeople##data##relationships##names##links"
"$ref" : "#/definitions/getPerson##data##relationships##names##links"
}
}
},
"getPeople##data##relationships##phoneNumbers##links" : {
"getPerson##data##relationships##phoneNumbers##data" : {
"properties" : {
"id" : {
"type" : "string"
},
"type" : {
"type" : "string"
}
}
},
"getPerson##data##relationships##phoneNumbers##links" : {
"properties" : {
"related" : {
"type" : "string"
}
}
},
"getPeople##data##relationships##phoneNumbers" : {
"getPerson##data##relationships##phoneNumbers" : {
"properties" : {
"data" : {
"type" : "string"
"type" : "array",
"items" : {
"$ref" : "#/definitions/getPerson##data##relationships##phoneNumbers##data"
}
},
"links" : {
"$ref" : "#/definitions/getPeople##data##relationships##phoneNumbers##links"
"$ref" : "#/definitions/getPerson##data##relationships##phoneNumbers##links"
}
}
},
"getPeople##data##relationships##wiscard##data" : {
"getPerson##data##relationships##wiscard##data" : {
"properties" : {
"id" : {
"type" : "string"
......@@ -278,267 +282,87 @@
}
}
},
"getPeople##data##relationships##wiscard##links" : {
"getPerson##data##relationships##wiscard##links" : {
"properties" : {
"related" : {
"type" : "string"
}
}
},
"getPeople##data##relationships##wiscard" : {
"getPerson##data##relationships##wiscard" : {
"properties" : {
"data" : {
"$ref" : "#/definitions/getPeople##data##relationships##wiscard##data"
"$ref" : "#/definitions/getPerson##data##relationships##wiscard##data"
},
"links" : {
"$ref" : "#/definitions/getPeople##data##relationships##wiscard##links"
"$ref" : "#/definitions/getPerson##data##relationships##wiscard##links"
}
}
},
"getPeople##data##relationships" : {
"getPerson##data##relationships" : {
"properties" : {
"addresses" : {
"$ref" : "#/definitions/getPeople##data##relationships##addresses"
"$ref" : "#/definitions/getPerson##data##relationships##addresses"
},
"affiliations" : {
"$ref" : "#/definitions/getPeople##data##relationships##affiliations"
"$ref" : "#/definitions/getPerson##data##relationships##affiliations"
},
"emailAddresses" : {
"$ref" : "#/definitions/getPeople##data##relationships##emailAddresses"
"$ref" : "#/definitions/getPerson##data##relationships##emailAddresses"
},
"identifiers" : {
"$ref" : "#/definitions/getPeople##data##relationships##identifiers"
"$ref" : "#/definitions/getPerson##data##relationships##identifiers"
},
"jobs" : {
"$ref" : "#/definitions/getPeople##data##relationships##jobs"
"$ref" : "#/definitions/getPerson##data##relationships##jobs"
},
"names" : {
"$ref" : "#/definitions/getPeople##data##relationships##names"
"$ref" : "#/definitions/getPerson##data##relationships##names"
},
"phoneNumbers" : {
"$ref" : "#/definitions/getPeople##data##relationships##phoneNumbers"
"$ref" : "#/definitions/getPerson##data##relationships##phoneNumbers"
},
"wiscard" : {
"$ref" : "#/definitions/getPeople##data##relationships##wiscard"
"$ref" : "#/definitions/getPerson##data##relationships##wiscard"
}
}
},
"getPeople##data" : {
"getPerson##data" : {
"properties" : {
"attributes" : {
"$ref" : "#/definitions/getPeople##data##attributes"
"$ref" : "#/definitions/getPerson##data##attributes"
},
"id" : {
"type" : "string"
},
"links" : {
"$ref" : "#/definitions/getPeople##data##links"
"$ref" : "#/definitions/getPerson##data##links"
},
"meta" : {
"$ref" : "#/definitions/getPeople##data##meta"
"$ref" : "#/definitions/getPerson##data##meta"
},
"relationships" : {
"$ref" : "#/definitions/getPeople##data##relationships"
"$ref" : "#/definitions/getPerson##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" : {
"getPerson##links" : {
"properties" : {
"self" : {
"type" : "string"
}
}
},
"getPeople" : {
"getPerson" : {
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/getPeople##data"
}
},
"included" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/getPeople##included"
}
"$ref" : "#/definitions/getPerson##data"
},
"links" : {
"$ref" : "#/definitions/getPeople##links"
"$ref" : "#/definitions/getPerson##links"
}
}
}
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment