Get all academic levels
get
/fscmRestApi/resources/11.13.18.05/academicLevels
Request
Query Parameters
-
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- AcadLevelFinder Find the academic levels that match the criteria specified.
Finder Variables- AcademicLevelId; integer; Unique identifier for an academic level.
- ByKeywordFinder Finds all academic levels matching the specified keyword.
Finder Variables- Keyword; string; The keyword that's used to search against the academic level name, academic level code and status.
- InstitutionIdFinder Find all academic levels that match the institution identifier specified.
Finder Variables- InstitutionId; integer; Unique identifier for an institution.
- PrimaryKey Find all academic levels that match the primary key criteria specified.
Finder Variables- AcademicLevelId; integer; Unique identifier for an academic level.
- AcadLevelFinder Find the academic levels that match the criteria specified.
-
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:- AcademicLevelId; integer; The unique identifier for an academic level.
- ActiveFlag; boolean; Indicates the active status of the academic level.
- AllInstitutionsFlag; boolean; Indicates the academic level is available for all academic institutions.
- CreatedBy; string; The user who created the row.
- CreationDate; string; The date the row was created.
- Description; string; The description of the academic level.
- ForCreditFlag; boolean; Indicates the academic level is for credit.
- LastUpdateDate; string; The date the row was last updated.
- LastUpdatedBy; string; The user who last updated the row.
- LevelCode; string; The code of the academic level.
- LevelName; string; The name of the academic level.
- LevelStatus; string; The status meaning of the academic level.
- LevelStatusCode; string; The status code of the academic level. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LEVEL_STATUS_CODE.
- MinimumFullTimeUnits; number; The minimum full time units indicates the minimum number of units of credit required to be considered a full time student.
- PrimacyNumber; integer; The primacy number of the academic level. Use primacy numbers to specify the primary program for purposes such as reporting and tuition calculation.
- RepeatFailureHandlerCode; string; Indicates the action to be taken when a course repeat attempt isn't successful. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE.
- RepeatFailureHandlerMeaning; string; The meaning of repeat failure handler code. Valid values include None, Error or Warning. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE.
- RequiresStudentProgramFlag; boolean; Indicates that a student can enroll only if the student is assigned to a program.
- TypeOfCredit; string; The meaning of the type of credit. Valid values include Continuing education units, Credit hours and No Credit Type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
- TypeOfCreditCode; string; Indicates the type of credit generally earned for this academic level. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
-
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
-
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 TopResponse
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.
Root Schema : academicLevels
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : academicLevels-item-response
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
Read Only:true
The unique identifier for an academic level. -
ActiveFlag: boolean
Title:
Academic Level Active
Read Only:true
Maximum Length:1
Indicates the active status of the academic level. -
AllInstitutionsFlag: boolean
Title:
Available for all institutions
Read Only:true
Maximum Length:1
Default Value:false
Indicates the academic level is available for all academic institutions. -
assignments: array
Drop Scheme Settings Assignments
Title:
Drop Scheme Settings Assignments
The assignments resource provides a list of academic entities which have been assigned. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
Description: string
Title:
Academic Level Description
Maximum Length:1000
The description of the academic level. -
enrollmentInclusions: array
Enrollment Inclusions
Title:
Enrollment Inclusions
The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level. -
ForCreditFlag: boolean
Maximum Length:
1
Default Value:true
Indicates the academic level is for credit. -
institutions: array
Institutions
Title:
Institutions
The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
LevelCode: string
Title:
Academic Level Code
Maximum Length:100
The code of the academic level. -
LevelName: string
Title:
Academic Level Name
Maximum Length:100
The name of the academic level. -
LevelStatus: string
Read Only:
true
Maximum Length:80
The status meaning of the academic level. -
LevelStatusCode: string
Maximum Length:
30
Default Value:ORA_INACTIVE
The status code of the academic level. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LEVEL_STATUS_CODE. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumFullTimeUnits: number
Default Value:
0
The minimum full time units indicates the minimum number of units of credit required to be considered a full time student. -
PrimacyNumber: integer
(int32)
Title:
Primacy Number
The primacy number of the academic level. Use primacy numbers to specify the primary program for purposes such as reporting and tuition calculation. -
RepeatFailureHandlerCode: string
Title:
Enrollment Repeat Option
Maximum Length:30
Default Value:ORA_NONE
Indicates the action to be taken when a course repeat attempt isn't successful. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE. -
RepeatFailureHandlerMeaning: string
Title:
Repeat Handler Meaning
Read Only:true
Maximum Length:80
The meaning of repeat failure handler code. Valid values include None, Error or Warning. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE. -
RequiresStudentProgramFlag: boolean
Title:
Requires student program
Maximum Length:1
Indicates that a student can enroll only if the student is assigned to a program. -
TypeOfCredit: string
Read Only:
true
Maximum Length:80
The meaning of the type of credit. Valid values include Continuing education units, Credit hours and No Credit Type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE. -
TypeOfCreditCode: string
Maximum Length:
30
Indicates the type of credit generally earned for this academic level. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
Nested Schema : Drop Scheme Settings Assignments
Type:
array
Title:
Drop Scheme Settings Assignments
The assignments resource provides a list of academic entities which have been assigned.
Show Source
Nested Schema : Enrollment Inclusions
Type:
array
Title:
Enrollment Inclusions
The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.
Show Source
Nested Schema : Institutions
Type:
array
Title:
Institutions
The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : academicLevels-assignments-item-response
Type:
Show Source
object
-
AssignedEntityCode: string
Title:
Entity Code
Read Only:true
Maximum Length:100
The user defined identifier of the associated entity. -
AssignedEntityId: integer
(int64)
Title:
Entity ID
The unique identifier of the associated entity. -
AssignedEntityName: string
Title:
Entity Name
Read Only:true
Maximum Length:100
The name of the associated entity. -
AssignedEntityStatusCode: string
Read Only:
true
Maximum Length:30
The status code of the entity. This controls the availability of the entity for assignments to settings. -
AssignedEntityStatusMeaning: string
Read Only:
true
Maximum Length:80
The status of the entity. -
AssignedEntitySubTypeCode: string
Title:
Entity Subtype Code
Read Only:true
Maximum Length:30
The entity subtype code of the associated entity. -
AssignedEntitySubTypeMeaning: string
Title:
Entity Subtype
Read Only:true
Maximum Length:80
The entity subtype of the associated entity. -
AssignedEntityTypeCode: string
Title:
Entity Type Code
Maximum Length:30
A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
AssignedEntityTypeMeaning: string
Title:
Entity Type
Read Only:true
Maximum Length:80
The entity type of the associated entity. -
AssignedSettingsObjectId: integer
(int64)
The unique identifier of the associated setting.
-
AssignedSettingsTypeCode: string
Maximum Length:
30
Default Value:ORA_HER_ACADEMIC_LEVEL
A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_TYPE. -
AssignmentEndDate: string
(date)
Title:
Assignment End Date
The end or expiration date of the entity assignment. -
AssignmentMethodMeaning: string
Read Only:
true
Maximum Length:80
The assignment method type meaning used to indicate how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD. -
AssignmentMethodTypeCode: string
Maximum Length:
30
Default Value:ORA_DIRECT
The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD. -
AssignmentStartDate: string
(date)
Title:
Assignment Start Date
The start date of the entity assignment. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RelatedEntityCode: string
Read Only:
true
Maximum Length:100
The user defined identifier of the related entity. -
RelatedEntityId: integer
(int64)
The unique identifier of the related entity.
-
RelatedEntityName: string
Read Only:
true
Maximum Length:100
The name of the related entity. -
RelatedEntityTypeCode: string
Maximum Length:
30
A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
RelatedEntityTypeMeaning: string
Read Only:
true
Maximum Length:80
The entity type of the related entity. -
SettingsAssignmentId: integer
(int64)
Title:
Settings Assignment ID
Read Only:true
The unique identifier for the setup association record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : academicLevels-enrollmentInclusions-item-response
Type:
Show Source
object
-
EnrollmentInclusionId: integer
(int64)
Title:
Academic Level Enrollment Inclusion ID
Read Only:true
The unique identifier for an enrollment inclusion. Enrollment inclusions at the course academic level indicate the student academic levels that are eligible to enroll in a course. Inclusions apply only when enrollment is restricted to students who are assigned to a program. -
IncludeAcademicLevelId: integer
(int64)
Title:
Included Academic Level ID
The unique identifier for the academic level that's included for enrollment. -
IncludeLevelCode: string
Read Only:
true
Maximum Length:100
The code of the academic level. -
IncludeLevelName: string
Read Only:
true
Maximum Length:100
The name of the academic level. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : academicLevels-institutions-item-response
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
Read Only:
true
Unique identifier for an academic level. -
AcademicLevelInstitutionId: integer
(int64)
Read Only:
true
The unique identifier for the institution that's associated with an academic level. -
InstitutionId: integer
(int64)
Read Only:
true
The unique identifier of an academic institution. -
InstitutionName: string
Title:
Institution
Read Only:true
Maximum Length:50
The name of the institution. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source