Create a credit assignment
post
/fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments
Request
Path Parameters
-
studentCreditSponsorshipsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Student Credits Sponsorship resource and used to uniquely identify an instance of Student Credits Sponsorship. The client should not generate the hash key value. Instead, the client should query on the Student Credits Sponsorship collection resource in order to navigate to a specific instance of Student Credits Sponsorship 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
-
AcademicPeriodId: integer
Unique identifier of the academic period associated with the credit.
-
Comments: string
(byte)
User-defined notes on the student's credit assignment.
-
CreditAssignmentId: integer
(int64)
Unique identifier of the student assignment for the credit.
-
creditCurriculums: array
Credit Curriculums
Title:
Credit Curriculums
The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit. -
StatusCode(required): string
Maximum Length:
30
Status of the student's credit assignment. Contains one of these values: active, inactive, or canceled. -
StudentPartyId(required): integer
(int64)
Unique identifier of the student assigned to the credit.
Nested Schema : Credit Curriculums
Type:
array
Title:
Credit Curriculums
The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CreditCurriculumId: integer
(int64)
Unique identifier of the curriculum assigned to the student for a particular credit.
-
CurriculumId: integer
(int64)
Unique identifier of the curriculum.
-
StatusCode: string
Maximum Length:
30
Status of the student's curriculum assignment for a particular credit. Contains these values: active or inactive. The default value is active.
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 : studentCreditSponsorships-creditAssignments-item-response
Type:
Show Source
object
-
AcademicPeriodId: integer
Unique identifier of the academic period associated with the credit.
-
AcademicPeriodName: string
Title:
Period Name
Read Only:true
Maximum Length:50
Name of the academic period associated with the credit. -
Comments: string
(byte)
User-defined notes on the student's credit assignment.
-
CreditAssignmentId: integer
(int64)
Unique identifier of the student assignment for the credit.
-
creditCurriculums: array
Credit Curriculums
Title:
Credit Curriculums
The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StatusCode: string
Maximum Length:
30
Status of the student's credit assignment. Contains one of these values: active, inactive, or canceled. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
Full description of the status set for the student assignment. -
StudentName: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the student. -
StudentPartyId: integer
(int64)
Unique identifier of the student assigned to the credit.
Nested Schema : Credit Curriculums
Type:
array
Title:
Credit Curriculums
The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : studentCreditSponsorships-creditAssignments-creditCurriculums-item-response
Type:
Show Source
object
-
CreditCurriculumId: integer
(int64)
Unique identifier of the curriculum assigned to the student for a particular credit.
-
CurriculumId: integer
(int64)
Unique identifier of the curriculum.
-
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:50
Name of the curriculum. -
CurriculumType: string
Title:
Curriculum Item Type
Read Only:true
Maximum Length:30
Full description of the curriculum type. -
CurriculumTypeId: string
Read Only:
true
Unique identifier of the type associated with the curriculum. It can be course, scheduled course, program, or course list. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StatusCode: string
Maximum Length:
30
Status of the student's curriculum assignment for a particular credit. Contains these values: active or inactive. The default value is active. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
Full description of the student's curriculum assignment status for a particular credit.
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
- creditCurriculums
-
Parameters:
- CreditAssignmentId:
$request.path.CreditAssignmentId
- studentCreditSponsorshipsUniqID:
$request.path.studentCreditSponsorshipsUniqID
The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit. - CreditAssignmentId:
- statusCodesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HES_CRD_ASSIGN_STAT_CODE
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: