Get all academic plan templates
get
/fscmRestApi/resources/11.13.18.05/academicPlanTemplates
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 academic plan templates that match the primary key criteria specified.
Finder Variables- TemplateId; integer; Unique identifier for the academic plan template.
- TemplateNameFinder Finds all academic plan templates that match the keyword specified.
Finder Variables- Keyword; string; Keyword; string; for the academic plan template.
- PrimaryKey Finds all academic plan templates that match the primary key 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:- AcademicGroupId; integer; The unique identifier for an academic group value that's associated with an academic plan template.
- AcademicGroupName; string; The name of an academic group that's associated with an academic plan template.
- AcademicLoadCode; string; The code of academic load associated with the plan template such as full time or part time.
- AcademicLoadMeaning; string; The academic load associated with the plan template such as full time or part time.
- ActiveFlag; boolean; Indicates whether the academic plan template is active or inactive.
- BuildAcademicPlanFlag; boolean; Indicates whether the build academic plan option for academic plan template is active or inactive.
- CreationDate; string; Who column: indicates the date and time of the creation of the row for the academic plan template.
- CreditTypeCode; string; The code of the credit type that's associated with an academic plan template.
- CreditTypeMeaning; string; The credit type that's associated with an academic plan template.
- CurriculumType; string; The curriculum type that's associated with an academic plan template.
- CurriculumTypeId; integer; The unique identifier for a curriculum type value that's associated with an academic plan template.
- DeleteAcademicPlanFlag; boolean; Indicates whether the delete academic plan option for academic plan template is active or inactive.
- EndDate; string; The end date of the academic plan template.
- InstitutionId; integer; The unique identifier for an institution value that's associated with an academic plan template.
- InstitutionName; string; The name of an institution that's associated with an academic plan template.
- LastUpdateDate; string; Who column: indicates the date and time of the last update of the row for the academic plan template.
- LockPlanFlag; boolean; Indicates whether the lock plan option for academic plan template is active or inactive.
- LongDescription; string; The description of the academic plan template.
- MaximumCoursesQuantity; integer; The maximum number of courses required for the plan template.
- MaximumUnitsQuantity; integer; The maximum units required for the plan template.
- MinimumCoursesQuantity; integer; The minimum number of courses required for the plan template.
- MinimumUnitsQuantity; integer; The minimum units required for the plan template.
- PlanCreatedFlag; boolean; Indicates whether the plan created option for academic plan template is active or inactive.
- PlanFormatId; integer; The unique identifier for the associated plan format.
- PlanFormatName; string; The name of a plan format that's associated with an academic plan template.
- StartDate; string; The start date of the academic plan template.
- TemplateCode; string; The unique code to identify the plan template.
- TemplateId; integer; The unique identifier for the academic plan template record.
- TemplateLockFlag; boolean; Indicates whether the template will allow locking of template periods and elements.
- TemplateName; string; The name of the academic plan template.
-
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 : academicPlanTemplates
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 : academicPlanTemplates-item-response
Type:
Show Source
object
-
AcademicGroupId: integer
(int64)
Title:
Academic Group ID
The unique identifier for an academic group value that's associated with an academic plan template. -
AcademicGroupName: string
Title:
Academic Group Name
Read Only:true
Maximum Length:50
The name of an academic group that's associated with an academic plan template. -
AcademicLoadCode: string
Title:
AcademicLoadCode
Maximum Length:30
The code of academic load associated with the plan template such as full time or part time. -
AcademicLoadMeaning: string
Title:
AcademicLoadMeaning
Read Only:true
Maximum Length:80
The academic load associated with the plan template such as full time or part time. -
ActiveFlag: boolean
Title:
Active
Maximum Length:2
Indicates whether the academic plan template is active or inactive. -
BuildAcademicPlanFlag: boolean
Indicates whether the build academic plan option for academic plan template is active or inactive.
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Who column: indicates the user who created the row for the academic plan template. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Who column: indicates the date and time of the creation of the row for the academic plan template. -
CreditTypeCode: string
Title:
Credit Type Code
Maximum Length:30
The code of the credit type that's associated with an academic plan template. -
CreditTypeMeaning: string
Read Only:
true
Maximum Length:80
The credit type that's associated with an academic plan template. -
CurriculumType: string
Title:
Curriculum Type
Read Only:true
Maximum Length:30
The curriculum type that's associated with an academic plan template. -
CurriculumTypeId: integer
(int64)
Title:
Curriculum Type ID
Read Only:true
The unique identifier for a curriculum type value that's associated with an academic plan template. -
DeleteAcademicPlanFlag: boolean
Indicates whether the delete academic plan option for academic plan template is active or inactive.
-
EndDate: string
(date)
Title:
End Date
The end date of the academic plan template. -
InstitutionId: integer
(int64)
Title:
Institution ID
The unique identifier for an institution value that's associated with an academic plan template. -
InstitutionName: string
Title:
Institution
Maximum Length:50
The name of an institution that's associated with an academic plan template. -
instructions: array
Instructions
Title:
Instructions
The instructions resource is a child of the academic plan templates resource and provides a list of instructions associated with an academic plan template. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Who column: indicates the date and time of the last update of the row for the academic plan template. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Who column: indicates the user who last updated the row for the academic plan template. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockPlanFlag: boolean
Title:
Lock Plan Indicator
Maximum Length:1
Default Value:false
Indicates whether the lock plan option for academic plan template is active or inactive. -
LongDescription: string
Title:
Long Description
The description of the academic plan template. -
MaximumCoursesQuantity: integer
(int32)
Title:
Maximum Courses
Default Value:0
The maximum number of courses required for the plan template. -
MaximumUnitsQuantity: integer
(int32)
Title:
Maximum Units
Default Value:0
The maximum units required for the plan template. -
MinimumCoursesQuantity: integer
(int32)
Title:
Minimum Courses
Default Value:0
The minimum number of courses required for the plan template. -
MinimumUnitsQuantity: integer
(int32)
Title:
Minimum Units
Default Value:0
The minimum units required for the plan template. -
owners: array
Owners
Title:
Owners
The owners resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template. -
periods: array
Periods
Title:
Periods
The periods resource is a child of the academic plan templates resource and provides a list of academic periods associated with an academic plan template. -
PlanCreatedFlag: boolean
Read Only:
true
Indicates whether the plan created option for academic plan template is active or inactive. -
PlanFormatId: integer
(int64)
Title:
Plan Format ID
The unique identifier for the associated plan format. -
PlanFormatName: string
Title:
Format Name
Maximum Length:50
The name of a plan format that's associated with an academic plan template. -
StartDate: string
(date)
Title:
Start Date
The start date of the academic plan template. -
TemplateCode: string
Title:
Plan Template Code
Maximum Length:50
The unique code to identify the plan template. -
TemplateId: integer
(int64)
Title:
Plan Template ID
Read Only:true
The unique identifier for the academic plan template record. -
TemplateLockFlag: boolean
Title:
Enable Template Lock
Maximum Length:1
Indicates whether the template will allow locking of template periods and elements. -
TemplateName: string
Title:
Plan Template Name
Maximum Length:50
The name of the academic plan template.
Nested Schema : Instructions
Type:
array
Title:
Instructions
The instructions resource is a child of the academic plan templates resource and provides a list of instructions associated with an academic plan template.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Owners
Type:
array
Title:
Owners
The owners resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.
Show Source
Nested Schema : Periods
Type:
array
Title:
Periods
The periods resource is a child of the academic plan templates resource and provides a list of academic periods associated with an academic plan template.
Show Source
Nested Schema : academicPlanTemplates-instructions-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Who column: indicates the user who created the row with the instructions. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Who column: indicates the date and time of the creation of the row with the instructions. -
InstructionContextCode: string
Title:
Instruction Context Code
Maximum Length:30
Identifies the context of the instructions. -
InstructionOwnerId: integer
(int64)
Title:
Instruction Owner ID
The unique identifier for the instructions owner that's associated with the instructions. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Who column: indicates the date and time of the last update of the row with the instructions. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Who column: indicates the user who last updated the row with the instructions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeriodName: string
Title:
Period Name
Read Only:true
Maximum Length:50
The name of the period associated with the instructions. -
TemplateInstructionId: integer
(int64)
Title:
Template Instruction ID
The unique identifier for the template instructions associated with the academic plan template. -
TemplateInstructions: string
The template instructions that convey academic plan requirements to the student or administrator.
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 : academicPlanTemplates-owners-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Who column: indicates the user who created the row of the owning curriculum item. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Who column: indicates the date and time of the creation of the row of the owning curriculum item. -
CurriculumHeaderId: integer
Title:
Curriculum Header ID
Read Only:true
The unique identifier for the curriculum header of the owning curriculum item. -
CurriculumId: integer
(int64)
Title:
Curriculum ID
The unique identifier for the curriculum owner of the plan template. -
CurriculumName: string
Title:
Curriculum Name
Read Only:true
The curriculum name of the owning curriculum item. -
CurriculumType: string
Title:
Curriculum Type
Read Only:true
Maximum Length:30
The curriculum type of the owning curriculum item. -
CurriculumTypeId: integer
(int64)
Title:
Curriculum Type ID
The unique identifier for the curriculum type of the owning curriculum item. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Who column: indicates the date and time of the last update of the row of the owning curriculum item. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Who column: indicates the user who last updated the row of the owning curriculum item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MainProgramFlag: boolean
Title:
Main Program
Read Only:true
Maximum Length:1
Indicates whether the program is a main program. -
OwningItemFlag: boolean
Title:
Primary Plan Item
Maximum Length:1
Identifies the primary owning curriculum item. -
ProgramTypeCode: string
Title:
Program Type Code
Read Only:true
Maximum Length:30
The program type code indicating the type of program. -
ProgramTypeId: integer
(int64)
Title:
Program Type ID
The unique identifier for the program type of the program ownership items. -
ProgramTypeName: string
Title:
Program Type
Read Only:true
Maximum Length:50
The program type of the program ownership items. -
SequenceNumber: integer
(int32)
Title:
Owning Item Sequence
Used to sequence the order of the ownership records. -
TemplateOwnerId: integer
(int64)
Title:
Template Owner ID
The unique identifier for the plan template ownership record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : academicPlanTemplates-periods-item-response
Type:
Show Source
object
-
ContactHoursQuantity: integer
(int32)
Title:
Contact Hours
The number of contact hours required for the plan period. -
CourseCountQuantity: integer
(int32)
Title:
Period Course Count
Default Value:0
The courses planned for the plan period. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Who column: indicates the user who created the row for the plan period. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Who column: indicates the date and time of the creation of the row for the plan period. -
elements: array
Elements
Title:
Elements
The elements resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template. -
FormatPeriodId: integer
(int64)
Title:
Period ID
The unique identifier for the associated plan format period. -
InstructionContextCode: string
Title:
Instruction Context Code
Read Only:true
Maximum Length:30
Identifies the context of the instruction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Who column: indicates the date and time of the last update of the row for the plan period. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Who column: indicates the user who last updated the row for the plan period. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockPeriodFlag: boolean
Title:
Lock Period
Maximum Length:1
Locks the plan period, indicating the period is required. -
MaximumCoursesQuantity: integer
(int32)
Title:
Maximum Courses
Default Value:0
The maximum number of courses required for the plan period. -
MaximumUnitsQuantity: integer
(int32)
Title:
Maximum Units
Default Value:0
The maximum units required for the plan period. -
MinimumCoursesQuantity: integer
(int32)
Title:
Minimum Courses
Default Value:0
The minimum number of courses required for the plan period. -
MinimumUnitsQuantity: integer
(int32)
Title:
Minimum Units
Default Value:0
The minimum units required for the plan period. -
OptionalPeriodFlag: boolean
Title:
Optional Period
Maximum Length:1
Default Value:false
Indicates that the plan period is optional. -
PeriodName: string
Title:
Period Name
Maximum Length:50
The name of the academic plan template period. -
TemplateInstructionId: integer
(int64)
Read Only:
true
The unique identifier for the template instruction. -
TemplateInstructions: string
Title:
Period Instructions
The period instructions that convey academic plan requirements to the student or administrator. -
TemplatePeriodId: integer
(int64)
Title:
Template Period ID
The unique identifier for the academic plan template period record. -
TemplatePeriodLevelNumber: integer
(int32)
Title:
Period Level Number
The level of the template period within the template. -
TemplatePeriodLevelSequence: integer
(int32)
Title:
Template Period Level Sequence
The sequence of the plan periods within the template period level. -
TemplatePeriodOverallSequence: integer
(int32)
Title:
Template Period Overall Sequence
The overall sequence of the plan periods for the template. -
TemplatePeriodParentId: integer
(int64)
Title:
Template Period ID
The template period ID of the parent template period. -
tiers: array
Tiers
Title:
Tiers
The tiers resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template. -
UnitCountQuantity: integer
(int32)
Title:
Period Unit Count
Default Value:0
The units planned for the plan period.
Nested Schema : Elements
Type:
array
Title:
Elements
The elements resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Tiers
Type:
array
Title:
Tiers
The tiers resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.
Show Source
Nested Schema : academicPlanTemplates-periods-elements-item-response
Type:
Show Source
object
-
ContactHoursQuantity: integer
(int32)
Title:
Contact Hours
The number of contact hours required for the period element. -
courseRequisites: array
Course Requisites
Title:
Course Requisites
The courseRequisites resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Who column: indicates the user who created the row for the curriculum course element. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Who column: indicates the date and time of the creation of the row for the curriculum course element. -
CreditTypeMeaning: string
Title:
Type of Credit Meaning
Read Only:true
Maximum Length:80
The credit type that's associated with the curriculum course element. -
DeleteActionFlag: boolean
Title:
Delete Action
Indicates whether the delete action for curriculum course element is active or inactive. -
ElementCatalogNumber: string
Title:
Catalog Number
Read Only:true
Maximum Length:10
The catalog number of the curriculum course element. -
ElementCurriculumId: integer
(int64)
Title:
Element Curriculum ID
The curriculum item identifier for the curriculum course element. -
ElementCurriculumName: string
Title:
Element Curriculum Name
Read Only:true
Maximum Length:50
The curriculum item name of the curriculum course element. -
ElementCurriculumType: string
Title:
Element Curriculum Type
Read Only:true
Maximum Length:30
The curriculum item type of the curriculum course element. -
ElementCurriculumTypeId: integer
(int64)
Title:
Element Curriculum Type ID
Read Only:true
The curriculum item type identifier for the curriculum course element. -
ElementCurriculumTypeName: string
Title:
Element Curriculum Type Name
Read Only:true
Maximum Length:50
The curriculum item type name of the curriculum course element. -
ElementSubjectCode: string
Title:
Element Subject Code
Read Only:true
Maximum Length:30
The curriculum item subject code of the curriculum course element. -
HierarchyPath: string
The hierarchy path of the curriculum course element.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Who column: indicates the date and time of the last update of the row for the curriculum course element. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Who column: indicates the user who last updated the row for the curriculum course element. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockElementFlag: boolean
Title:
Lock Element
Maximum Length:1
Locks the plan template element, preventing changes or removal of the element. -
MaximumCoursesQuantity: integer
(int32)
Title:
Maximum Courses
Default Value:0
The maximum number of courses required for the curriculum course element. -
MaximumRequiredUnitsQuantity: integer
(int32)
Title:
Maximum Units
Default Value:0
The maximum number of units required for the curriculum course element. -
MaximumUnitsQuantity: number
Title:
Maximum Units
Read Only:true
The maximum units required for the curriculum course element. -
MinimumRequiredCoursesQuantity: integer
(int32)
Title:
Minimum Number of Courses
Default Value:0
The minimum number of courses required for the period element. -
MinimumRequiredUnitsQuantity: integer
(int32)
Title:
Minimum Required Units
Default Value:0
The minimum units required for the period element. -
MinimumUnitsQuantity: number
Title:
Minimum Units
Read Only:true
The minimum units required for the curriculum course element. -
PeriodElementId: integer
(int64)
Title:
Plan Period Element ID
The unique identifier for the template period element. -
PeriodElementSequence: integer
(int32)
Title:
Period Element Sequence
The sequence of the template elements within a template period. - relatedElements: array Related Elements
-
RequirementCategoryId: integer
(int64)
Title:
Requirement Category ID
The requirement category for the period element. -
SourceCurriculumId: integer
(int64)
Title:
Source Curriculum ID
The curriculum item identifier for the source curriculum item. -
SourceCurriculumName: string
Title:
Source Curriculum Name
Read Only:true
Maximum Length:50
The curriculum item name of the requirement source curriculum item. -
SourceCurriculumType: string
Title:
Source Curriculum Type
Read Only:true
Maximum Length:30
The curriculum item type of the requirement source curriculum item. -
SourceCurriculumTypeId: integer
(int64)
Title:
Source Curriculum Type ID
Read Only:true
The curriculum item type identifier for the requirement source curriculum item. -
SourceCurriculumTypeName: string
Title:
Source Curriculum Type Name
Read Only:true
Maximum Length:50
The curriculum item type name of the requirement source curriculum item. -
TemplatePeriodId: integer
(int64)
Title:
Template Period ID
The unique identifier for the template period.
Nested Schema : Course Requisites
Type:
array
Title:
Course Requisites
The courseRequisites resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : academicPlanTemplates-periods-elements-courseRequisites-item-response
Type:
Show Source
object
-
AcademicSubjectCode: string
Title:
Subject Code
Read Only:true
Maximum Length:30
The academic subject of the course requisite in the academic plan template. -
AcademicSubjectId: integer
(int64)
Title:
Academic Subject ID
Read Only:true
The unique identifier for the academic subject for the course requisite. -
CurriculumCatalogNumber: string
Title:
Catalog Number
Read Only:true
Maximum Length:10
The curriculum catalog number of the course requisite in the academic plan template. -
CurriculumCourseId: integer
(int64)
Read Only:
true
The unique identifier for the curriculum course for the curriculum course requisite. -
CurriculumHeaderId: integer
(int64)
Read Only:
true
The unique identifier for the curriculum header of the course requisite. -
CurriculumId: integer
(int64)
Title:
Curriculum ID
Read Only:true
The unique identifier for the curriculum for the curriculum course requisite. -
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:50
The curriculum name of the course requisite in the academic plan template. -
CurriculumOfferingId: integer
(int64)
Read Only:
true
The unique identifier for the curriculum offering for the course requisite. -
CurriculumRequisiteId: integer
(int64)
Read Only:
true
The unique identifier for the curriculum requisite for the curriculum course requisite. -
EffectiveEndDate: string
(date)
Read Only:
true
The effective end date of the course requisite in the academic plan template. -
EffectiveStartDate: string
(date)
Read Only:
true
The effective start date of the course requisite in the academic plan template. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OfferStandard: string
Read Only:
true
The offer standard of the course requisite in the academic plan template. -
RequisiteCurriculumId: integer
(int64)
Read Only:
true
The unique identifier for the requisite curriculum for the curriculum course requisite. -
RequisiteCurriculumName: string
Title:
Requisite Curriculum Name
Read Only:true
The requisite curriculum name of the course requisite in the academic plan template. -
RequisiteTypeCode: string
Read Only:
true
Maximum Length:30
The requisite type of the course requisite in the academic plan template.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : academicPlanTemplates-periods-tiers-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Who column: indicates the user who created the row for the plan period tier. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Who column: indicates the date and time of the creation of the row for the plan period tier. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Who column: indicates the date and time of the last update of the row for the plan period tier. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Who column: indicates the user who last updated the row for the plan period tier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeriodTierCode: string
Title:
Period Tier Code
Maximum Length:30
Identifies valid academic period tiers for this plan period. -
PeriodTierMeaning: string
Title:
Period Tier Meaning
Read Only:true
Maximum Length:80
The academic period tier that's associated with this plan period. -
TemplatePeriodTierId: integer
(int64)
Title:
Template Period Tier ID
The unique identifier for the plan period tier.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source