For new APIs and anything being set up for prod services in LEAP TEST and PROD:
-Mark Wiggins will need to set up the service with Netscaler and the DNS Name along with updating or modifying new certificates
-Specifically for the error we were receiving with this, Mark had to modify the certificate in regards to:
- For multi-domain certificates, the option to choose should be 'InCommon Multi Domain SSL (SHA-2)'
- Hostnames listed should also be separated by commas (api.dtw.uconn.edu, api.travel.uconn.edu)
- Mark will also need to know the port
-Specifically for LEAP , any new certificates created will need to be added to WebSphere
-Any new Domain names created will need to be added to WebSphere Whitelist
-Action updated for the method used (GET, POST, PUT, DELETE)
-A useful tool to use for checking the services for any certificate issues is:
https://www.ssllabs.com/ssltest/analyze.html?d=prd.aeweb.uconn.edu
This list is not updated for ETW
| API Resources with paths and parameters (RESTful) | Description | Type | Inputs | Outputs | Applications Utilized *note, some endpoints may exist in applications other than stated, but are not used. |
|---|---|---|---|---|---|
For NetScaler: https://api.finance.uconn.edu/webapi/departments/listDepartments OLD AIX: https://prd.aeweb.uconn.edu:8055/webapi/departments/listDepartments | Returns a list of all KFS Departments | GET | orgCode orgName headNetId location typeName reportsToOrgCd message | EnterpriseFinancialsSystemAccessRequest Concur Role Access Request | |
For NetScaler: https://api.finance.uconn.edu/webapi/departments/findByCode/1515 OLD AIX: https://prd.aeweb.uconn.edu:8055/webapi/departments/findByCode/1515 | Look up orgCode and return department info | GET | orgCode | orgCode orgName headNetId location typeName reportsToOrgCd message headName headEmail title | EnterpriseFinancialsSystemAccessRequest University Expense Card Request Concur Role Access Request |
For NetScaler: https://api.finance.uconn.edu/webapi/ldapSearch/byNetIdorName?netId=pam16105&lastName=Klaben&firstName=James | ldap search with GET method to search LDAP. This search can be done with first/last/NetID and also accepts wild card searches (*). | GET | netId lastName firstName | netId lastName firstName deptName deptNumber phoneNumber fullName | Enterprise Financials System Access - System Review Concur Role Access Request |
| https://api.travel.uconn.edu/travelwebapis/usersSupervisor/byLogin/jtk17003 | Lookup employee information with NetID through the information provided by Core and LDAP. Dylan has a program which combines they information and sends it to the Enterprise Financials table. An array is also maintained where if Thomas Katsouleas is Supervisor, update Supervisor to Michael Kirk (mik05001). If a supervisor is missing, the supervisor will be populated with the department head (if a value exists). | GET | netID | employee / createdBy employee / createdDate employee / updatedBy employee / updatedDate employee / employeeID employee / loginID employee / firstName employee / lastName employee / jobTitle employee / workPhone employee / emailAddress employee / supervisorID employee / terminationDate employee / travelClass employee / travelerType employee / groupHierarchy employee / orgCode1 employee / orgCode2 employee / orgCode3 employee / orgCode4 employee / orgCode5 employee / orgCode6 employee / unionCode employee / exPreqApprover employee / location employee / country employee / address1 employee / address2 employee / address3 employee / address4 employee / city employee / county employee / state employee / postal supervisor / createdBy supervisor / createdDate supervisor / updatedBy supervisor / updatedDate supervisor / employeeID supervisor / loginID supervisor / firstName supervisor / lastName supervisor / jobTitle supervisor / workPhone supervisor / emailAddress supervisor / supervisorID supervisor / terminationDate supervisor / travelClass supervisor / travelerType supervisor / groupHierarchy supervisor / orgCode1 supervisor / orgCode2 supervisor / orgCode3 supervisor / orgCode4 supervisor / orgCode5 supervisor / orgCode6 supervisor / unionCode supervisor / exPreqApprover supervisor / location supervisor / country supervisor / address1 supervisor / address2 supervisor / address3 supervisor / address4 supervisor / city supervisor / county supervisor / state supervisor / postal | University Expense Card Request Concur Role Access Request |
| TBD- not used - https://kualinp.uconn.edu/kfs-dev/huskybuy/disableErpSync | Accepts XML POST to disable HuskyBuy supplier ERP Sync in HuskyBuy **requires the sharedsecret to be passed which HuskyBuy needs for verification** | POST | supplierID supplierName | TestSupplierSyncDeactivation | |
For NetScaler: https://api.finance.uconn.edu/webapi/generatePaymentReport DEV: https://dev.api.finance.uconn.edu/webapi/generatePaymentReport PRD: https://prd.aeweb.uconn.edu:8055/webapi/generatePaymentReport | Accepts XMLHTTPRequest object array and returns blob data type. | POST | monthEnding companyName projectName awardingAgencyName projectNumber smbe mobilizationDate projectValue percentComplete finalReport completionDate reportEntryDate printedAuthorizedSignature //texbox array list for table company dasCode contractAmount monthlyPayment paymentToDate | USDP Status Report System | |
https://dev.api.dtw.uconn.edu/dtwwebapi/requesterEligibility | Checks eligibility of employee when submitting form. | GET | employeeNetId | { "employeeEligible": true, "barganingUnit": "UCPEA", "currTerm": "Fall 2020", "message": "" } Invalid: { "employeeEligible": false, "barganingUnit": "”", "currTerm": "", "message": "Could not retrieve your information using your netid } | |
| https://dev.api.dtw.uconn.edu/dtwwebapi/currentTerm | Gets current term and activation date set in Options page of DTW | GET | { "term": "Fall 2020", "activationDate": "06/01/2020" } | ||
| https://dev.api.dtw.uconn.edu/dtwwebapi/initiateDtwRequest | Creates record in DTW DB using LEAP record ID from form creation. | GET |
| { "employeeName": "Jennifer Walkerr", "barganingUnit": "CONF", "employeeEligible": true, "studentName": "Bustamante,Antonio ", "studentCampus": "Avery Pt", "term": "1208", "termDescr": "Fall 2020", "requestType": "O", "message": "Depend Tuition Waiver 338373-ef353-3737for Jennifer Walkerradded to database", "success": true } | |
| Gets tuition waiver (not currently used in LEAP DTW App) | GET | requestId | { "waiver": { "requestId": "36 digit ID", "reqType": "O", "employeeName": "J Warr", "employeeNo": "2892314", "employeePayId": "479309", "employeeNetId": "jew19000", "employeeEmail": "j.wr@uconn.edu", "employeeDept": "University Communications", "employeeDeptNo": "1700", "employeePhone": "none", "employeeUnion": "03", "studentID": "1234567", "studentNetId": "N/A", "studentName": "Bustae, A ", "studentSemesterStanding": "Senior", "studentSemesterCode": "1208", "studentEmail": "AO.TE@UCONN.EDU", "studentPhone": "", "studentCampus": "Avery Pt", "studentWaiverTerm": "1208", "studentWaiverTermDesc": "Fall 2020", "studentInfoInputManually": "no", "percentEligible": "0", "waiverAmount": "", "employeeComments": "hope this works too", "comments": "hope this works too", "hr2Comments": null, "bursarComments": null, "requestDate": "2020-09-16", "exportDate": null, "finalizeDate": null, "requestStatus": "initiated", "fromHealthCenter": false }, | ||
| Checks Student ID and DOB for eligibility | GET | studentId studentBirthDate | Eligible { "studentId": "1234567", "studentBirthDate": "07/03/2000", "eligible": true, "newAdmit": false, "message": "" } Net admit { "studentId": "123456", "studentBirthDate": "07/03/2003", "eligible": false, "newAdmit": true, "message": "new admit message" } Ferpa { "studentId": "12345", "studentBirthDate": "07/03/2003", "eligible": false, "newAdmit": true, "message": " Access denied. Parent should contact dependent child regarding this Student ID " } | ||
https://dev.api.dtw.uconn.edu/dtwwebapi/approveTuitionWaiver | For when HR approves waiver | GET | requestId group (name of HR approval group) DTW-HR1 DTW-HR2 DTW-HR4HC comments percentEligible | { "action": "approve", "group": "HR!", "message": "" } | |
| https://dev.api.dtw.uconn.edu/dtwwebapi/approveTuitionWaiver | For when HR Denies waiver | GET | requestId group (name of HR approval group) DTW-HR1 DTW-HR2 DTW-HR4HC comments percentEligible | { "action": "deny", "group": "HR!", "message": "" } | |
https://dev.api.dtw.uconn.edu/dtwwebapi/admin/waiversToExport | To populate waivers to Export in Bursar's Office window (100% waivers) | GET | { "waiverLst": [ { "requestId": "a1f17e1b-5ae0-4574-8a72-544255c777aa", "percentEligible": "0", "studentName": "Paterson,Aiden Morgan", "studentID": "2812560", "studentWaiverTermCd": "1208", "studentWaiverTerm": "Fall 2020", "employeeName": "James T Klaben", "fromHealthCenter": true }, { "requestId": "520346d7-b999-4a07-8987-54645eb1cc7d", "percentEligible": "0", "studentName": "Paterson,Aiden Morgan", "studentID": "2812560", "studentWaiverTermCd": "1208", "studentWaiverTerm": "Fall 2020", "employeeName": "James T Klaben", "fromHealthCenter": true } ], "message": "" } | ||
https://dev.api.dtw.uconn.edu/dtwwebapi/admin/ waiversToComplete | To get list of waivers that need completing (100%, less than 100) | GET | { "waiverLst": [ { "requestId": "a1f17e1b-5ae0-4574-8a72-544255c777aa", "percentEligible": "0", "studentName": "Paterson,Aiden Morgan", "studentID": "2812560", "studentWaiverTermCd": "1208", "studentWaiverTerm": "Fall 2020", "employeeName": "James T Klaben", "fromHealthCenter": true }, { "requestId": "520346d7-b999-4a07-8987-54645eb1cc7d", "percentEligible": "0", "studentName": "Paterson,Aiden Morgan", "studentID": "2812560", "studentWaiverTermCd": "1208", "studentWaiverTerm": "Fall 2020", "employeeName": "James T Klaben", "fromHealthCenter": true } ], "message": "" } | ||
| Bursar's Office Option to export Waivers on Export page | POST |
| {"procssedList": [{"waiverId":"a9218772-1de3-486f-8a60-cc5d417a7f8d","employee":"Garrett C Heinze","student":"Johnson,Julia Rachael"}, {"waiverId":"4bbb3002-ac30-4b3e-8d80-f99cd6bd0cda","employee":"Jeffrey Burke","student":"Burke,Ethan James"}, {"waiverId":"338373-ef353-3737","employee":"Jennifer Walkerr","student":"Bustamante,Antonio "}], "message":"success"} | ||
https://dev.api.dtw.uconn.edu/dtwwebapi/admin/completeWaivers | Bursar's Office option to complete waivers on Final page | POST |
| {"procssedList": [{"waiverId":"a9218772-1de3-486f-8a60-cc5d417a7f8d","employee":"Garrett C Heinze","student":"Johnson,Julia Rachael"}, {"waiverId":"4bbb3002-ac30-4b3e-8d80-f99cd6bd0cda","employee":"Jeffrey Burke","student":"Burke,Ethan James"}, {"waiverId":"338373-ef353-3737","employee":"Jennifer Walkerr","student":"Bustamante,Antonio "}], "message":"success"} | |
| Bursar's Office option to reject waivers on Final page | POST |
| { "action": "reject", "group": “DTW-ADMIN", "message": "success" } | ||
https://dev.api.dtw.uconn.edu/dtwwebapi/admin/reportByEmployee | GET |
| { "reportData": [ { "employeeName": "James T Klaben", "employeeNbr": "1234567", "employeePhone": "860-486-3779", "studentName": "Paon,Ain Morgan", "studentId": "1234567", "term": "1208", "termDescr": "Fall 2020", "percent": "0", "status": "finalApproval", "requestDate": "2020-06-24", "exportDate": null, "completionDate": null, "bargainingUnit": "29" }, { "employeeName": "James T Klaben", "employeeNbr": "2697253", "studentName": "Patn,Ai Moan", "studentId": "1234567", "termDescr": "Fall 2020", "percent": "0", "status": "finalApproval", "requestDate": "2020-06-24", "exportDate": null, "completionDate": null, "bargainingUnit": "29" } | ||
https://dev.api.dtw.uconn.edu/dtwwebapi/admin/reportByStudent | GET |
| |||
| GET |
| ||||
| https://dev.api.dtw.uconn.edu/dtwwebapi/admin/rgetDtwUnions | GET | { "response": [ "All Units", "MNGR", "CONF", "AAUP", "UCPEA", "LAW", "UCHC-MNGR", "UCHC-CONF", "UCHC-FACULTY", "UCHC-UHP" ], "message": null } | |||
| GET |
| { "summaryLst": [ { "requestId": "a9218772-1de3-486f-8a60-cc5d417a7f8d", "employee": "James T Klaben", "student": "Json,Julia Rael", "term": "Fall 2020", "status": "Waiver initiated", "requestDate": "2020-07-16", "comments": "test", "hrComments": "test", "hr2Comments": "test approval", "bursarComments": null, "percent": "100" }], "message": "success" } | |||
| https://dev.api.dtw.uconn.edu/dtwwebapi/dtwWorkflow?approverNetIds=jtk17003,dac04010&group=DTW-HR1&requestId=48e5e641-a078-4913-833f-e037f463194e | Set the next group and user NetIds to be notified of action needed on their part. also sets scheduled reminder emails. | GET | approverNetIds group requestID | ||
| https://dev.api.dtw.uconn.edu/dtwwebapi/admin/reports/retrieveReportFile?reportType=Term&adminNetId=jtk17003 | does not require auth header. Emails report. | GET | |||
| https://dev.api.dtw.uconn.edu/dtwwebapi/transferWaiver?waiverId=123456789&requestType=H | updates employer (UCH vs UConn) of what action list the waiver is in. | GET | waiverId requestType (H or O) |