Create a student sponsorship credit
post
/fscmRestApi/resources/11.13.18.05/studentCreditSponsorships
Request
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.
-
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
-
BillToSponsorFlag: boolean
Maximum Length:
1
Default Value:false
This indicates whether or not a sponsor should be billed for the credit. The default value is false. -
BusinessUnitId: integer
(int64)
Unique identifier of the business unit.
-
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit. -
ChargePriorityCode: string
Maximum Length:
30
Unique code of the charge priority mapping. -
ChargePriorityId: integer
(int64)
Unique identifier of the charge priority mapping.
-
creditAssignments: array
Credit Assignments
Title:
Credit Assignments
The credit assignments resource is used to assign a student to a sponsorship credit. -
CreditCode(required): string
Maximum Length:
30
Unique user-defined credit code. -
CreditDescription: string
Maximum Length:
240
User-defined information about the credit. -
CreditName(required): string
Maximum Length:
50
Name of the credit. -
creditPeriods: array
Credit Periods
Title:
Credit Periods
The credit periods resource is used to associate reporting academic periods with a sponsorship credit. -
CreditReferenceCode: string
Unique code for the external source of the disbursed amount.
-
CreditSourceCode: string
Maximum Length:
30
Unique code of the credit source. -
InstitutionId: integer
Unique identifier of the institution associated with the credit.
-
InstitutionName: string
Name of the institution.
-
MaximumAmount: number
Maximum amount of the credit.
-
Priority: integer
(int32)
Default Value:
9999
Priority assigned to the credit. -
RefundableFlag: boolean
Maximum Length:
1
Default Value:false
This indicates that refunds are allowed for this credit. The default value is false. -
SetupTypeCode: string
Title:
Type
Maximum Length:30
The unique code indicating the setup type of the sponsorship. -
StatusCode(required): string
Maximum Length:
30
Status of the credit. It can be active or inactive. -
StudentResourceFlag: boolean
Maximum Length:
1
Default Value:false
This indicates that a credit can be used as student resource information. If true, the student credit is created in the HES_CREDIT_MAPPING record. The default value is false.
Nested Schema : Credit Assignments
Type:
array
Title:
Credit Assignments
The credit assignments resource is used to assign a student to a sponsorship credit.
Show Source
Nested Schema : Credit Periods
Type:
array
Title:
Credit Periods
The credit periods resource is used to associate reporting academic periods with a sponsorship credit.
Show Source
Nested Schema : studentCreditSponsorships-creditAssignments-item-post-request
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.
Nested Schema : studentCreditSponsorships-creditPeriods-item-post-request
Type:
Show Source
object
-
AcademicPeriodId(required): integer
(int64)
Unique identifier of the academic period.
-
AcademicPeriodName: string
Title:
Period Name
Maximum Length:50
Name of the academic period. -
creditPeriodCurriculums: array
Credit Period Curriculums
Title:
Credit Period Curriculums
The credit period curriculums resource is used to associate curriculums with the academic periods that are already associated to the sponsorship credit. -
CreditPeriodDescription(required): string
Maximum Length:
240
Name of the credit period. -
MemoLineId: integer
(int64)
The unique identifier of the memo line used when the credit is posted for the academic period.
-
MemoLineName: string
Title:
Memo Line Name
Maximum Length:50
The name of the memo line. -
ReceivableActivityId(required): integer
(int64)
Unique identifier of the receivables activity when the credit is posted for the academic period.
-
ReceivableActivityName: string
Name of the receivables activity.
-
TransactionTypeId(required): integer
(int64)
Unique identifier of the transaction type when the credit is posted for the academic period.
-
TransactionTypeName: string
Title:
Transaction Type Name
Maximum Length:20
Name of the transaction type.
Nested Schema : Credit Period Curriculums
Type:
array
Title:
Credit Period Curriculums
The credit period curriculums resource is used to associate curriculums with the academic periods that are already associated to the sponsorship credit.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CurriculumId: integer
(int64)
Unique identifier of the curriculum.
-
CurriculumTypeId: integer
(int64)
Unique identifier of the type of the curriculum associated with the credit period. Here are examples: course, scheduled course, program, or course list.
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-item-response
Type:
Show Source
object
-
BillToSponsorFlag: boolean
Maximum Length:
1
Default Value:false
This indicates whether or not a sponsor should be billed for the credit. The default value is false. -
BusinessUnitId: integer
(int64)
Unique identifier of the business unit.
-
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit. -
ChargePriorityCode: string
Maximum Length:
30
Unique code of the charge priority mapping. -
ChargePriorityId: integer
(int64)
Unique identifier of the charge priority mapping.
-
ChargePriorityName: string
Read Only:
true
Maximum Length:50
Name of the charge priority mapping. -
creditAssignments: array
Credit Assignments
Title:
Credit Assignments
The credit assignments resource is used to assign a student to a sponsorship credit. -
CreditCode: string
Maximum Length:
30
Unique user-defined credit code. -
CreditDescription: string
Maximum Length:
240
User-defined information about the credit. -
CreditId: integer
(int64)
Read Only:
true
Unique identifier of the credit. -
CreditName: string
Maximum Length:
50
Name of the credit. -
creditPeriods: array
Credit Periods
Title:
Credit Periods
The credit periods resource is used to associate reporting academic periods with a sponsorship credit. -
CreditReferenceCode: string
Unique code for the external source of the disbursed amount.
-
CreditReferenceMeaning: string
Read Only:
true
Maximum Length:80
Name of the source of financial aid. -
CreditSourceCode: string
Maximum Length:
30
Unique code of the credit source. -
CreditSourceMeaning: string
Read Only:
true
Maximum Length:80
Description of the source of the credit. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Unique code for the currency used in the primary ledger of the business unit. -
CurrencySymbol: string
Title:
Symbol
Read Only:true
Maximum Length:12
Symbol of the applicable currency. -
InstitutionId: integer
Unique identifier of the institution associated with the credit.
-
InstitutionName: string
Name of the institution.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumAmount: number
Maximum amount of the credit.
-
Priority: integer
(int32)
Default Value:
9999
Priority assigned to the credit. -
RefundableFlag: boolean
Maximum Length:
1
Default Value:false
This indicates that refunds are allowed for this credit. The default value is false. -
SetupTypeCode: string
Title:
Type
Maximum Length:30
The unique code indicating the setup type of the sponsorship. -
SetupTypeName: string
Title:
Type
Read Only:true
Maximum Length:80
The name of the setup type of the sponsorship. -
SponsorAccountNumber: string
Title:
Account Number
Read Only:true
Maximum Length:255
The account number of the sponsor. -
SponsorAgreementName: string
Title:
Agreement Name
Read Only:true
Maximum Length:50
The name of the sponsorship agreement. -
SponsorPartyName: string
Title:
Sponsor
Read Only:true
Maximum Length:255
The name of the organization which is associated as a sponsor. -
StatusCode: string
Maximum Length:
30
Status of the credit. It can be active or inactive. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
Full description of the status set for the credit. -
StudentResourceFlag: boolean
Maximum Length:
1
Default Value:false
This indicates that a credit can be used as student resource information. If true, the student credit is created in the HES_CREDIT_MAPPING record. The default value is false.
Nested Schema : Credit Assignments
Type:
array
Title:
Credit Assignments
The credit assignments resource is used to assign a student to a sponsorship credit.
Show Source
Nested Schema : Credit Periods
Type:
array
Title:
Credit Periods
The credit periods resource is used to associate reporting academic periods with 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-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.
Nested Schema : studentCreditSponsorships-creditPeriods-item-response
Type:
Show Source
object
-
AcademicPeriodId: integer
(int64)
Unique identifier of the academic period.
-
AcademicPeriodName: string
Title:
Period Name
Maximum Length:50
Name of the academic period. -
creditPeriodCurriculums: array
Credit Period Curriculums
Title:
Credit Period Curriculums
The credit period curriculums resource is used to associate curriculums with the academic periods that are already associated to the sponsorship credit. -
CreditPeriodDescription: string
Maximum Length:
240
Name of the credit period. -
CreditPeriodId: integer
(int64)
Read Only:
true
Unique identifier of the credit period. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemoLineId: integer
(int64)
The unique identifier of the memo line used when the credit is posted for the academic period.
-
MemoLineName: string
Title:
Memo Line Name
Maximum Length:50
The name of the memo line. -
ReceivableActivityId: integer
(int64)
Unique identifier of the receivables activity when the credit is posted for the academic period.
-
ReceivableActivityName: string
Name of the receivables activity.
-
TransactionTypeId: integer
(int64)
Unique identifier of the transaction type when the credit is posted for the academic period.
-
TransactionTypeName: string
Title:
Transaction Type Name
Maximum Length:20
Name of the transaction type.
Nested Schema : Credit Period Curriculums
Type:
array
Title:
Credit Period Curriculums
The credit period curriculums resource is used to associate curriculums with the academic periods that are already associated to the sponsorship credit.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : studentCreditSponsorships-creditPeriods-creditPeriodCurriculums-item-response
Type:
Show Source
object
-
CreditPeriodCurriculumId: integer
(int64)
Read Only:
true
Unique identifier of the curriculum associated with the credit period. -
CurriculumId: integer
(int64)
Unique identifier of the curriculum.
-
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:50
Name of the curriculum. -
CurriculumTypeId: integer
(int64)
Unique identifier of the type of the curriculum associated with the credit period. Here are examples: course, scheduled course, program, or course list.
-
CurriculumTypeMeaning: string
Read Only:
true
Maximum Length:50
Name of the curriculum type for the curriculum associated with the credit period. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- chargePrioritiesLOV
-
Parameters:
- finder:
FindByActiveDateAndBusinessUnit%3BBusinessUnitName%3D{BusinessUnitName}
The following properties are defined on the LOV link relation:- Source Attribute: ChargePriorityCode; Target Attribute: ChargePriorityCode
- Display Attribute: ChargePriorityName
- finder:
- creditAssignments
-
Parameters:
- studentCreditSponsorshipsUniqID:
$request.path.studentCreditSponsorshipsUniqID
The credit assignments resource is used to assign a student to a sponsorship credit. - studentCreditSponsorshipsUniqID:
- creditPeriods
-
Parameters:
- studentCreditSponsorshipsUniqID:
$request.path.studentCreditSponsorshipsUniqID
The credit periods resource is used to associate reporting academic periods with a sponsorship credit. - studentCreditSponsorshipsUniqID:
- creditReferencesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_CREDIT_REFERENCE
The following properties are defined on the LOV link relation:- Source Attribute: CreditReferenceCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- creditSourcesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_CREDIT_SOURCE_CODE
The following properties are defined on the LOV link relation:- Source Attribute: CreditSourceCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- institutionsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: InstitutionName; Target Attribute: InstitutionName
- Display Attribute: InstitutionName
- statusesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HES_CREDIT_STATUS_CODE
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- studentFinancialSystemConfigurationsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: BusinessUnitName; Target Attribute: Name
- Display Attribute: Name