Get all academic groups
get
/fscmRestApi/resources/11.13.18.05/academicGroups
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- AcademicGroupIdFinder Find all academic groups that match the given bind variable.
Finder Variables- BindAcademicGroupId; integer; Bind variable for the academic group ID finder.
- PrimaryKey Finds all academic groups that match the primary key criteria specified.
Finder Variables- CurriculumHeaderId; integer; Unique identifier for the academic group.
- AcademicGroupIdFinder Find all academic groups that match the given bind variable.
-
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:- AcademicGroupId; integer; The unique identifier for a curriculum item.
- AcademicLevelId; integer; The unique identifier for an academic level.
- AcademicOrgId; integer; The unique identifier for an academic organization.
- CurriculumBuildStatusId; integer; The unique identifier for a curriculum build status. A build status refers to the life cycle of a curriculum item.
- CurriculumBuildStatusName; string; The name of a build or lifecycle status code.
- CurriculumHeaderId; integer; The unique identifier for a curriculum header record, which is the record that's shared across all curriculum item types.
- CurriculumName; string; The name or short description of a curriculum item.
- CurriculumTitle; string; The title of a curriculum item.
- DefaultPlanFormatId; integer; The unique identifier for a plan format.
- InstitutionId; integer; The unique identifier for an institution.
- PlanFormatName; string; The name of a plan format, such as 4 year regular undergraduate.
- RequirementLongDescription; string; The description of the course and other requirements for a curriculum registry academic group definition.
- SystemStatusCode; string; A code for a build or life cycle status for an academic group, such as Under Review or Approved.
- SystemStatusMeaning; string; A value that determines whether a curriculum build status code is considered active or inactive.
-
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 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 : academicGroups
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 : academicGroups-item-response
Type:
Show Source
object
-
AcademicGroupId: integer
(int64)
Title:
Curriculum ID
Read Only:true
The unique identifier for a curriculum item. -
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
Read Only:true
The unique identifier for an academic level. -
AcademicOrgId: integer
(int64)
Title:
Academic Organization ID
Read Only:true
The unique identifier for an academic organization. -
CurriculumBuildStatusId: integer
(int64)
Title:
Curriculum Build Status ID
Read Only:true
The unique identifier for a curriculum build status. A build status refers to the life cycle of a curriculum item. -
CurriculumBuildStatusName: string
Title:
Build Status
Read Only:true
Maximum Length:50
The name of a build or lifecycle status code. -
CurriculumHeaderId: integer
(int64)
Title:
Curriculum Header ID
Read Only:true
The unique identifier for a curriculum header record, which is the record that's shared across all curriculum item types. -
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:150
The name or short description of a curriculum item. -
CurriculumTitle: string
Title:
Title
Read Only:true
Maximum Length:100
The title of a curriculum item. -
DefaultPlanFormatId: integer
(int64)
Title:
Plan Format ID
Read Only:true
The unique identifier for a plan format. -
elements: array
Elements
Title:
Elements
The elements resource is a child of the academic groups resource and lists all the elements associated with an academic group. -
InstitutionId: integer
(int64)
Title:
Institution ID
Read Only:true
The unique identifier for an institution. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
parameters: array
Parameters
Title:
Parameters
The parameters resource is a child of the programs resource and provides a list of program parameters for a program. -
PlanFormatName: string
Title:
Format Name
Read Only:true
Maximum Length:50
The name of a plan format, such as 4 year regular undergraduate. -
RequirementLongDescription: string
Title:
Requirements
Read Only:true
The description of the course and other requirements for a curriculum registry academic group definition. -
results: array
Results
Title:
Results
The results resource is a child of the academic groups resource and lists all the results associated with an academic group. -
SystemStatusCode: string
Title:
Build Status Code
Read Only:true
Maximum Length:30
A code for a build or life cycle status for an academic group, such as Under Review or Approved. -
SystemStatusMeaning: string
Title:
Curriculum Build Status
Read Only:true
A value that determines whether a curriculum build status code is considered active or inactive.
Nested Schema : Elements
Type:
array
Title:
Elements
The elements resource is a child of the academic groups resource and lists all the elements associated with an academic group.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Parameters
Type:
array
Title:
Parameters
The parameters resource is a child of the programs resource and provides a list of program parameters for a program.
Show Source
Nested Schema : Results
Type:
array
Title:
Results
The results resource is a child of the academic groups resource and lists all the results associated with an academic group.
Show Source
Nested Schema : academicGroups-elements-item-response
Type:
Show Source
object
-
ConnectorCode: string
Title:
Connector Code
Read Only:true
Maximum Length:30
The code for the connectors between the elements of a curriculum item. Valid values include ORA_AND or ORA_OR. A list of accepted values is defined in the lookup type ORA_HER__ELEMENT_CONNECTOR_CODE. -
ConnectorMeaning: string
Title:
Connector
Read Only:true
A logical connector used to connect curriculum item child elements. Valid values include And or Or. A list of accepted values is defined in the lookup type ORA_HER__ELEMENT_CONNECTOR_CODE. -
CurriculumId: integer
(int64)
Title:
Element Curriculum ID
Read Only:true
The curriculum ID for an item that's a child element of another curriculum item. -
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:150
The name or short description of a curriculum item. -
CurriculumType: string
Title:
Curriculum Type
Read Only:true
Maximum Length:50
The name of a curriculum type for which a curriculum build status code is valid. -
ElementId: integer
(int64)
Title:
Curriculum Element ID
Read Only:true
The unique identifier for a child element of a curriculum item. A child element might be a course or course list. -
LeftParenthesesQuantity: integer
(int32)
Title:
Left Parentheses Quantity
Read Only:true
The number of left parentheses included in a curriculum element row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RequirementCategoryCode: string
Title:
Requirement Category Code
Read Only:true
Maximum Length:30
The code for a requirement category, used for categorizing requirements in the Curriculum Registry. -
RequirementCategoryId: integer
(int64)
Title:
Requirement Category ID
Read Only:true
The unique identifier for a requirement category code. -
RequirementCategoryName: string
Title:
Name
Read Only:true
Maximum Length:50
The name or short description of a requirement category code. -
RightParenthesesQuantity: integer
(int32)
Title:
Right Parentheses Quantity
Read Only:true
The number of right parentheses included in a curriculum element row. -
SortNumber: integer
(int32)
Title:
Sort Number
Read Only:true
Determines the order in which the curriculum item elements are sorted.
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 : academicGroups-parameters-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumCoursesQuantity: integer
(int32)
Title:
Maximum Number of Courses
Read Only:true
Default Value:0
The maximum number of courses that can be taken toward satisfying a program parameter. -
MaximumUnitsQuantity: integer
(int32)
Title:
Maximum Units
Read Only:true
Default Value:0
The maximum number of credits available for a program. -
MinimumCoursesQuantity: integer
(int32)
Title:
Minimum Number of Courses
Read Only:true
Default Value:0
The minimum number of courses that must be taken toward satisfying a program parameter. -
MinimumUnitsQuantity: integer
(int32)
Title:
Minimum Units
Read Only:true
Default Value:0
The minimum number of credits available for a program. -
ParameterId: integer
(int64)
Title:
Curriculum Parameter ID
Read Only:true
The unique identifier for a parameter that's associated with a program element. -
ParameterSequenceNumber: integer
(int32)
Title:
Parameter Sequence Number
Read Only:true
The sequence number for a program parameter row. -
RequirementCategoryCode: string
Title:
Requirement Category Code
Read Only:true
Maximum Length:30
A code that categorizes program course requirements. -
RequirementCategoryId: integer
(int64)
Title:
Requirement Category ID
Read Only:true
The unique identifier for a requirement category code assigned to a program parameter. -
RequirementCategoryName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the requirement category code.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : academicGroups-results-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResultId: integer
(int64)
Title:
Curriculum Result ID
Read Only:true
The unique identifier for a curriculum result record. -
ResultSetCode: string
Title:
Code
Read Only:true
Maximum Length:30
The unique code for the result type. -
ResultSetId: integer
(int64)
Title:
Result Set ID
Read Only:true
The unique identifier for a result set. -
ResultSetName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the result set which is used to evaluate result types. -
ResultTypeCode: string
Title:
Result Type Code
Read Only:true
Maximum Length:30
The result type code for a student result record, such as cumulative GPA. -
ResultTypeId: integer
(int64)
Title:
Result Type ID
Read Only:true
The unique identifier for a result type. -
ResultTypeName: string
Title:
Result Type
Read Only:true
Maximum Length:50
The name of the result type assigned to the student, such as final grade or competency.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source