Update a student academic plan
patch
/fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}
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
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CommentText: string
Title:
Comment Text
The attribute to store student's comments or notes for the academic plan. -
conflicts: array
Conflicts
Title:
Conflicts
The conflicts resource is a child of the student academic plans resource and provides a list of conflicts associated with a student academic plan. -
InstitutionId: integer
(int64)
Title:
Institution ID
Unique identifier for the associated institution. -
items: array
Items
Title:
Items
The items resource is a child of the student academic plans resource and provides a list of curriculum items associated with a student academic plan. -
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. -
PlanFormatId: integer
(int64)
Title:
Plan Format ID
Unique identifier for the associated plan format. -
PlanId: integer
(int64)
Title:
Academic Plan ID
Unique identifier for a student academic plan. -
PlanName(required): string
Title:
Academic Plan Name
Maximum Length:50
The name of the student academic plan. -
PlannedGraduationDate: string
(date)
Title:
Planned Graduation Date
The student planned graduation date. -
TemplateId: integer
(int64)
Title:
Plan Template ID
Unique identifier for the associated plan template.
Nested Schema : Conflicts
Type:
array
Title:
Conflicts
The conflicts resource is a child of the student academic plans resource and provides a list of conflicts associated with a student academic plan.
Show Source
Nested Schema : Items
Type:
array
Title:
Items
The items resource is a child of the student academic plans resource and provides a list of curriculum items associated with a student academic plan.
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 : studentAcademicPlans-conflicts-item-patch-request
Type:
Show Source
object
-
ConflictContextCode: string
Title:
Conflict Context Code
Maximum Length:30
The context code of the plan conflict. -
ConflictId: integer
(int64)
Title:
Plan Conflict ID
The unique identifier for the plan conflict. -
ConflictReferenceId: integer
(int64)
Title:
Conflict Reference ID
Unique identifier for the source of the edit conflict. -
FifthTokenName: string
Title:
Message Token 5 Name
Maximum Length:30
The fifth token for the message text. -
FifthTokenValue: string
Title:
Message Token 5 Value
Maximum Length:80
The fifth token value for the message text. -
FirstTokenName: string
Title:
Message Token 1 Name
Maximum Length:30
The first token for the message text. -
FirstTokenValue: string
Title:
Message Token Value 1
Maximum Length:80
The first token value for the message text. -
FourthTokenName: string
Title:
Message Token 4 Name
Maximum Length:30
The fourth token for the message text. -
FourthTokenValue: string
Title:
Message Token 4 Value
Maximum Length:80
The fourth token value for the message text. -
MessageName: string
Title:
Message Name
Maximum Length:30
The message identifier for the plan conflict. -
MessageSeverityCode: string
Title:
Message Severity Code
Maximum Length:30
The severity code of the conflict message. -
MessageText: string
Title:
Message Text
The stack trace or the text of the conflict message. -
SecondTokenName: string
Title:
Message Token 2 Name
Maximum Length:30
The second token for the message text. -
SecondTokenValue: string
Title:
Message Token 2 Value
Maximum Length:80
The second token value for the message text. -
ThirdTokenName: string
Title:
Message Token 3 Name
Maximum Length:30
The third token for the message text. -
ThirdTokenValue: string
Title:
Message Token 3 Value
Maximum Length:80
The third token value for the message text.
Nested Schema : studentAcademicPlans-items-item-patch-request
Type:
Show Source
object
-
CurriculumId: integer
(int64)
Title:
Curriculum ID
Unique identifier for a curriculum item. -
CurriculumTypeId: integer
(int64)
Title:
Curriculum Type ID
Unique identifier for the type category of a curriculum item. -
ItemId: integer
(int64)
Title:
Planned Item ID
Unique identifier for a plan item. -
PlanItemFlag: boolean
Title:
Primary Plan Item
Maximum Length:1
Default Value:false
Identifies the primary curriculum item for the plan. -
ProgramTypeId: integer
(int64)
Title:
Program Type ID
The unique identifier for a program type that is associated with a program. -
SequenceNumber: integer
(int32)
Title:
Plan Item Sequence
Used to sequence the order of the plan item.
Nested 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: 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-patch-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-item-response
Type:
Show Source
object
-
CommentText: string
Title:
Comment Text
The attribute to store student's comments or notes for the academic plan. -
CommentUpdateDateTime: string
Title:
Comment Update Date Time
Read Only:true
Indicates the date and time of the last update of the comment for the student academic plan. -
conflicts: array
Conflicts
Title:
Conflicts
The conflicts resource is a child of the student academic plans resource and provides a list of conflicts associated with a student academic plan. -
InstitutionId: integer
(int64)
Title:
Institution ID
Unique identifier for the associated institution. -
InstitutionName: string
Title:
Institution
Read Only:true
Maximum Length:50
The name of the associated institution. -
items: array
Items
Title:
Items
The items resource is a child of the student academic plans resource and provides a list of curriculum items associated with a student academic plan. -
LastUpdateDate: string
(date-time)
Read Only:
true
Who column: indicates the date and time of the last update of the row for the student academic plan. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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. -
PlanFormatId: integer
(int64)
Title:
Plan Format ID
Unique identifier for the associated plan format. -
PlanFormatName: string
Title:
Format Name
Read Only:true
Maximum Length:50
The name of the associated plan format. -
PlanId: integer
(int64)
Title:
Academic Plan ID
Unique identifier for a student academic plan. -
PlanName: string
Title:
Academic Plan Name
Maximum Length:50
The name of the student academic plan. -
PlannedGraduationDate: string
(date)
Title:
Planned Graduation Date
The student planned graduation date. -
PlanStatusCode: string
Title:
Academic Plan Status Code
Read Only:true
Maximum Length:30
Default Value:ORA_ACTIVE
The status code of the student academic plan. -
PlanStatusCodeMeaning: string
Title:
Plan Status Code Meaning
Read Only:true
Maximum Length:80
The status code meaning of the student academic plan. -
TemplateId: integer
(int64)
Title:
Plan Template ID
Unique identifier for the associated plan template. -
TemplateName: string
Title:
Plan Template Name
Read Only:true
Maximum Length:50
The name of the associated plan template.
Nested Schema : Conflicts
Type:
array
Title:
Conflicts
The conflicts resource is a child of the student academic plans resource and provides a list of conflicts associated with a student academic plan.
Show Source
Nested Schema : Items
Type:
array
Title:
Items
The items resource is a child of the student academic plans 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 : 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 : studentAcademicPlans-conflicts-item-response
Type:
Show Source
object
-
ConflictContextCode: string
Title:
Conflict Context Code
Maximum Length:30
The context code of the plan conflict. -
ConflictId: integer
(int64)
Title:
Plan Conflict ID
The unique identifier for the plan conflict. -
ConflictReferenceId: integer
(int64)
Title:
Conflict Reference ID
Unique identifier for the source of the edit conflict. -
FifthTokenName: string
Title:
Message Token 5 Name
Maximum Length:30
The fifth token for the message text. -
FifthTokenValue: string
Title:
Message Token 5 Value
Maximum Length:80
The fifth token value for the message text. -
FirstTokenName: string
Title:
Message Token 1 Name
Maximum Length:30
The first token for the message text. -
FirstTokenValue: string
Title:
Message Token Value 1
Maximum Length:80
The first token value for the message text. -
FourthTokenName: string
Title:
Message Token 4 Name
Maximum Length:30
The fourth token for the message text. -
FourthTokenValue: string
Title:
Message Token 4 Value
Maximum Length:80
The fourth token value for the message text. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageName: string
Title:
Message Name
Maximum Length:30
The message identifier for the plan conflict. -
MessageSeverityCode: string
Title:
Message Severity Code
Maximum Length:30
The severity code of the conflict message. -
MessageText: string
Title:
Message Text
The stack trace or the text of the conflict message. -
SecondTokenName: string
Title:
Message Token 2 Name
Maximum Length:30
The second token for the message text. -
SecondTokenValue: string
Title:
Message Token 2 Value
Maximum Length:80
The second token value for the message text. -
ThirdTokenName: string
Title:
Message Token 3 Name
Maximum Length:30
The third token for the message text. -
ThirdTokenValue: string
Title:
Message Token 3 Value
Maximum Length:80
The third token value for the message text.
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 : studentAcademicPlans-items-item-response
Type:
Show Source
object
-
CurriculumId: integer
(int64)
Title:
Curriculum ID
Unique identifier for a curriculum item. -
CurriculumName: string
Title:
Curriculum Name
Read Only:true
The name of a curriculum item. -
CurriculumType: string
Title:
Curriculum Type
Read Only:true
Maximum Length:30
The curriculum type of the curriculum item. -
CurriculumTypeId: integer
(int64)
Title:
Curriculum Type ID
Unique identifier for the type category of a curriculum item. -
ItemId: integer
(int64)
Title:
Planned Item ID
Unique identifier for a plan item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanItemFlag: boolean
Title:
Primary Plan Item
Maximum Length:1
Default Value:false
Identifies the primary curriculum item for the plan. -
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 a program type that is associated with a program. -
ProgramTypeName: string
Title:
Program Type
Read Only:true
Maximum Length:50
The name of a program type that is associated with a program. -
SequenceNumber: integer
(int32)
Title:
Plan Item Sequence
Used to sequence the order of the plan item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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
Links
- conflicts
-
Operation: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/conflictsParameters:
- studentAcademicPlansUniqID:
$request.path.studentAcademicPlansUniqID
The conflicts resource is a child of the student academic plans resource and provides a list of conflicts associated with a student academic plan. - studentAcademicPlansUniqID:
- items
-
Operation: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/itemsParameters:
- studentAcademicPlansUniqID:
$request.path.studentAcademicPlansUniqID
The items resource is a child of the student academic plans resource and provides a list of curriculum items associated with a student academic plan. - studentAcademicPlansUniqID:
- periods
-
Operation: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periodsParameters:
- studentAcademicPlansUniqID:
$request.path.studentAcademicPlansUniqID
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. - studentAcademicPlansUniqID: