Jump to

• Request
• Response

Get all enrolled items

get

/fscmRestApi/resources/11.13.18.05/studentAcademicResults/{studentAcademicResultsUniqID}/child/courseEnrollments

Request

Path Parameters

• studentAcademicResultsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Student Academic Results resource and used to uniquely identify an instance of Student Academic Results. The client should not generate the hash key value. Instead, the client should query on the Student Academic Results collection resource in order to navigate to a specific instance of Student Academic Results to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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 enrolled items that match the enrollment ID.
    Finder Variables
    • CurriculumOptionId; integer; The unique identifier of the associated enrollment options record.
    • EnrollmentItemId; integer; The unique identifier for the enrolled 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:
  

  • AcademicPeriodId; integer; The enrollment academic or academic self-paced period identifier for the course section item.
  • AcademicPeriodName; string; The enrollment academic or academic self-paced period name for the course section item.
  • AcademicReportingPeriodId; integer; The unique identifier of a reporting period.
  • AcademicSubjectCode; string; The subject code of the enrolled course.
  • AcademicSubjectId; integer; The subject unique identifier of the enrolled course.
  • AcademicSubjectName; string; The subject name of the enrolled course.
  • ActionMeaning; string; The meaning of the last action taken. A list of accepted values is defined in the lookup type ORA_HER_ACTION_TYPE.
  • CreditTypeCode; string; The credit type code of the enrolled course.
  • CreditTypeMeaning; string; The credit type of the enrolled course.
  • CurriculumCatalogNumber; string; The catalog number of the enrolled course.
  • DropDate; string; The date when the student dropped the scheduled course.
  • EnrolledCreditQuantity; number; The number of credits the student enrolled in for the course.
  • EnrollmentDate; string; The date of the enrollment.
  • EnrollmentItemId; integer; The unique identifier of the enrollment item.
  • EnrollmentStatus; string; The status code of the enrollment.
  • EnrollmentStatusMeaning; string; The status of the enrollment.
  • ItemCurriculumId; integer; The identifier of the enrolled curriculum item.
  • ItemCurriculumName; string; The name of the enrolled curriculum item.
  • LastActionCode; 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.
  • OwningCurriculumId; integer; The curriculum Id of the course that owns the course section.
  • OwningCurriculumName; string; The curriculum name of the course that owns the course section.
  • ReportingPeriodName; string; The name of the reporting period.
  • ScheduledCourseCampusId; integer; The unique identifier for the campus where the course section is offered.
  • ScheduledCourseCampusName; string; The name of the campus where the course section is offered.
  • ScheduledCourseCode; string; The section code identifier of the enrolled course section.
  • ScheduledCourseEndDate; string; The end date of the enrolled course section.
  • ScheduledCourseStartDate; string; The start date of the enrolled course section.
• 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: string
  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: string
  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: string
  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:
  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.

Body ()

Root Schema : studentAcademicResults-courseEnrollments

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/studentAcademicResults-courseEnrollments-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object studentAcademicResults-courseEnrollments-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/studentAcademicResults-courseEnrollments-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 : studentAcademicResults-courseEnrollments-item-response

Type: object

Show Source

• AcademicPeriodId: integer (int64)
  Title: Enrolled Period ID

  Read Only: true

  The enrollment academic or academic self-paced period identifier for the course section item.
• AcademicPeriodName: string
  Title: Period Name

  Read Only: true

  Maximum Length: 50

  The enrollment academic or academic self-paced period name for the course section item.
• AcademicReportingPeriodId: integer (int64)
  Title: Reporting Period ID

  Read Only: true

  The unique identifier of a reporting period.
• AcademicSubjectCode: string
  Title: Subject Code

  Read Only: true

  Maximum Length: 30

  The subject code of the enrolled course.
• AcademicSubjectId: integer (int64)
  Title: Academic Subject ID

  Read Only: true

  The subject unique identifier of the enrolled course.
• AcademicSubjectName: string
  Title: Subject Name

  Read Only: true

  Maximum Length: 50

  The subject name of the enrolled course.
• ActionMeaning: string
  Title: Last Action Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the last action taken. A list of accepted values is defined in the lookup type ORA_HER_ACTION_TYPE.
• courseResults: array Course Results
  Title: Course Results

  The course results resource provides a list of course results and statistics associated with a student.
• CreditTypeCode: string
  Title: Credit Type Code

  Read Only: true

  Maximum Length: 30

  The credit type code of the enrolled course.
• CreditTypeMeaning: string
  Title: Credit Type

  Read Only: true

  Maximum Length: 80

  The credit type of the enrolled course.
• CurriculumCatalogNumber: string
  Title: Catalog Number

  Read Only: true

  Maximum Length: 10

  The catalog number of the enrolled course.
• DropDate: string (date)
  Title: Drop Date

  Read Only: true

  The date when the student dropped the scheduled course.
• EnrolledCreditQuantity: number
  Title: Units

  Read Only: true

  The number of credits the student enrolled in for the course.
• EnrollmentDate: string (date)
  Title: Enrollment Date

  Read Only: true

  The date of the enrollment.
• EnrollmentItemId: integer (int64)
  Title: Student Curriculum Item ID

  Read Only: true

  The unique identifier of the enrollment item.
• EnrollmentStatus: string
  Title: Enrollment Status

  Read Only: true

  Maximum Length: 30

  The status code of the enrollment.
• EnrollmentStatusMeaning: string
  Title: Enrollment Status Meaning

  Read Only: true

  Maximum Length: 80

  The status of the enrollment.
• ItemCurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  The identifier of the enrolled curriculum item.
• ItemCurriculumName: string
  Title: Title

  Read Only: true

  Maximum Length: 150

  The name of the enrolled curriculum item.
• LastActionCode: string
  Title: Last Action

  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.
• links: array Links
  Title: Links

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

  Read Only: true

  The curriculum Id of the course that owns the course section.
• OwningCurriculumName: string
  Title: Title

  Read Only: true

  Maximum Length: 150

  The curriculum name of the course that owns the course section.
• ReportingPeriodName: string
  Title: Reporting Period Name

  Read Only: true

  Maximum Length: 50

  The name of the reporting period.
• ScheduledCourseCampusId: integer (int64)
  Title: Campus

  Read Only: true

  The unique identifier for the campus where the course section is offered.
• ScheduledCourseCampusName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the campus where the course section is offered.
• ScheduledCourseCode: string
  Title: Associated Section Code

  Read Only: true

  Maximum Length: 30

  The section code identifier of the enrolled course section.
• ScheduledCourseEndDate: string (date-time)
  Title: Section End Date

  Read Only: true

  The end date of the enrolled course section.
• ScheduledCourseStartDate: string (date-time)
  Title: Section Start Date

  Read Only: true

  The start date of the enrolled course section.

{
    "type":"object",
    "properties":{
        "CurriculumCatalogNumber":{
            "title":"Catalog Number",
            "maxLength":10,
            "type":"string",
            "description":"The catalog number of the enrolled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningCurriculumName":{
            "title":"Title",
            "maxLength":150,
            "type":"string",
            "description":"The curriculum name of the course that owns the course section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseStartDate":{
            "title":"Section Start Date",
            "type":"string",
            "description":"The start date of the enrolled course section.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningCurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The curriculum Id of the course that owns the course section.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnrollmentItemId":{
            "title":"Student Curriculum Item ID",
            "type":"integer",
            "description":"The unique identifier of the enrollment item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EnrollmentStatusMeaning":{
            "title":"Enrollment Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The status of the enrollment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrolledCreditQuantity":{
            "title":"Units",
            "type":"number",
            "description":"The number of credits the student enrolled in for the course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeMeaning":{
            "title":"Credit Type",
            "maxLength":80,
            "type":"string",
            "description":"The credit type of the enrolled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionMeaning":{
            "title":"Last Action Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the last action taken. A list of accepted values is defined in the lookup type ORA_HER_ACTION_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastActionCode":{
            "title":"Last 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,
            "x-queryable":true
        },
        "EnrollmentStatus":{
            "title":"Enrollment Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the enrollment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollmentDate":{
            "title":"Enrollment Date",
            "type":"string",
            "description":"The date of the enrollment.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectName":{
            "title":"Subject Name",
            "maxLength":50,
            "type":"string",
            "description":"The subject name of the enrolled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DropDate":{
            "title":"Drop Date",
            "type":"string",
            "description":"The date when the student dropped the scheduled course.",
            "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"
            }
        },
        "ScheduledCourseEndDate":{
            "title":"Section End Date",
            "type":"string",
            "description":"The end date of the enrolled course section.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodId":{
            "title":"Enrolled Period ID",
            "type":"integer",
            "description":"The enrollment academic or academic self-paced period identifier for the course section item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ScheduledCourseCampusId":{
            "title":"Campus",
            "type":"integer",
            "description":"The unique identifier for the campus where the course section is offered.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemCurriculumName":{
            "title":"Title",
            "maxLength":150,
            "type":"string",
            "description":"The name of the enrolled curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicReportingPeriodId":{
            "title":"Reporting Period ID",
            "type":"integer",
            "description":"The unique identifier of a reporting period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ScheduledCourseCode":{
            "title":"Associated Section Code",
            "maxLength":30,
            "type":"string",
            "description":"The section code identifier of the enrolled course section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseCampusName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the campus where the course section is offered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportingPeriodName":{
            "title":"Reporting Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the reporting period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectCode":{
            "title":"Subject Code",
            "maxLength":30,
            "type":"string",
            "description":"The subject code of the enrolled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectId":{
            "title":"Academic Subject ID",
            "type":"integer",
            "description":"The subject unique identifier of the enrolled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditTypeCode":{
            "title":"Credit Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The credit type code of the enrolled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodName":{
            "title":"Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The enrollment academic or academic self-paced period name for the course section item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The identifier of the enrolled curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "courseResults":{
            "title":"Course Results",
            "type":"array",
            "description":"The course results resource provides a list of course results and statistics associated with a student.",
            "items":{
                "$ref":"#/components/schemas/studentAcademicResults-courseEnrollments-courseResults-item-response"
            }
        }
    }
}

Nested Schema : Course Results

Type: array

Title: Course Results

The course results resource provides a list of course results and statistics associated with a student.

Show Source

• Array of: object studentAcademicResults-courseEnrollments-courseResults-item-response

{
    "title":"Course Results",
    "type":"array",
    "description":"The course results resource provides a list of course results and statistics associated with a student.",
    "items":{
        "$ref":"#/components/schemas/studentAcademicResults-courseEnrollments-courseResults-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 : studentAcademicResults-courseEnrollments-courseResults-item-response

Type: object

Show Source

• Gradepoints: number
  Title: Student Result Grade Points

  Read Only: true

  The grade points value of the result, such as 4.00.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumericValue: number
  Title: Numeric Result

  Read Only: true

  The result value in numeric format, such as a score of 95.
• OutcomeCode: string
  Title: Outcome

  Read Only: true

  Maximum Length: 30

  The code of the result outcome. An example of a result outcome is Pass. A list of accepted values is defined in the lookup type ORA_HER_OUTCOME_CODE.
• OutcomeMeaning: string
  Title: Outcome Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the result outcome. A list of accepted values is defined in the lookup type ORA_HER_OUTCOME_CODE.
• ReleaseGradeDate: string (date)
  Title: Student Result Release Date

  Read Only: true

  The date when the result is available to the student.
• ResultId: integer
  Title: Result ID

  Read Only: true

  The generated primary key column for a result related to the enrollment record.
• ResultSetCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  The result set code of the result. Result sets are used to support various types of measurement such as grades, units, and grade points.
• ResultSetId: integer (int64)
  Title: Result Set ID

  Read Only: true

  The unique identifier of the result set. Result sets are used to support various types of measurement such as grades, units, and grade points.
• ResultSetName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The result set name, such as Letter Grade, of the result.
• ResultTypeCode: string
  Title: Result Type Code

  Read Only: true

  Maximum Length: 30

  The result type code of the result. An example of a result type is Course Result.
• ResultTypeId: integer (int64)
  Title: Result Type ID

  Read Only: true

  The unique identifier for the result type.
• ResultTypeName: string
  Title: Result Type

  Read Only: true

  Maximum Length: 50

  The result type name of the result. An example of a result type is Course Result.
• StatusCode: string
  Title: Result Status

  Read Only: true

  Maximum Length: 30

  The status code of the result. A list of accepted values is defined in the lookup type ORA_HER_RESULT_STATUS.
• StatusMeaning: string
  Title: Result Status Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the status code of the result. A list of accepted values is defined in the lookup type ORA_HER_RESULT_STATUS.
• TextValue: string
  Title: Text Result

  Read Only: true

  Maximum Length: 30

  The result value in text format, such as a grade of A.

{
    "type":"object",
    "properties":{
        "OutcomeCode":{
            "title":"Outcome",
            "maxLength":30,
            "type":"string",
            "description":"The code of the result outcome. An example of a result outcome is Pass. A list of accepted values is defined in the lookup type ORA_HER_OUTCOME_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Result Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the result. A list of accepted values is defined in the lookup type ORA_HER_RESULT_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultId":{
            "title":"Result ID",
            "type":"integer",
            "description":"The generated primary key column for a result related to the enrollment record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Result Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the status code of the result. A list of accepted values is defined in the lookup type ORA_HER_RESULT_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The result set code of the result. Result sets are used to support various types of measurement such as grades, units, and grade points.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OutcomeMeaning":{
            "title":"Outcome Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the result outcome. A list of accepted values is defined in the lookup type ORA_HER_OUTCOME_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultTypeCode":{
            "title":"Result Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The result type code of the result. An example of a result type is Course Result.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultTypeName":{
            "title":"Result Type",
            "maxLength":50,
            "type":"string",
            "description":"The result type name of the result. An example of a result type is Course Result.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetId":{
            "title":"Result Set ID",
            "type":"integer",
            "description":"The unique identifier of the result set. Result sets are used to support various types of measurement such as grades, units, and grade points.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TextValue":{
            "title":"Text Result",
            "maxLength":30,
            "type":"string",
            "description":"The result value in text format, such as a grade of A.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The result set name, such as Letter Grade, of the result.",
            "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"
            }
        },
        "NumericValue":{
            "title":"Numeric Result",
            "type":"number",
            "description":"The result value in numeric format, such as a score of 95.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Gradepoints":{
            "title":"Student Result Grade Points",
            "type":"number",
            "description":"The grade points value of the result, such as 4.00.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleaseGradeDate":{
            "title":"Student Result Release Date",
            "type":"string",
            "description":"The date when the result is available to the student.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultTypeId":{
            "title":"Result Type ID",
            "type":"integer",
            "description":"The unique identifier for the result type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}

Back to Top