Jump to

• Request
• Response

Get all student curriculum rows

get

/fscmRestApi/resources/11.13.18.05/studentCurriculums

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds all student curriculum items that match the primary key criteria specified.
    Finder Variables
    • EnrollmentId; integer; Unique identifier for a student curriculum item.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AcadGroupAdmitAcademicPeriodId; integer; The unique identifier for the admit academic period of the student's academic group.
  • AcademicLevelId; integer; The unique identifier for an academic level that's associated with the enrollment record.
  • AcademicLevelName; string; The name of an academic level that's associated with the enrollment record.
  • ActionReasonId; integer; The unique identifier of action reason associated with the enrollment record.
  • ActionReasonName; string; The name of the action reason associated with the enrollment record.
  • ActionTypeCode; string; The code of the latest action taken on the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ACTION_TYPE.
  • ActionTypeMeaning; string; The meaning of the latest action taken on the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ACTION_TYPE.
  • AdmitAcademicPeriodEndDate; string; The date when the associated admit academic period ends.
  • AdmitAcademicPeriodId; integer; The unique identifier of the academic period that's associated with admit date of the enrollment record.
  • AdmitAcademicPeriodName; string; The name of the academic period that's associated with admit date of the enrollment record.
  • AdmitAcademicPeriodStartDate; string; The date when the associated admit academic period starts.
  • AdmitDate; string; The admit date of the enrollment record.
  • ApprovedAcademicLoad; string; The approved academic load code of the enrollment record. Valid values include ORA_FULL_TIME or ORA_PART_TIME. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LOAD_CODE.
  • ApprovedAcademicLoadMeaning; string; The approved academic load meaning of the enrollment record. Valid values include Full time or Part time. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LOAD_CODE.
  • CampusId; integer; The unique identifier of the campus associated with the enrollment record.
  • CampusName; string; The name of the campus associated with the enrollment record.
  • CredentialFormalName; string; The formal name of the credential marked as final and with the lowest display sequence value defined in the related curriculum program record.
  • CredentialId; integer; The unique identifier for the credential marked as final and with the lowest display sequence value defined in the related curriculum program record.
  • CurriculumId; integer; The identifier for the program or academic group associated with this student curriculum item.
  • CurriculumName; string; The name of the program or academic group associated with this student curriculum item.
  • CurriculumType; string; The code of the type category of a curriculum item.
  • CurriculumTypeId; integer; The unique identifier of the type category of a curriculum item.
  • EnrollmentId; integer; The generated primary key column of the enrollment record.
  • EnrollmentModeCode; string; The code of the enrollment mode that's used to enroll students in the program. Valid values include ORA_SCHEDULER or ORA_SHOPPING_CART. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_MODE.
  • EnrollmentModeMeaning; string; The meaning of the enrollment mode that's used to enroll students in the program. Valid values include Scheduler or Shopping Cart. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_MODE.
  • FinalCredentialFlag; boolean; Identifies a curriculum credential as the final or maximum credential when multiple credentials exist on a program.
  • InstitutionId; integer; The unique identifier of the institution associated with the enrollment record.
  • InstitutionName; string; The name of the institution associated with the enrollment record.
  • Note; string; The administrative note associated with the enrollment record.
  • ParentAcademicGroupId; integer; The unique identifier of the academic group associated with the program record.
  • ParentAcademicGroupName; string; The name of the academic group associated with the program record.
  • PayToAccessFlag; boolean; Indicates that the student must pay the program fees before the student can enroll in courses.
  • PaymentModeCode; string; The code of the payment mode that's used for the program when enrolling students. Valid values include ORA_PAY_TO_ENRL or ORA_BILL_LATER. A list of accepted values is defined in the lookup type ORA_HER_PAYMENT_MODE.
  • PaymentModeMeaning; string; The meaning of the payment mode that's used for the program when enrolling students. Valid values include Pay to enroll or Bill later. A list of accepted values is defined in the lookup type ORA_HER_PAYMENT_MODE.
  • PrimaryProgramFlag; boolean; Indicates whether the program is a primary program. The default value is: false.
  • ProgramPrepaidFlag; boolean; Indicates whether the student has paid the program fees.
  • ProgramStartDate; string; The date when the student's program started.
  • ProgramTypeCode; string; The code of a program type that's associated with a program.
  • ProgramTypeId; integer; The unique identifier for a program type that's associated with a program.
  • ProgramTypeMainFlag; boolean; Indicates whether a program is a main program.
  • ProgramTypeName; string; The meaning of a program type that's associated with a program.
  • ProjectedCompletionDate; string; The date when a student is expected to complete the program.
  • RequirementPeriodEndDate; string; The date when the associated requirement academic period ends.
  • RequirementPeriodId; integer; The unique identifier of the academic period that's associated with the requirement period of the enrollment record.
  • RequirementPeriodName; string; The name of the academic period that's associated with the requirement period of the enrollment record.
  • RequirementPeriodStartDate; string; The date when the associated requirement academic period starts.
  • StartDate; string; The date when the student's program or academic period started.
  • StatusCode; string; The code of the latest status associated with the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.
  • StatusDate; string; The date of the latest status associated with the enrollment record.
  • StatusMeaning; string; The meaning of the latest status associated with the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.
  • StudentName; string; The name of the signed in student.
  • StudentPartyId; integer; The unique identifier assigned to a person whose association with an institution is classified as a being a student.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : studentCurriculums

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/studentCurriculums-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object studentCurriculums-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/studentCurriculums-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : studentCurriculums-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  Read Only: true

  The unique identifier for an academic level that's associated with the enrollment record.
• AcademicLevelName: string
  Title: Academic Level Name

  Read Only: true

  Maximum Length: 100

  The name of an academic level that's associated with the enrollment record.
• AcadGroupAdmitAcademicPeriodId: integer (int64)
  Title: Academic Period ID

  Read Only: true

  The unique identifier for the admit academic period of the student's academic group.
• ActionReasonId: integer (int64)
  Title: Last Action Reason ID

  Read Only: true

  The unique identifier of action reason associated with the enrollment record.
• ActionReasonName: string
  Title: Action Reason

  Read Only: true

  Maximum Length: 50

  The name of the action reason associated with the enrollment record.
• ActionTypeCode: string
  Title: Action

  Read Only: true

  Maximum Length: 30

  The code of the latest action taken on the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ACTION_TYPE.
• ActionTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the latest action taken on the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ACTION_TYPE.
• AdmitAcademicPeriodEndDate: string (date)
  Title: End Date

  Read Only: true

  The date when the associated admit academic period ends.
• AdmitAcademicPeriodId: integer
  Title: Academic Period ID

  Read Only: true

  The unique identifier of the academic period that's associated with admit date of the enrollment record.
• AdmitAcademicPeriodName: string
  Title: Period Name

  Read Only: true

  The name of the academic period that's associated with admit date of the enrollment record.
• AdmitAcademicPeriodStartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the associated admit academic period starts.
• AdmitDate: string (date)
  Title: Admit Date

  Read Only: true

  The admit date of the enrollment record.
• advisors: array Advisors
  Title: Advisors

  The advisors resource is a child of the student curriculum resource and provides a list of advisors assigned to a student.
• ApprovedAcademicLoad: string
  Title: Student Program Approved Academic Load

  Read Only: true

  Maximum Length: 30

  The approved academic load code of the enrollment record. Valid values include ORA_FULL_TIME or ORA_PART_TIME. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LOAD_CODE.
• ApprovedAcademicLoadMeaning: string
  Title: Student Program Approved Academic Load Meaning

  Read Only: true

  Maximum Length: 80

  The approved academic load meaning of the enrollment record. Valid values include Full time or Part time. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LOAD_CODE.
• CampusId: integer (int64)
  Title: Campus ID

  Read Only: true

  The unique identifier of the campus associated with the enrollment record.
• CampusName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the campus associated with the enrollment record.
• CredentialFormalName: string
  Title: Credential Formal Name

  Read Only: true

  The formal name of the credential marked as final and with the lowest display sequence value defined in the related curriculum program record.
• CredentialId: integer
  Title: Credential ID

  Read Only: true

  The unique identifier for the credential marked as final and with the lowest display sequence value defined in the related curriculum program record.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  The identifier for the program or academic group associated with this student curriculum item.
• CurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the program or academic group associated with this student curriculum item.
• CurriculumType: string
  Title: Curriculum Item Type

  Read Only: true

  Maximum Length: 30

  The code of the type category of a curriculum item.
• CurriculumTypeId: integer (int64)
  Title: Curriculum Type

  Read Only: true

  The unique identifier of the type category of a curriculum item.
• EnrollmentId: integer (int64)
  Title: Student Curriculum Item ID

  Read Only: true

  The generated primary key column of the enrollment record.
• EnrollmentModeCode: string
  Title: Enrollment Mode

  Read Only: true

  Maximum Length: 30

  The code of the enrollment mode that's used to enroll students in the program. Valid values include ORA_SCHEDULER or ORA_SHOPPING_CART. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_MODE.
• EnrollmentModeMeaning: string
  Title: Enrollment Mode Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the enrollment mode that's used to enroll students in the program. Valid values include Scheduler or Shopping Cart. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_MODE.
• FinalCredentialFlag: boolean
  Title: Final Credential

  Read Only: true

  Identifies a curriculum credential as the final or maximum credential when multiple credentials exist on a program.
• images: array Images
  Title: Images

  The images resource is a child of the student curriculum resource and provides a list of image attachments for a student's program.
• InstitutionId: integer (int64)
  Title: Institution ID

  Read Only: true

  The unique identifier of the institution associated with the enrollment record.
• InstitutionName: string
  Title: Institution

  Read Only: true

  Maximum Length: 50

  The name of the institution associated with the enrollment record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Note: string
  Title: Note

  Read Only: true

  The administrative note associated with the enrollment record.
• ParentAcademicGroupId: integer (int64)
  Title: Parent Curriculum ID

  Read Only: true

  The unique identifier of the academic group associated with the program record.
• ParentAcademicGroupName: string
  Title: Academic Group Name

  Read Only: true

  Maximum Length: 50

  The name of the academic group associated with the program record.
• PaymentModeCode: string
  Title: Payment Mode

  Read Only: true

  Maximum Length: 30

  The code of the payment mode that's used for the program when enrolling students. Valid values include ORA_PAY_TO_ENRL or ORA_BILL_LATER. A list of accepted values is defined in the lookup type ORA_HER_PAYMENT_MODE.
• PaymentModeMeaning: string
  Title: Payment Mode Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the payment mode that's used for the program when enrolling students. Valid values include Pay to enroll or Bill later. A list of accepted values is defined in the lookup type ORA_HER_PAYMENT_MODE.
• PayToAccessFlag: boolean
  Title: Pay to access

  Read Only: true

  Maximum Length: 1

  Indicates that the student must pay the program fees before the student can enroll in courses.
• PrimaryProgramFlag: boolean
  Read Only: true

  Indicates whether the program is a primary program. The default value is: false.
• ProgramPrepaidFlag: boolean
  Read Only: true

  Indicates whether the student has paid the program fees.
• ProgramStartDate: string (date)
  Read Only: true

  The date when the student's program started.
• ProgramTypeCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  The code of a program type that's associated with a program.
• ProgramTypeId: integer (int64)
  Title: Program Type ID

  Read Only: true

  The unique identifier for a program type that's associated with a program.
• ProgramTypeMainFlag: boolean
  Title: Main program

  Read Only: true

  Maximum Length: 1

  Indicates whether a program is a main program.
• ProgramTypeName: string
  Title: Program Type

  Read Only: true

  Maximum Length: 50

  The meaning of a program type that's associated with a program.
• ProjectedCompletionDate: string (date)
  Title: Projected Completion Date

  Read Only: true

  The date when a student is expected to complete the program.
• RequirementPeriodEndDate: string (date)
  Title: Requirement Period End Date

  Read Only: true

  The date when the associated requirement academic period ends.
• RequirementPeriodId: integer
  Title: Requirement Period ID

  Read Only: true

  The unique identifier of the academic period that's associated with the requirement period of the enrollment record.
• RequirementPeriodName: string
  Title: Requirement Period Name

  Read Only: true

  The name of the academic period that's associated with the requirement period of the enrollment record.
• RequirementPeriodStartDate: string (date)
  Title: Requirement Period Start Date

  Read Only: true

  The date when the associated requirement academic period starts.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the student's program or academic period started.
• StatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  The code of the latest status associated with the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.
• StatusDate: string (date-time)
  Title: Status Date

  Read Only: true

  The date of the latest status associated with the enrollment record.
• StatusMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the latest status associated with the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.
• studentAcademicLevels: array Student Academic Levels
  Title: Student Academic Levels

  The student academic levels resource is a child of the student curriculum resource and provides a list of academic levels calculated for a student under each reporting period.
• studentAcademicLoads: array Student Academic Loads
  Title: Student Academic Loads

  The student academic loads resource is a child of the student curriculum resource and provides a list of academic loads calculated for a student under each reporting period.
• studentCredentials: array Student Credentials
  Title: Student Credentials

  The student credentials resource is a child of the student curriculum resource and provides a list of credentials awarded to a student.
• studentCurriculumElements: array Student Curriculum Elements
  Title: Student Curriculum Elements

  The student curriculum elements resource is a child of the student curriculum resource and provides a list of programs enrolled for a student under an academic group.
• StudentName: string
  Title: Student Name

  Read Only: true

  Maximum Length: 450

  The name of the signed in student.
• StudentPartyId: integer (int64)
  Title: Student ID

  Read Only: true

  The unique identifier assigned to a person whose association with an institution is classified as a being a student.

{
    "type":"object",
    "properties":{
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the latest status associated with the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdmitDate":{
            "title":"Admit Date",
            "type":"string",
            "description":"The admit date of the enrollment record.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the student's program or academic period started.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "studentCredentials":{
            "title":"Student Credentials",
            "type":"array",
            "description":"The student credentials resource is a child of the student curriculum resource and provides a list of credentials awarded to a student.",
            "items":{
                "$ref":"#/components/schemas/studentCurriculums-studentCredentials-item-response"
            }
        },
        "ActionTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the latest action taken on the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ACTION_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for an academic level that's associated with the enrollment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramStartDate":{
            "type":"string",
            "description":"The date when the student's program started.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramTypeName":{
            "title":"Program Type",
            "maxLength":50,
            "type":"string",
            "description":"The meaning of a program type that's associated with a program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementPeriodId":{
            "title":"Requirement Period ID",
            "type":"integer",
            "description":"The unique identifier of the academic period that's associated with the requirement period of the enrollment record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdmitAcademicPeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the associated admit academic period starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "images":{
            "title":"Images",
            "type":"array",
            "description":"The images resource is a child of the student curriculum resource and provides a list of image attachments for a student's program.",
            "items":{
                "$ref":"#/components/schemas/studentCurriculums-images-item-response"
            }
        },
        "ProgramTypeCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of a program type that's associated with a program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier of the institution associated with the enrollment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionReasonName":{
            "title":"Action Reason",
            "maxLength":50,
            "type":"string",
            "description":"The name of the action reason associated with the enrollment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "advisors":{
            "title":"Advisors",
            "type":"array",
            "description":"The advisors resource is a child of the student curriculum resource and provides a list of advisors assigned to a student.",
            "items":{
                "$ref":"#/components/schemas/studentCurriculums-advisors-item-response"
            }
        },
        "StudentPartyId":{
            "title":"Student ID",
            "type":"integer",
            "description":"The unique identifier assigned to a person whose association with an institution is classified as a being a student.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AdmitAcademicPeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the associated admit academic period ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The identifier for the program or academic group associated with this student curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramTypeId":{
            "title":"Program Type ID",
            "type":"integer",
            "description":"The unique identifier for a program type that's associated with a program.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnrollmentId":{
            "title":"Student Curriculum Item ID",
            "type":"integer",
            "description":"The generated primary key column of the enrollment record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ApprovedAcademicLoadMeaning":{
            "title":"Student Program Approved Academic Load Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The approved academic load meaning of the enrollment record. Valid values include Full time or Part time. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LOAD_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionTypeCode":{
            "title":"Action",
            "maxLength":30,
            "type":"string",
            "description":"The code of the latest action taken on the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ACTION_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Note":{
            "title":"Note",
            "type":"string",
            "description":"The administrative note associated with the enrollment record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementPeriodEndDate":{
            "title":"Requirement Period End Date",
            "type":"string",
            "description":"The date when the associated requirement academic period ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "studentAcademicLoads":{
            "title":"Student Academic Loads",
            "type":"array",
            "description":"The student academic loads resource is a child of the student curriculum resource and provides a list of academic loads calculated for a student under each reporting period.",
            "items":{
                "$ref":"#/components/schemas/studentCurriculums-studentAcademicLoads-item-response"
            }
        },
        "PrimaryProgramFlag":{
            "type":"boolean",
            "description":"Indicates whether the program is a primary program. The default value is: false.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "EnrollmentModeMeaning":{
            "title":"Enrollment Mode Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the enrollment mode that's used to enroll students in the program. Valid values include Scheduler or Shopping Cart. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_MODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTypeId":{
            "title":"Curriculum Type",
            "type":"integer",
            "description":"The unique identifier of the type category of a curriculum item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CredentialId":{
            "title":"Credential ID",
            "type":"integer",
            "description":"The unique identifier for the credential marked as final and with the lowest display sequence value defined in the related curriculum program record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayToAccessFlag":{
            "title":"Pay to access",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the student must pay the program fees before the student can enroll in courses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentAcademicGroupId":{
            "title":"Parent Curriculum ID",
            "type":"integer",
            "description":"The unique identifier of the academic group associated with the program record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the program or academic group associated with this student curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the campus associated with the enrollment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeMainFlag":{
            "title":"Main program",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a program is a main program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "studentCurriculumElements":{
            "title":"Student Curriculum Elements",
            "type":"array",
            "description":"The student curriculum elements resource is a child of the student curriculum resource and provides a list of programs enrolled for a student under an academic group.",
            "items":{
                "$ref":"#/components/schemas/studentCurriculums-studentCurriculumElements-item-response"
            }
        },
        "RequirementPeriodName":{
            "title":"Requirement Period Name",
            "type":"string",
            "description":"The name of the academic period that's associated with the requirement period of the enrollment record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of an academic level that's associated with the enrollment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FinalCredentialFlag":{
            "title":"Final Credential",
            "type":"boolean",
            "description":"Identifies a curriculum credential as the final or maximum credential when multiple credentials exist on a program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcadGroupAdmitAcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The unique identifier for the admit academic period of the student's academic group.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CredentialFormalName":{
            "title":"Credential Formal Name",
            "type":"string",
            "description":"The formal name of the credential marked as final and with the lowest display sequence value defined in the related curriculum program record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentModeMeaning":{
            "title":"Payment Mode Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the payment mode that's used for the program when enrolling students. Valid values include Pay to enroll or Bill later. A list of accepted values is defined in the lookup type ORA_HER_PAYMENT_MODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":50,
            "type":"string",
            "description":"The name of the institution associated with the enrollment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollmentModeCode":{
            "title":"Enrollment Mode",
            "maxLength":30,
            "type":"string",
            "description":"The code of the enrollment mode that's used to enroll students in the program. Valid values include ORA_SCHEDULER or ORA_SHOPPING_CART. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_MODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Item Type",
            "maxLength":30,
            "type":"string",
            "description":"The code of the type category of a curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementPeriodStartDate":{
            "title":"Requirement Period Start Date",
            "type":"string",
            "description":"The date when the associated requirement academic period starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovedAcademicLoad":{
            "title":"Student Program Approved Academic Load",
            "maxLength":30,
            "type":"string",
            "description":"The approved academic load code of the enrollment record. Valid values include ORA_FULL_TIME or ORA_PART_TIME. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LOAD_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "studentAcademicLevels":{
            "title":"Student Academic Levels",
            "type":"array",
            "description":"The student academic levels resource is a child of the student curriculum resource and provides a list of academic levels calculated for a student under each reporting period.",
            "items":{
                "$ref":"#/components/schemas/studentCurriculums-studentAcademicLevels-item-response"
            }
        },
        "ParentAcademicGroupName":{
            "title":"Academic Group Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic group associated with the program record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentModeCode":{
            "title":"Payment Mode",
            "maxLength":30,
            "type":"string",
            "description":"The code of the payment mode that's used for the program when enrolling students. Valid values include ORA_PAY_TO_ENRL or ORA_BILL_LATER. A list of accepted values is defined in the lookup type ORA_HER_PAYMENT_MODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the latest status associated with the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusDate":{
            "title":"Status Date",
            "type":"string",
            "description":"The date of the latest status associated with the enrollment record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectedCompletionDate":{
            "title":"Projected Completion Date",
            "type":"string",
            "description":"The date when a student is expected to complete the program.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusId":{
            "title":"Campus ID",
            "type":"integer",
            "description":"The unique identifier of the campus associated with the enrollment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdmitAcademicPeriodName":{
            "title":"Period Name",
            "type":"string",
            "description":"The name of the academic period that's associated with admit date of the enrollment record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionReasonId":{
            "title":"Last Action Reason ID",
            "type":"integer",
            "description":"The unique identifier of action reason associated with the enrollment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StudentName":{
            "title":"Student Name",
            "maxLength":450,
            "type":"string",
            "description":"The name of the signed in student.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "ProgramPrepaidFlag":{
            "type":"boolean",
            "description":"Indicates whether the student has paid the program fees.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdmitAcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The unique identifier of the academic period that's associated with admit date of the enrollment record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Advisors

Type: array

Title: Advisors

The advisors resource is a child of the student curriculum resource and provides a list of advisors assigned to a student.

Show Source

• Array of: object studentCurriculums-advisors-item-response

{
    "title":"Advisors",
    "type":"array",
    "description":"The advisors resource is a child of the student curriculum resource and provides a list of advisors assigned to a student.",
    "items":{
        "$ref":"#/components/schemas/studentCurriculums-advisors-item-response"
    }
}

Nested Schema : Images

Type: array

Title: Images

The images resource is a child of the student curriculum resource and provides a list of image attachments for a student's program.

Show Source

• Array of: object studentCurriculums-images-item-response

{
    "title":"Images",
    "type":"array",
    "description":"The images resource is a child of the student curriculum resource and provides a list of image attachments for a student's program.",
    "items":{
        "$ref":"#/components/schemas/studentCurriculums-images-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Student Academic Levels

Type: array

Title: Student Academic Levels

The student academic levels resource is a child of the student curriculum resource and provides a list of academic levels calculated for a student under each reporting period.

Show Source

• Array of: object studentCurriculums-studentAcademicLevels-item-response

{
    "title":"Student Academic Levels",
    "type":"array",
    "description":"The student academic levels resource is a child of the student curriculum resource and provides a list of academic levels calculated for a student under each reporting period.",
    "items":{
        "$ref":"#/components/schemas/studentCurriculums-studentAcademicLevels-item-response"
    }
}

Nested Schema : Student Academic Loads

Type: array

Title: Student Academic Loads

The student academic loads resource is a child of the student curriculum resource and provides a list of academic loads calculated for a student under each reporting period.

Show Source

• Array of: object studentCurriculums-studentAcademicLoads-item-response

{
    "title":"Student Academic Loads",
    "type":"array",
    "description":"The student academic loads resource is a child of the student curriculum resource and provides a list of academic loads calculated for a student under each reporting period.",
    "items":{
        "$ref":"#/components/schemas/studentCurriculums-studentAcademicLoads-item-response"
    }
}

Nested Schema : Student Credentials

Type: array

Title: Student Credentials

The student credentials resource is a child of the student curriculum resource and provides a list of credentials awarded to a student.

Show Source

• Array of: object studentCurriculums-studentCredentials-item-response

{
    "title":"Student Credentials",
    "type":"array",
    "description":"The student credentials resource is a child of the student curriculum resource and provides a list of credentials awarded to a student.",
    "items":{
        "$ref":"#/components/schemas/studentCurriculums-studentCredentials-item-response"
    }
}

Nested Schema : Student Curriculum Elements

Type: array

Title: Student Curriculum Elements

The student curriculum elements resource is a child of the student curriculum resource and provides a list of programs enrolled for a student under an academic group.

Show Source

• Array of: object studentCurriculums-studentCurriculumElements-item-response

{
    "title":"Student Curriculum Elements",
    "type":"array",
    "description":"The student curriculum elements resource is a child of the student curriculum resource and provides a list of programs enrolled for a student under an academic group.",
    "items":{
        "$ref":"#/components/schemas/studentCurriculums-studentCurriculumElements-item-response"
    }
}

Nested Schema : studentCurriculums-advisors-item-response

Type: object

Show Source

• AdvisorId: integer (int64)
  Title: Advisor ID

  Read Only: true

  The generated primary key column of the advisor record.
• AdvisorName: string
  Title: Advisor Name

  Read Only: true

  Maximum Length: 450

  The name of the advisor associated with the enrollment record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryFlag: boolean
  Title: Primary Advisor

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Identifies the primary advisor associated with the enrollment record.

{
    "type":"object",
    "properties":{
        "AdvisorId":{
            "title":"Advisor ID",
            "type":"integer",
            "description":"The generated primary key column of the advisor record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AdvisorName":{
            "title":"Advisor Name",
            "maxLength":450,
            "type":"string",
            "description":"The name of the advisor associated with the enrollment record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PrimaryFlag":{
            "title":"Primary Advisor",
            "maxLength":1,
            "type":"boolean",
            "description":"Identifies the primary advisor associated with the enrollment record.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : studentCurriculums-images-item-response

Type: object

Show Source

• AttachmentContent: string (byte)
  Title: Attachment Content

  Read Only: true

  The image associated with the student's program.
• CurriculumAttachmentContext: string
  Title: Curriculum Attachment Context

  Read Only: true

  Maximum Length: 30

  The context or usage of the image associated with the program. Valid values include ORA_MOBILE, ORA_STANDARD, or ORA_THUMB. A list of accepted values is defined in the lookup type ORA_HER_ATTACHMENT_CONTEXT.
• CurriculumAttachmentId: integer (int64)
  Title: Curriculum Attachment ID

  Read Only: true

  A unique identifier for the image associated with the student's program.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AttachmentContent":{
            "title":"Attachment Content",
            "type":"string",
            "description":"The image associated with the student's program.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumAttachmentId":{
            "title":"Curriculum Attachment ID",
            "type":"integer",
            "description":"A unique identifier for the image associated with the student's program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumAttachmentContext":{
            "title":"Curriculum Attachment Context",
            "maxLength":30,
            "type":"string",
            "description":"The context or usage of the image associated with the program. Valid values include ORA_MOBILE, ORA_STANDARD, or ORA_THUMB. A list of accepted values is defined in the lookup type ORA_HER_ATTACHMENT_CONTEXT.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : studentCurriculums-studentAcademicLevels-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  Read Only: true

  The unique identifier for the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.
• AcademicLevelName: string
  Title: Academic Level Name

  Read Only: true

  Maximum Length: 50

  The name of the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.
• BeginningAcademicLevel: string
  Read Only: true

  Maximum Length: 30

  The student level at the start of an enrollment period.
• EndingAcademicLevel: string
  Read Only: true

  Maximum Length: 30

  The student level at the end of an enrollment period.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectedAcademicLevel: string
  Read Only: true

  Maximum Length: 30

  The projected student level at the point of enrollment.
• ReportingPeriodEndDate: string (date)
  Title: Reporting Period End Date

  Read Only: true

  The date when the reporting period associated with a student enrollment record ended.
• ReportingPeriodId: integer (int64)
  Title: Reporting Period ID

  Read Only: true

  The unique identifier of the reporting period associated with a student enrollment record.
• ReportingPeriodName: string
  Title: Reporting Period Name

  Read Only: true

  Maximum Length: 50

  The name of the reporting period associated with a student enrollment record.
• ReportingPeriodStartDate: string (date)
  Title: Reporting Period Start Date

  Read Only: true

  The date when the reporting period associated with a student enrollment record started.

{
    "type":"object",
    "properties":{
        "BeginningAcademicLevel":{
            "maxLength":30,
            "type":"string",
            "description":"The student level at the start of an enrollment period.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProjectedAcademicLevel":{
            "maxLength":30,
            "type":"string",
            "description":"The projected student level at the point of enrollment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReportingPeriodEndDate":{
            "title":"Reporting Period End Date",
            "type":"string",
            "description":"The date when the reporting period associated with a student enrollment record ended.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReportingPeriodId":{
            "title":"Reporting Period ID",
            "type":"integer",
            "description":"The unique identifier of the reporting period associated with a student enrollment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EndingAcademicLevel":{
            "maxLength":30,
            "type":"string",
            "description":"The student level at the end of an enrollment period.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReportingPeriodName":{
            "title":"Reporting Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the reporting period associated with a student enrollment record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReportingPeriodStartDate":{
            "title":"Reporting Period Start Date",
            "type":"string",
            "description":"The date when the reporting period associated with a student enrollment record started.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : studentCurriculums-studentAcademicLoads-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  Read Only: true

  The unique identifier for the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.
• AcademicLevelName: string
  Title: Academic Level Name

  Read Only: true

  Maximum Length: 50

  The name of the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.
• CalculatedAcademicLoad: string
  Read Only: true

  Maximum Length: 30

  The automatically-calculated academic load of the student, such as full-time or part-time.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OverriddenAcademicLoad: string
  Read Only: true

  Maximum Length: 30

  The manually-assigned student academic load that supersedes the automatically-calculated value.
• ReportingPeriodEndDate: string (date)
  Title: Reporting Period End Date

  Read Only: true

  The date when the reporting period associated with a student enrollment record ended.
• ReportingPeriodId: integer (int64)
  Title: Reporting Period ID

  Read Only: true

  The unique identifier of the reporting period associated with a student enrollment record.
• ReportingPeriodName: string
  Title: Reporting Period Name

  Read Only: true

  Maximum Length: 50

  The name of the reporting period associated with a student enrollment record.
• ReportingPeriodStartDate: string (date)
  Title: Reporting Period Start Date

  Read Only: true

  The date when the reporting period associated with a student enrollment record started.

{
    "type":"object",
    "properties":{
        "ReportingPeriodEndDate":{
            "title":"Reporting Period End Date",
            "type":"string",
            "description":"The date when the reporting period associated with a student enrollment record ended.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReportingPeriodId":{
            "title":"Reporting Period ID",
            "type":"integer",
            "description":"The unique identifier of the reporting period associated with a student enrollment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CalculatedAcademicLoad":{
            "maxLength":30,
            "type":"string",
            "description":"The automatically-calculated academic load of the student, such as full-time or part-time.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OverriddenAcademicLoad":{
            "maxLength":30,
            "type":"string",
            "description":"The manually-assigned student academic load that supersedes the automatically-calculated value.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReportingPeriodName":{
            "title":"Reporting Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the reporting period associated with a student enrollment record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReportingPeriodStartDate":{
            "title":"Reporting Period Start Date",
            "type":"string",
            "description":"The date when the reporting period associated with a student enrollment record started.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : studentCurriculums-studentCredentials-item-response

Type: object

Show Source

• CompletionAcademicPeriodName: string
  Title: Student Credential Completion Period

  Read Only: true

  Maximum Length: 50

  The name of the academic period that's associated with completion of the enrollment record.
• CompletionPeriodId: integer (int64)
  Title: Completion Period

  The unique identifier of the academic period that's associated with completion of the enrollment record.
• ConferralDate: string (date-time)
  Title: Student Credential Conferral Date

  The date when the credential was conferred to the student.
• CredentialId: integer (int64)
  Title: Program Credential ID

  The unique identifier for the credential associated with the enrollment record.
• CredentialName: string
  Title: Credential Name

  Read Only: true

  Maximum Length: 50

  The name of the credential associated with the enrollment record.
• EnrollmentCredentialId: integer (int64)
  Title: Credential ID

  The generated primary key column of the credential record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Notes: string
  Title: Student Credential Note

  Read Only: true

  The administrative note associated with the credential.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  The code of the latest status associated with the credential. Valid values include ORA_AWARDED or ORA_REVOKED. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS.
• StatusDate: string (date-time)
  Title: Status Date

  The date of the latest status associated with the credential.
• StatusMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the latest status associated with the credential. Valid values include Awarded or Revoked. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS.
• StudentPartyId: integer (int64)
  Title: Student ID

  Read Only: true

  The unique identifier assigned to a person whose association with an institution is classified as a being a student.

{
    "type":"object",
    "properties":{
        "StatusMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the latest status associated with the credential. Valid values include Awarded or Revoked. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusDate":{
            "title":"Status Date",
            "type":"string",
            "description":"The date of the latest status associated with the credential.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CompletionAcademicPeriodName":{
            "title":"Student Credential Completion Period",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic period that's associated with completion of the enrollment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CredentialId":{
            "title":"Program Credential ID",
            "type":"integer",
            "description":"The unique identifier for the credential associated with the enrollment record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CredentialName":{
            "title":"Credential Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the credential associated with the enrollment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConferralDate":{
            "title":"Student Credential Conferral Date",
            "type":"string",
            "description":"The date when the credential was conferred to the student.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StudentPartyId":{
            "title":"Student ID",
            "type":"integer",
            "description":"The unique identifier assigned to a person whose association with an institution is classified as a being a student.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "EnrollmentCredentialId":{
            "title":"Credential ID",
            "type":"integer",
            "description":"The generated primary key column of the credential record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the latest status associated with the credential. Valid values include ORA_AWARDED or ORA_REVOKED. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS.",
            "nullable":false,
            "x-queryable":true
        },
        "CompletionPeriodId":{
            "title":"Completion Period",
            "type":"integer",
            "description":"The unique identifier of the academic period that's associated with completion of the enrollment record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Notes":{
            "title":"Student Credential Note",
            "type":"string",
            "description":"The administrative note associated with the credential.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : studentCurriculums-studentCurriculumElements-item-response

Type: object

Show Source

• CurriculumId: integer (int64)
  Title: Curriculum ID

  The identifier for the program associated with this student curriculum item.
• CurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the program associated with this student curriculum item.
• CurriculumType: string
  Title: Curriculum Item Type

  Read Only: true

  Maximum Length: 30

  The code of the type category of a curriculum item.
• CurriculumTypeId: integer (int64)
  Title: Curriculum Type

  The unique identifier of the type category of a curriculum item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramEnrollmentId: integer (int64)
  Title: Student Curriculum Item ID

  The generated primary key column of the program enrollment record.
• ProgramTypeId: integer (int64)
  Title: Program Type ID

  Read Only: true

  The unique identifier for a program type value that's associated with a program.
• ProgramTypeMainFlag: boolean
  Title: Main program

  Read Only: true

  Maximum Length: 1

  Indicates whether a program is a main program.
• ProgramTypeName: string
  Title: Program Type Name

  Read Only: true

  Maximum Length: 50

  The name of a program type value that's associated with a program.

{
    "type":"object",
    "properties":{
        "ProgramTypeId":{
            "title":"Program Type ID",
            "type":"integer",
            "description":"The unique identifier for a program type value that's associated with a program.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The identifier for the program associated with this student curriculum item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumTypeId":{
            "title":"Curriculum Type",
            "type":"integer",
            "description":"The unique identifier of the type category of a curriculum item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Item Type",
            "maxLength":30,
            "type":"string",
            "description":"The code of the type category of a curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the program associated with this student curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramEnrollmentId":{
            "title":"Student Curriculum Item ID",
            "type":"integer",
            "description":"The generated primary key column of the program enrollment record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProgramTypeName":{
            "title":"Program Type Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a program type value that's associated with a program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeMainFlag":{
            "title":"Main program",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a program is a main program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top