Get a period
get
/fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}
Request
Path Parameters
-
academicPlanTemplatesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Academic Plan Templates resource and used to uniquely identify an instance of Academic Plan Templates. The client should not generate the hash key value. Instead, the client should query on the Academic Plan Templates collection resource in order to navigate to a specific instance of Academic Plan Templates to get the hash key.
-
periodsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- TemplatePeriodId and TemplateInstructionId ---for the Periods resource and used to uniquely identify an instance of Periods. The client should not generate the hash key value. Instead, the client should query on the Periods collection resource with a filter on the primary key values in order to navigate to a specific instance of Periods.
For example: periods?q=TemplatePeriodId=<value1>;TemplateInstructionId=<value2>
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> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : 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 : 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-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
Links
- elements
-
Parameters:
- academicPlanTemplatesUniqID:
$request.path.academicPlanTemplatesUniqID
- periodsUniqID:
$request.path.periodsUniqID
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. - academicPlanTemplatesUniqID:
- tiers
-
Parameters:
- academicPlanTemplatesUniqID:
$request.path.academicPlanTemplatesUniqID
- periodsUniqID:
$request.path.periodsUniqID
The tiers resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template. - academicPlanTemplatesUniqID: