Create all periods
post
/fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods
Request
Path Parameters
-
studentAcademicPlansUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Student Academic Plans resource and used to uniquely identify an instance of Student Academic Plans. The client should not generate the hash key value. Instead, the client should query on the Student Academic Plans collection resource in order to navigate to a specific instance of Student Academic Plans to get the hash key.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
elements: array
Elements
Title:
Elements
The elements resource is a child of the periods resource and provides a list of curriculum items associated with a student academic plan. -
FormatPeriodId: integer
(int64)
Title:
Period ID
The unique identifier for the associated plan format period. -
LockPeriodFlag: boolean
Title:
Lock Period
Maximum Length:1
Default Value:false
Locks the plan period, indicating the period is required. -
PeriodCourseCountQuantity: integer
(int32)
Title:
Period Course Count
The courses planned for the plan period. -
PeriodSequence(required): integer
(int32)
Title:
Period Sequence Number
Sequence of the plan format period within a level. -
PeriodUnitCountQuantity: integer
(int32)
Title:
Period Unit Count
The units planned for the plan period. -
PlanPeriodId: integer
(int64)
Title:
Plan Period ID
The unique identifier for the plan period. -
ReportingPeriodId: integer
(int64)
Title:
Reporting Period ID
Unique identifier for the student academic plan reporting period. -
ScheduleEnabledFlag: boolean
Indicates whether the period can be used to create a scheduler.
-
TemplatePeriodId: integer
(int64)
Title:
Template Period ID
The unique identifier for the academic plan template period record.
Nested Schema : Elements
Type:
array
Title:
Elements
The elements resource is a child of the periods resource and provides a list of curriculum items associated with a student academic plan.
Show Source
Nested Schema : studentAcademicPlans-periods-elements-item-post-request
Type:
Show Source
object
-
ContactHoursQuantity: integer
(int32)
Title:
Contact Hours
The number of contact hours required for the period element. -
DeleteActionFlag: boolean
Title:
Delete Action
Indicates whether the delete action flag for curriculum course element is active or inactive. -
ElementCurriculumId: integer
(int64)
Title:
Element Curriculum ID
The curriculum item identifier for the curriculum course element. -
LockElementFlag: boolean
Title:
Lock Element
Maximum Length:1
Default Value:false
Locks the plan template element, preventing changes or removal of the element. -
MinimumRequiredUnitsQuantity: integer
(int32)
Title:
Minimum Required Units
The minimum units required for the period element. -
NumberOfUnitsTakenQuantity: integer
(int32)
Title:
Number of Units Taken
The number of units taken for the period element. -
PeriodElementId: integer
(int64)
Title:
Plan Period Element ID
The unique identifier for the plan period element. -
PeriodElementSequence(required): integer
(int32)
Title:
Period Element Sequence
The sequence of the plan elements within a plan period. - relatedElements: array Related Elements
-
SourceCurriculumId: integer
(int64)
Title:
Source Curriculum ID
Unique identifier for the requirement source curriculum item.
Response
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 : studentAcademicPlans-periods-item-response
Type:
Show Source
object
-
elements: array
Elements
Title:
Elements
The elements resource is a child of the periods resource and provides a list of curriculum items associated with a student academic plan. -
EndDate: string
(date)
Title:
End Date
Read Only:true
The end date of the period. -
FormatPeriodId: integer
(int64)
Title:
Period ID
The unique identifier for the associated plan format period. -
FormatPeriodName: string
Title:
Period Name
Read Only:true
Maximum Length:50
The name of the academic plan format period. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockPeriodFlag: boolean
Title:
Lock Period
Maximum Length:1
Default Value:false
Locks the plan period, indicating the period is required. -
ParentFormatPeriodId: integer
(int64)
Title:
Parent Format Period ID
Read Only:true
The Identifier for the parent format period. -
ParentFormatPeriodName: string
Title:
Parent Format Period Name
Read Only:true
Maximum Length:50
The name of the parent format period. -
ParentTemplatePeriodId: integer
(int64)
Title:
Parent Template Period ID
Read Only:true
The Identifier for the parent template period. -
ParentTemplatePeriodName: string
Title:
Parent Template Period Name
Read Only:true
Maximum Length:50
The name of the parent template period. -
PeriodCourseCountQuantity: integer
(int32)
Title:
Period Course Count
The courses planned for the plan period. -
PeriodInstructions: string
Title:
Period Instructions
Read Only:true
The period instructions that convey academic plan requirements to the student or administrator. -
PeriodSequence: integer
(int32)
Title:
Period Sequence Number
Sequence of the plan format period within a level. -
PeriodUnitCountQuantity: integer
(int32)
Title:
Period Unit Count
The units planned for the plan period. -
PlanPeriodId: integer
(int64)
Title:
Plan Period ID
The unique identifier for the plan period. -
ReportingPeriodId: integer
(int64)
Title:
Reporting Period ID
Unique identifier for the student academic plan reporting period. -
ReportingPeriodName: string
Title:
Reporting Period Name
Read Only:true
Maximum Length:50
The name of the reporting period. -
ScheduleEnabledFlag: boolean
Indicates whether the period can be used to create a scheduler.
-
StartDate: string
(date)
Title:
Start Date
Read Only:true
The start date of the period. -
TemplatePeriodId: integer
(int64)
Title:
Template Period ID
The unique identifier for the academic plan template period record. -
TemplatePeriodName: string
Title:
Period Name
Read Only:true
Maximum Length:50
The name of the academic plan template period.
Nested Schema : Elements
Type:
array
Title:
Elements
The elements resource is a child of the periods resource and provides a list of curriculum items associated with a student academic plan.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : studentAcademicPlans-periods-elements-item-response
Type:
Show Source
object
-
ContactHoursQuantity: integer
(int32)
Title:
Contact Hours
The number of contact hours required for the period element. -
DeleteActionFlag: boolean
Title:
Delete Action
Indicates whether the delete action flag for curriculum course element is active or inactive. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockElementFlag: boolean
Title:
Lock Element
Maximum Length:1
Default Value:false
Locks the plan template element, preventing changes or removal of the element. -
MinimumRequiredUnitsQuantity: integer
(int32)
Title:
Minimum Required Units
The minimum units required for the period element. -
NumberOfUnitsTakenQuantity: integer
(int32)
Title:
Number of Units Taken
The number of units taken for the period element. -
PeriodElementId: integer
(int64)
Title:
Plan Period Element ID
The unique identifier for the plan period element. -
PeriodElementSequence: integer
(int32)
Title:
Period Element Sequence
The sequence of the plan elements within a plan period. - relatedElements: array Related Elements
-
SourceCurriculumId: integer
(int64)
Title:
Source Curriculum ID
Unique identifier for the requirement 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
Unique identifier for the requirement source curriculum type. -
SourceCurriculumTypeName: string
Title:
Source Curriculum Type Name
Read Only:true
Maximum Length:50
The curriculum item type name of the requirement source curriculum item.
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.
Links
- elements
-
Parameters:
- PlanPeriodId:
$request.path.PlanPeriodId
- studentAcademicPlansUniqID:
$request.path.studentAcademicPlansUniqID
The elements resource is a child of the periods resource and provides a list of curriculum items associated with a student academic plan. - PlanPeriodId: