Create a credit period
post
/fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditPeriods
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(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:
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.
Root 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
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
- academicPeriodsLOV
-
Parameters:
- finder:
ByReportingPeriodFinder
The following properties are defined on the LOV link relation:- Source Attribute: AcademicPeriodName; Target Attribute: PeriodName
- Display Attribute: PeriodName
- finder:
- creditPeriodCurriculums
-
Parameters:
- CreditPeriodId:
$request.path.CreditPeriodId
- studentCreditSponsorshipsUniqID:
$request.path.studentCreditSponsorshipsUniqID
The credit period curriculums resource is used to associate curriculums with the academic periods that are already associated to the sponsorship credit. - CreditPeriodId:
- memoLinesLOV
-
Parameters:
- finder:
ByBusinessUnitFinder%3BBusinessUnitName%3D{BusinessUnitName}
The following properties are defined on the LOV link relation:- Source Attribute: MemoLineName; Target Attribute: MemoLineName
- Display Attribute: MemoLineName
- finder:
- receivableActivitiesLOV
-
Parameters:
- finder:
FindByBusinessUnitAndType%3BOrganizationName%3D{BusinessUnitName}
The following properties are defined on the LOV link relation:- Source Attribute: ReceivableActivityName; Target Attribute: ReceivableActivityName
- Display Attribute: ReceivableActivityName
- finder:
- transactionTypesLOV
-
Parameters:
- finder:
CreditMemoTransactionTypeFinder%3BBusinessUnitName%3D{BusinessUnitName}
The following properties are defined on the LOV link relation:- Source Attribute: TransactionTypeName; Target Attribute: TransactionTypeName
- Display Attribute: TransactionTypeName
- finder: