Create a course selection
post
/fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/courseSelections
Request
Path Parameters
-
ApplicationId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
CourseCurriculumId: integer
(int64)
Title:
Course Curriculum ID
The curriculum identifier for the selected course. -
CourseListCurriculumId: integer
(int64)
Title:
Course List Curriculum ID
The curriculum identifier for the course list of the selected course. -
CourseListSequence: integer
(int32)
Title:
Course List Sequence
Default Value:1
The sequence of the course list for the associated course selection. -
CoursePreference: integer
(int32)
Title:
Course Preference
Default Value:1
Course selection preference sequence number. -
ProgramCurriculumId: integer
(int64)
Title:
Program Curriculum ID
The curriculum identifier for the program of the selected course. -
SelectionDateTime: string
(date-time)
Title:
Selection Date
The date of the course selection.
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 : admissionApplications-courseSelections-item-response
Type:
Show Source
object
-
CatalogNumber: string
Title:
Catalog Number
Read Only:true
Maximum Length:10
The catalog number of the course selection. -
CourseCurriculumId: integer
(int64)
Title:
Course Curriculum ID
The curriculum identifier for the selected course. -
CourseDescription: string
(byte)
Title:
Description
Read Only:true
The description of the selected course. -
CourseListCurriculumId: integer
(int64)
Title:
Course List Curriculum ID
The curriculum identifier for the course list of the selected course. -
CourseListName: string
Title:
Course List Name
Read Only:true
Maximum Length:50
The name for the course list of the selected course. -
CourseListSequence: integer
(int32)
Title:
Course List Sequence
Default Value:1
The sequence of the course list for the associated course selection. -
CourseListTitle: string
Title:
Course List Title
Read Only:true
Maximum Length:100
The title for the course list of the selected course. -
CourseName: string
Title:
Course Name
Read Only:true
Maximum Length:50
The name of the selected course. -
CoursePreference: integer
(int32)
Title:
Course Preference
Default Value:1
Course selection preference sequence number. -
CourseSelectionId: integer
(int64)
Title:
Course Selection ID
Read Only:true
Unique identifier for the course selection. -
CourseTitle: string
Title:
Course Title
Read Only:true
Maximum Length:100
The title of the selected course. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramCurriculumId: integer
(int64)
Title:
Program Curriculum ID
The curriculum identifier for the program of the selected course. -
ProgramName: string
Title:
Program Name
Read Only:true
Maximum Length:50
The name for the academic program of the selected course. -
ProgramTitle: string
Title:
Program Title
Read Only:true
Maximum Length:100
The title for the academic program of the selected course. -
SelectionDateTime: string
(date-time)
Title:
Selection Date
The date of the course selection. -
Subject: string
Title:
Subject
Read Only:true
Maximum Length:50
The subject of the course selection. -
SubjectCode: string
Title:
Subject Code
Read Only:true
Maximum Length:30
The subject code of the course selection.
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.