openapi: 3.0.0 info: description: UCOATS Export specs version: 1.0.0 title: UCOATS servers: - url: 'https://dev-juan06.ctrl.ucla.edu/ucla-ws/ws/v1/export/' description: UCOATS Site tags: - name: Faculty Single description: Endpoints to get the data of a single Faculty - name: Faculty All description: Endpoints to get the data of all Faculty paths: '/app/facultyInfo/email/{email}/{fiscal_year}': get: tags: - Faculty Single summary: Get Faculty Data by email description: Get Faculty Data by email in a specific Fiscal Year parameters: - name: email in: path description: Email of the faculty required: true schema: type: string format: email - name: fiscal_year in: path description: Fiscal Year to get the data from. Format XXXX-YYYY required: true schema: type: string responses: '200': description: OK content: application/json: schema: anyOf: - $ref: '#/components/schemas/FacultyDataSingleResponseSuccess' - $ref: '#/components/schemas/FacultyEmailNotFound' '/app/facultyInfo/ucpathID/{ucpath_id}/{fiscal_year}': get: tags: - Faculty Single summary: Get Faculty Data by UCPath ID description: Get Faculty Data by UCPath ID in a specific Fiscal Year parameters: - name: ucpath_id in: path description: UCPath ID of the faculty required: true schema: type: string - name: fiscal_year in: path description: Fiscal Year to get the data from. Format XXXX-YYYY required: true schema: type: string responses: '200': description: OK content: application/json: schema: anyOf: - $ref: '#/components/schemas/FacultyDataSingleResponseSuccess' - $ref: '#/components/schemas/FacultyUCPathIDNotFound' '/app/faculty/AnnualCertifications/email/{email}': get: tags: - Faculty Single summary: Get Faculty Annual Certifications by email description: Get Faculty Annual Certifications by email parameters: - name: email in: path description: Email of the faculty required: true schema: type: string format: email responses: '200': description: OK content: application/json: schema: anyOf: - $ref: >- #/components/schemas/FacultyAnnualCertificationSingleResponseSuccess - $ref: '#/components/schemas/FacultyEmailNotFound' '/app/faculty/AnnualCertifications/ucpathID/{ucpath_id}': get: tags: - Faculty Single summary: Get Faculty Annual Certifications by email description: Get Faculty Annual Certifications by email parameters: - name: ucpath_id in: path description: UCPath ID of the faculty required: true schema: type: string responses: '200': description: OK content: application/json: schema: anyOf: - $ref: >- #/components/schemas/FacultyAnnualCertificationSingleResponseSuccess - $ref: '#/components/schemas/FacultyUCPathIDNotFound' '/app/faculty/{fiscal_year}': get: tags: - Faculty All summary: Faculty List By Fiscal Year description: Faculty List By Fiscal Year parameters: - name: fiscal_year in: path description: Fiscal Year to get the data from. Format XXXX-YYYY required: true schema: type: string responses: '200': description: OK content: application/json: schema: anyOf: - $ref: '#/components/schemas/FacultyDataAll' '/app/batch/faculty/activity/{fiscal_year}': get: tags: - Faculty All summary: Faculty Activities List By Fiscal Year description: Faculty Activities List By Fiscal Year parameters: - name: fiscal_year in: path description: Fiscal Year to get the data from. Format XXXX-YYYY required: true schema: type: string responses: '200': description: OK content: application/json: schema: anyOf: - $ref: '#/components/schemas/FacultyActivityAll' '/app/batch/facultyActivityEffort/{fiscal_year}': get: tags: - Faculty All summary: Faculty Activities Effort List By Fiscal Year description: Faculty Activities Effort List By Fiscal Year parameters: - name: fiscal_year in: path description: Fiscal Year to get the data from. Format XXXX-YYYY required: true schema: type: string responses: '200': description: OK content: application/json: schema: anyOf: - $ref: '#/components/schemas/FacultyActivityEffortAll' '/app/allFaculty/annualCertification/{fiscal_year}': get: tags: - Faculty All summary: Faculty Annual Certifications By Fiscal Year description: Faculty Annual Certifications By Fiscal Year parameters: - name: fiscal_year in: path description: Fiscal Year to get the data from. Format XXXX-YYYY required: true schema: type: string responses: '200': description: OK content: application/json: schema: anyOf: - $ref: '#/components/schemas/FacultyAnnualCertificationAll' components: schemas: FacultyDataSingleResponseSuccess: required: - response_code - response_message - response_body properties: response_code: type: string example: ok response_message: type: string example: ws faculty info run successfully response_body: required: - firstName - lastName - email - UID - UCPathID - employmentStatus - separationDate - primaryUnitCode - secondaryUnitCodeList - facultyStatusTagList - policyName - timeThreshold - incomeThreshold - activityList properties: firstName: type: string example: Johny lastName: type: string example: Test email: type: string example: johny.test@ucla.edu UID: type: string example: '123456789' UCPathID: type: string example: '10011111' employmentStatus: type: string format: date example: S separationDate: type: string format: date example: '2021-05-25' primaryUnitCode: type: string example: D1234 secondaryUnitCodeList: type: array example: - D0000 - D1111 facultyStatusTagList: type: array example: - notInGoodStanding - onleave policyName: type: string example: '025' timeThreshold: type: string example: '384' incomeThreshold: type: string example: '40000' activityList: items: $ref: '#/components/schemas/FacultyActivity' type: array type: object FacultyAnnualCertificationSingleResponseSuccess: type: object required: - response_code - response_message - response_body properties: response_code: type: string example: ok response_message: type: string example: ws annual certification list run successfully response_body: required: - annualCertificationData properties: annualCertificationData: type: object required: - facultyInfo - annualCertificationList properties: facultyInfo: type: object required: - UID - UCPathID - firstName - lastName properties: UID: type: string example: '123456789' UCPathID: type: string example: '10011111' firstName: type: string example: Johny lastName: type: string example: Test annualCertificationList: type: array items: type: object required: - primaryUnitCode - primaryUnitTitle - policyName - fiscalYear - status - dueDate - submittedDate - secondaryUnitCodeList properties: primaryUnitCode: type: string example: D1234 primaryUnitTitle: type: string example: The Unit For Testing policyName: type: string example: '025' fiscalYear: type: string example: 2020-2021 status: type: string example: In Process dueDate: type: string example: 10/30/2021 submittedDate: type: string example: 09/29/2021 secondaryUnitCodeList: type: string example: - D0000 - D1111 FacultyEmailNotFound: required: - response_code - response_message - response_body properties: response_code: type: string example: Error response_message: type: string example: No matching faculty with Email = johny.test@ucla.edu in UCOATS response_body: type: string example: '' type: object FacultyUCPathIDNotFound: required: - response_code - response_message - response_body properties: response_code: type: string example: Error response_message: type: string example: No matching faculty with UCPath ID = 123456789 in UCOATS response_body: type: string example: '' type: object FacultyDataAll: type: object required: - snapshotDate - campusCode - facultyList properties: snapshotDate: type: string example: '05/11/2021 14:06:07' campusCode: type: string example: ucla facultyList: type: array items: $ref: '#/components/schemas/FacultyData' FacultyActivityAll: type: object required: - snapshotDate - campusCode - facultyCount - facultyList properties: snapshotDate: type: string example: '05/11/2021 14:06:07' campusCode: type: string example: ucla facultyCount: type: string example: '1' facultyList: type: array items: allOf: - $ref: '#/components/schemas/FacultyData' - type: object properties: activityList: $ref: '#/components/schemas/FacultyActivity' FacultyActivityEffortAll: type: object required: - snapshotDate - campusCode - facultyCount - facultyList properties: snapshotDate: type: string example: '05/11/2021 14:06:07' campusCode: type: string example: ucla facultyCount: type: string example: '1' facultyList: type: array items: allOf: - $ref: '#/components/schemas/FacultyData' - type: object properties: activityList: type: array items: allOf: - $ref: '#/components/schemas/FacultyActivity' - type: object properties: incomeEffortList: type: array items: $ref: '#/components/schemas/FacultyEffort' FacultyAnnualCertificationAll: type: object required: - snapshotDate - campusCode - fiscalYear - facultyList properties: snapshotDate: type: string example: '05/11/2021 14:06:07' campusCode: type: string example: ucla fiscalYear: type: string example: 2020-2021 facultyList: type: array items: type: object required: - ucPathID - email - firstName - lastName - formStatus - queueLabel - policyName - primaryUnitCode - primaryUnitTitle - submittedDate - dueDate - secondaryUnitCodeList properties: UCPathID: type: string example: '10011111' email: type: string example: johny.test@ucla.edu firstName: type: string example: Johny lastName: type: string example: Test formStatus: type: string example: In Process queueLabel: type: string example: APO Reviewer policyName: type: string example: '025' primaryUnitCode: type: string example: D1234 primaryUnitTitle: type: string example: The Unit For Testing submittedDate: type: string example: 09/29/2021 dueDate: type: string example: 10/30/2021 secondaryUnitCodeList: type: string example: - D0000 - D1111 FacultyData: type: object required: - firstName - lastName - email - policyName - UCPathID - facultyStatusTagList - employmentStatus - primaryUnitCode - secondaryUnitCodeList properties: firstName: type: string example: Johny lastName: type: string example: Test email: type: string example: johny.test@ucla.edu policyName: type: string example: '025' UCPathID: type: string example: '10011111' facultyStatusTagList: type: string example: - notInGoodStanding - onleave employmentStatus: type: string format: date example: S primaryUnitCode: type: string example: D1234 secondaryUnitCodeList: type: string example: - D0000 - D1111 FacultyActivity: required: - label - category - timeEntered - timeOverTH - incomeEntered - incomeOverTh - formList properties: label: type: string example: This is an Activity category: type: string example: cat1 timeEntered: type: string example: '10.00' timeOverTH: type: string example: '2.00' incomeEntered: type: string example: '10,000.00' incomeOverTh: type: string example: '1,000.00' formList: items: $ref: '#/components/schemas/FacultyForm' type: array type: object FacultyEffort: type: object required: - renumerationType - stockInfo - numHours - startDate - endDate - isPodiumHours - isCompensated - Amount properties: renumerationType: type: string example: Stock as Compensation stockInfo: oneOf: - type: object - properties: numShares: type: string example: '50000.00' receiptDate: type: string example: 10/19/2018 pricePerShareAtTimeOfReceipt: type: string example: '0.72' - type: object - properties: purchaseDate: type: string example: 10/19/2018 purchasePricePerShare: type: string example: '0.72' fairMarketValueAtTimeOfPurchase: type: string example: '5.12' amountAgainstThreshold: type: string example: '10000.00' - type: object - properties: numShares: type: string example: '10000.00' optionOfferDate: type: string example: 10/19/2018 exercisePricePerShare: type: string example: '0.72' fairMarketValueAtTimeOfDisclosure: type: string example: '5.12' amountAgainstThreshold: type: string example: '10000.00' startDate: type: string example: '2019-06-01' endDate: type: string example: '2020-06-01' isPodiumHours: type: string example: 'No' isCompensated: type: string example: 'Yes' Amount: type: string example: '1800.00' FacultyForm: required: - formID - Form - formStatus - queueLabel - lastUpdated properties: formID: type: string example: '11037' Form: type: string example: cat1 formStatus: type: string example: In Process queueLabel: type: string example: APO Reviewer lastUpdated: type: string example: 02/25/2020 type: object