PeopleSoft Campus Solutions API

openapi: 3.1.0
info:
  title: PeopleSoft Campus Solutions API
  description: Campus Solutions APIs for student records, admissions, enrollment,
    financial aid, and academic advising.
  version: 1.0.0
  contact:
    name: Oracle Support
    email: [email protected]
    url: https://support.oracle.com
  license:
    name: Proprietary
    url: https://www.oracle.com/contracts/
servers:
- url: https://{hostname}:{port}/psft/api/campus/v1
  description: PeopleSoft Instance
  variables:
    hostname:
      description: PeopleSoft server hostname
      default: localhost
    port:
      description: PeopleSoft server port
      default: '8000'
externalDocs:
  description: PeopleSoft Campus Solutions Documentation
  url: https://docs.oracle.com/en/applications/peoplesoft/campus-solutions/index.html
tags:
- name: Students
  description: Student record operations
- name: Admissions
  description: Admissions operations
- name: Enrollment
  description: Enrollment operations
- name: Financial Aid
  description: Financial aid operations
paths:
  /students:
    get:
      summary: PeopleSoft List Students
      description: Retrieve student records.
      operationId: listStudents
      tags:
      - Students
      security:
      - basicAuth: []
      parameters:
      - name: term
        in: query
        description: Academic term filter
        schema:
          type: string
        example: example_value
      - name: program
        in: query
        description: Academic program filter
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Successful response with student records
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /students/{studentId}:
    get:
      summary: PeopleSoft Get Student
      description: Retrieve details for a specific student.
      operationId: getStudent
      tags:
      - Students
      security:
      - basicAuth: []
      parameters:
      - name: studentId
        in: path
        required: true
        description: The student identifier
        schema:
          type: string
        example: PS123456
      responses:
        '200':
          description: Student details
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
        '404':
          description: Student not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /admissions/applications:
    get:
      summary: PeopleSoft List Admission Applications
      description: Retrieve admission applications.
      operationId: listAdmissionApplications
      tags:
      - Admissions
      security:
      - basicAuth: []
      responses:
        '200':
          description: Successful response with applications
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /enrollment/classes:
    get:
      summary: PeopleSoft List Classes
      description: Retrieve class schedule and enrollment data.
      operationId: listClasses
      tags:
      - Enrollment
      security:
      - basicAuth: []
      parameters:
      - name: term
        in: query
        description: Academic term
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Successful response with class data
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /financial-aid/awards:
    get:
      summary: PeopleSoft List Financial Aid Awards
      description: Retrieve financial aid award data.
      operationId: listFinancialAidAwards
      tags:
      - Financial Aid
      security:
      - basicAuth: []
      responses:
        '200':
          description: Successful response with award data
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
  schemas:
    Student:
      type: object
      description: PeopleSoft Campus Solutions student record.
      properties:
        EMPLID:
          type: string
          description: Student ID.
          example: STU001234
        NAME:
          type: string
          description: Student name.
          example: Alex Johnson
        ACAD_CAREER:
          type: string
          description: Academic career.
          enum:
          - UGRD
          - GRAD
          - LAW
          - MED
          example: UGRD
        ACAD_PROG:
          type: string
          description: Academic program.
          example: BSCS
        ACAD_PLAN:
          type: string
          description: Academic plan/major.
          example: COMPSCI
        ADMIT_TERM:
          type: string
          description: Admission term.
          example: 2026F
        ACAD_LEVEL_BOT:
          type: string
          description: Academic level.
          enum:
          - FR
          - SO
          - JR
          - SR
          - GR
          example: JR
        CUM_GPA:
          type: number
          description: Cumulative GPA.
          example: 3.65
        TOT_TAKEN_GPA:
          type: number
          description: Total GPA units taken.
          example: 90.0
        INSTITUTION:
          type: string
          description: Institution code.
          example: MYUNV
        CAMPUS:
          type: string
          description: Campus code.
          example: MAIN
        STDNT_CAR_NBR:
          type: integer
          description: Student career number.
          example: 0
        ACAD_STANDING:
          type: string
          description: Academic standing.
          enum:
          - GS
          - GP
          - AP
          - DQ
          example: GS
    ClassEnrollment:
      type: object
      description: PeopleSoft class enrollment record.
      properties:
        EMPLID:
          type: string
          description: Student ID.
          example: STU001234
        CLASS_NBR:
          type: integer
          description: Class number.
          example: 10542
        CRSE_ID:
          type: string
          description: Course ID.
          example: CS101
        SUBJECT:
          type: string
          description: Subject area.
          example: COMPSCI
        CATALOG_NBR:
          type: string
          description: Catalog number.
          example: '101'
        DESCR:
          type: string
          description: Course description.
          example: Introduction to Computer Science
        UNT_TAKEN:
          type: number
          description: Units taken.
          example: 3.0
        GRADE_INPUT:
          type: string
          description: Grade.
          example: A
        ENRL_STATUS_REASON:
          type: string
          description: Enrollment status.
          enum:
          - ENRL
          - DROP
          - WAIT
          example: ENRL
        STRM:
          type: string
          description: Term code.
          example: '2261'