Create student sponsor fees
post
/fscmRestApi/resources/11.13.18.05/studentSponsorFees
Request
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
-
BusinessUnitId: integer
(int64)
Unique identifier of the business unit associated to the sponsor fee.
-
BusinessUnitName: string
The name of the business unit associated to the sponsor fee.
-
DueDateCalendarId: integer
(int64)
The unique identifier of a due date calendar. Due date calendars determine the date when the fee is charged.
-
DueDateCalendarName: string
The name of the due date calendar assigned to the sponsor fee.
-
FeeDescription: string
Maximum Length:
240
The description of a sponsor fee. -
FeeId: integer
(int64)
The unique identifier of a sponsor fee. Generated during a creation action.
-
FeeName: string
Maximum Length:
50
The name of the sponsor fee. -
sponsorFeePeriods: array
Sponsor Fee Periods
Title:
Sponsor Fee Periods
The sponsor fee periods resource captures the information required to post a sponsor charge for each academic period. -
UserFeeCode(required): string
Maximum Length:
30
The unique code for a sponsor fee.
Nested Schema : Sponsor Fee Periods
Type:
array
Title:
Sponsor Fee Periods
The sponsor fee periods resource captures the information required to post a sponsor charge for each academic period.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AcademicPeriodId: integer
(int64)
The academic period valid for the sponsor fee.
-
CreditTransactionTypeId: integer
(int64)
The transaction type used when the charge for this fee is credited.
-
CreditTransactionTypeName: string
The name of the credit transaction type.
-
FeeAttributeId: integer
(int64)
The unique identifier of the fee attribute. Generated during a creation action.
-
MemoLineId: integer
(int64)
The unique identifier of the memo line used when the fee is charged for the academic period.
-
MemoLineName: string
The name of the memo line.
-
PeriodName: string
The name of an academic period.
-
TransactionTypeId: integer
(int64)
The transaction type used when the fee is charged for the academic period.
-
TransactionTypeName: string
The name of the transaction type.
-
TrxnDescription: string
Maximum Length:
100
The description of the transaction.
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 : studentSponsorFees-item-response
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
Unique identifier of the business unit associated to the sponsor fee.
-
BusinessUnitName: string
The name of the business unit associated to the sponsor fee.
-
DueDateCalendarId: integer
(int64)
The unique identifier of a due date calendar. Due date calendars determine the date when the fee is charged.
-
DueDateCalendarName: string
The name of the due date calendar assigned to the sponsor fee.
-
FeeDescription: string
Maximum Length:
240
The description of a sponsor fee. -
FeeId: integer
(int64)
The unique identifier of a sponsor fee. Generated during a creation action.
-
FeeName: string
Maximum Length:
50
The name of the sponsor fee. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
sponsorFeePeriods: array
Sponsor Fee Periods
Title:
Sponsor Fee Periods
The sponsor fee periods resource captures the information required to post a sponsor charge for each academic period. -
UserFeeCode: string
Maximum Length:
30
The unique code for a sponsor fee.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Sponsor Fee Periods
Type:
array
Title:
Sponsor Fee Periods
The sponsor fee periods resource captures the information required to post a sponsor charge for each academic period.
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 : studentSponsorFees-sponsorFeePeriods-item-response
Type:
Show Source
object
-
AcademicPeriodId: integer
(int64)
The academic period valid for the sponsor fee.
-
CreditTransactionTypeId: integer
(int64)
The transaction type used when the charge for this fee is credited.
-
CreditTransactionTypeName: string
The name of the credit transaction type.
-
FeeAttributeId: integer
(int64)
The unique identifier of the fee attribute. Generated during a creation action.
-
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 fee is charged for the academic period.
-
MemoLineName: string
The name of the memo line.
-
PeriodName: string
The name of an academic period.
-
TransactionTypeId: integer
(int64)
The transaction type used when the fee is charged for the academic period.
-
TransactionTypeName: string
The name of the transaction type.
-
TrxnDescription: string
Maximum Length:
100
The description of the transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- dueDateCalendarsLOV
-
Parameters:
- finder:
ByPivotDateFinder
The following properties are defined on the LOV link relation:- Source Attribute: DueDateCalendarName; Target Attribute: DueDateCalendarName
- Display Attribute: DueDateCalendarName
- finder:
- sponsorFeePeriods
-
Parameters:
- FeeId:
$request.path.FeeId
The sponsor fee periods resource captures the information required to post a sponsor charge for each academic period. - FeeId:
- studentFinancialSystemConfigurationsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: BusinessUnitName; Target Attribute: Name
- Display Attribute: Name