Jump to

• Request
• Response

Update a student sponsorship credit

patch

/fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}

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

• Effective-Of: string
  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: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ChargePriorityCode: string
  Title: Charge Priority Code

  Maximum Length: 30

  Unique code of the charge priority mapping.
• ChargePriorityId: integer (int64)
  Title: Charge Priority Mapping

  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.
• CreditDescription: string
  Title: Description

  Maximum Length: 240

  User-defined information about the credit.
• CreditName: string
  Title: Credit Name

  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
  Title: Credit Reference Code

  Unique code for the external source of the disbursed amount.
• CreditSourceCode: string
  Title: Credit Source Code

  Maximum Length: 30

  Unique code of the credit source.
• InstitutionId: integer
  Title: Academic Institution

  Unique identifier of the institution associated with the credit.
• InstitutionName: string
  Title: Academic Institution

  Name of the institution.
• MaximumAmount: number
  Title: Maximum Amount

  Maximum amount of the credit.
• Priority: integer (int32)
  Title: Credit Priority

  Default Value: 9999

  Priority assigned to the credit.
• RefundableFlag: boolean
  Title: Refundable Credit

  Maximum Length: 1

  Default Value: false

  This indicates that refunds are allowed for this credit. The default value is false.
• SetupTypeCode: string
  Title: Setup Type Code

  Maximum Length: 30

  The unique code indicating the setup type of the sponsorship.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  Status of the credit. It can be active or inactive.
• StudentResourceFlag: boolean
  Title: Student Resource Information

  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.

{
    "type":"object",
    "properties":{
        "InstitutionName":{
            "title":"Academic Institution",
            "type":"string",
            "description":"Name of the institution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CreditMappingInstitutionName",
                    "CreditsInstitutionName"
                ]
            }
        },
        "InstitutionId":{
            "title":"Academic Institution",
            "type":"integer",
            "description":"Unique identifier of the institution associated with the credit.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillToSponsorFlag",
                    "StudentResourceFlag"
                ]
            }
        },
        "Priority":{
            "title":"Credit Priority",
            "type":"integer",
            "description":"Priority assigned to the credit.",
            "format":"int32",
            "nullable":false,
            "default":9999,
            "x-hints":{
                "precision":6
            }
        },
        "MaximumAmount":{
            "title":"Maximum Amount",
            "type":"number",
            "description":"Maximum amount of the credit.",
            "nullable":true
        },
        "CreditName":{
            "title":"Credit Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the credit.",
            "nullable":false
        },
        "creditAssignments":{
            "title":"Credit Assignments",
            "type":"array",
            "description":"The credit assignments resource is used to assign a student to a sponsorship credit.",
            "items":{
                "$ref":"#/components/schemas/studentCreditSponsorships-creditAssignments-item-patch-request"
            }
        },
        "ChargePriorityCode":{
            "title":"Charge Priority Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique code of the charge priority mapping.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of the credit. It can be active or inactive.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreditReferenceCode":{
            "title":"Credit Reference Code",
            "type":"string",
            "description":"Unique code for the external source of the disbursed amount.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "StudentResourceFlag"
                ]
            }
        },
        "SetupTypeCode":{
            "title":"Setup Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code indicating the setup type of the sponsorship.",
            "nullable":true
        },
        "creditPeriods":{
            "title":"Credit Periods",
            "type":"array",
            "description":"The credit periods resource is used to associate reporting academic periods with a sponsorship credit.",
            "items":{
                "$ref":"#/components/schemas/studentCreditSponsorships-creditPeriods-item-patch-request"
            }
        },
        "StudentResourceFlag":{
            "title":"Student Resource Information",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false
        },
        "CreditDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"User-defined information about the credit.",
            "nullable":true
        },
        "ChargePriorityId":{
            "title":"Charge Priority Mapping",
            "type":"integer",
            "description":"Unique identifier of the charge priority mapping.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RefundableFlag":{
            "title":"Refundable Credit",
            "maxLength":1,
            "type":"boolean",
            "description":"This indicates that refunds are allowed for this credit. The default value is false.",
            "nullable":false,
            "default":false
        },
        "CreditSourceCode":{
            "title":"Credit Source Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique code of the credit source.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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

• Array of: object studentCreditSponsorships-creditAssignments-item-patch-request

{
    "title":"Credit Assignments",
    "type":"array",
    "description":"The credit assignments resource is used to assign a student to a sponsorship credit.",
    "items":{
        "$ref":"#/components/schemas/studentCreditSponsorships-creditAssignments-item-patch-request"
    }
}

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

• Array of: object schema

{
    "title":"Credit Periods",
    "type":"array",
    "description":"The credit periods resource is used to associate reporting academic periods with a sponsorship credit.",
    "items":{
        "$ref":"#/components/schemas/studentCreditSponsorships-creditPeriods-item-patch-request"
    }
}

Nested Schema : studentCreditSponsorships-creditAssignments-item-patch-request

Type: object

Show Source

• Comments: string (byte)
  Title: Comments

  User-defined notes on the student's credit assignment.
• 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: string
  Title: Assignment Status Code

  Maximum Length: 30

  Status of the student's credit assignment. Contains one of these values: active, inactive, or canceled.

{
    "type":"object",
    "properties":{
        "StatusCode":{
            "title":"Assignment Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of the student's credit assignment. Contains one of these values: active, inactive, or canceled.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "creditCurriculums":{
            "title":"Credit Curriculums",
            "type":"array",
            "description":"The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.",
            "items":{
                "$ref":"#/components/schemas/studentCreditSponsorships-creditAssignments-creditCurriculums-item-patch-request"
            }
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"User-defined notes on the student's credit assignment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

• Array of: object studentCreditSponsorships-creditAssignments-creditCurriculums-item-patch-request

{
    "title":"Credit Curriculums",
    "type":"array",
    "description":"The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.",
    "items":{
        "$ref":"#/components/schemas/studentCreditSponsorships-creditAssignments-creditCurriculums-item-patch-request"
    }
}

Nested Schema : studentCreditSponsorships-creditAssignments-creditCurriculums-item-patch-request

Type: object

Show Source

• CurriculumId: integer (int64)
  Title: Curriculum ID

  Unique identifier of the curriculum.
• StatusCode: string
  Title: Status Code

  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.

{
    "type":"object",
    "properties":{
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of the student's curriculum assignment for a particular credit. Contains these values: active or inactive. The default value is active.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"Unique identifier of the curriculum.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AcademicPeriodId: integer (int64)
  Title: Academic Period ID

  Unique identifier of the academic period.
• AcademicPeriodName: string
  Title: Academic 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
  Title: Credit Period Description

  Maximum Length: 240

  Name of the credit period.
• MemoLineId: integer (int64)
  Title: Memo Line ID

  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)
  Title: Receivables Activity

  Unique identifier of the receivables activity when the credit is posted for the academic period.
• ReceivableActivityName: string
  Title: Receivables Activity Name

  Name of the receivables activity.
• TransactionTypeId: integer (int64)
  Title: Credit Transaction Type ID

  Unique identifier of the transaction type when the credit is posted for the academic period.
• TransactionTypeName: string
  Title: Credit Transaction Type Name

  Maximum Length: 20

  Name of the transaction type.

{
    "type":"object",
    "properties":{
        "TransactionTypeName":{
            "title":"Credit Transaction Type Name",
            "maxLength":20,
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the memo line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreditPeriodDescription":{
            "title":"Credit Period Description",
            "maxLength":240,
            "type":"string",
            "description":"Name of the credit period.",
            "nullable":false
        },
        "ReceivableActivityName":{
            "title":"Receivables Activity Name",
            "type":"string",
            "description":"Name of the receivables activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AcademicPeriodName":{
            "title":"Academic Period Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the academic period.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "ReceivableActivityId":{
            "title":"Receivables Activity",
            "type":"integer",
            "description":"Unique identifier of the receivables activity when the credit is posted for the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "creditPeriodCurriculums":{
            "title":"Credit Period Curriculums",
            "type":"array",
            "description":"The credit period curriculums resource is used to associate curriculums with the academic periods that are already associated to the sponsorship credit.",
            "items":{
                "$ref":"#/components/schemas/studentCreditSponsorships-creditPeriods-creditPeriodCurriculums-item-patch-request"
            }
        },
        "TransactionTypeId":{
            "title":"Credit Transaction Type ID",
            "type":"integer",
            "description":"Unique identifier of the transaction type when the credit is posted for the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"Unique identifier of the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "MemoLineId":{
            "title":"Memo Line ID",
            "type":"integer",
            "description":"The unique identifier of the memo line used when the credit is posted for the academic period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

• Array of: object studentCreditSponsorships-creditPeriods-creditPeriodCurriculums-item-patch-request

{
    "title":"Credit Period Curriculums",
    "type":"array",
    "description":"The credit period curriculums resource is used to associate curriculums with the academic periods that are already associated to the sponsorship credit.",
    "items":{
        "$ref":"#/components/schemas/studentCreditSponsorships-creditPeriods-creditPeriodCurriculums-item-patch-request"
    }
}

Nested Schema : studentCreditSponsorships-creditPeriods-creditPeriodCurriculums-item-patch-request

Type: object

Show Source

• CurriculumId: integer (int64)
  Title: Curriculum ID

  Unique identifier of the curriculum.

{
    "type":"object",
    "properties":{
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"Unique identifier of the curriculum.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : studentCreditSponsorships-item-response

Type: object

Show Source

• BillToSponsorFlag: boolean
  Title: Bill Sponsor

  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)
  Title: Business Unit ID

  Unique identifier of the business unit.
• BusinessUnitName: string
  Title: Business Unit Name

  Maximum Length: 240

  Name of the business unit.
• ChargePriorityCode: string
  Title: Charge Priority Code

  Maximum Length: 30

  Unique code of the charge priority mapping.
• ChargePriorityId: integer (int64)
  Title: Charge Priority Mapping

  Unique identifier of the charge priority mapping.
• ChargePriorityName: string
  Title: Charge Priority Name

  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
  Title: Credit Code

  Maximum Length: 30

  Unique user-defined credit code.
• CreditDescription: string
  Title: Description

  Maximum Length: 240

  User-defined information about the credit.
• CreditId: integer (int64)
  Title: Credit ID

  Read Only: true

  Unique identifier of the credit.
• CreditName: string
  Title: Credit Name

  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
  Title: Credit Reference Code

  Unique code for the external source of the disbursed amount.
• CreditReferenceMeaning: string
  Title: Credit Reference Name

  Read Only: true

  Maximum Length: 80

  Name of the source of financial aid.
• CreditSourceCode: string
  Title: Credit Source Code

  Maximum Length: 30

  Unique code of the credit source.
• CreditSourceMeaning: string
  Title: Credit Source Meaning

  Read Only: true

  Maximum Length: 80

  Description of the source of the credit.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  Unique code for the currency used in the primary ledger of the business unit.
• CurrencySymbol: string
  Title: Currency Symbol

  Read Only: true

  Maximum Length: 12

  Symbol of the applicable currency.
• InstitutionId: integer
  Title: Academic Institution

  Unique identifier of the institution associated with the credit.
• InstitutionName: string
  Title: Academic Institution

  Name of the institution.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumAmount: number
  Title: Maximum Amount

  Maximum amount of the credit.
• Priority: integer (int32)
  Title: Credit Priority

  Default Value: 9999

  Priority assigned to the credit.
• RefundableFlag: boolean
  Title: Refundable Credit

  Maximum Length: 1

  Default Value: false

  This indicates that refunds are allowed for this credit. The default value is false.
• SetupTypeCode: string
  Title: Setup Type Code

  Maximum Length: 30

  The unique code indicating the setup type of the sponsorship.
• SetupTypeName: string
  Title: Setup Type Name

  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
  Title: Status Code

  Maximum Length: 30

  Status of the credit. It can be active or inactive.
• StatusMeaning: string
  Title: Status Meaning

  Read Only: true

  Maximum Length: 80

  Full description of the status set for the credit.
• StudentResourceFlag: boolean
  Title: Student Resource Information

  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.

{
    "type":"object",
    "properties":{
        "CreditCode":{
            "title":"Credit Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique user-defined credit code.",
            "nullable":false,
            "x-queryable":true
        },
        "MaximumAmount":{
            "title":"Maximum Amount",
            "type":"number",
            "description":"Maximum amount of the credit.",
            "nullable":true,
            "x-queryable":true
        },
        "creditAssignments":{
            "title":"Credit Assignments",
            "type":"array",
            "description":"The credit assignments resource is used to assign a student to a sponsorship credit.",
            "items":{
                "$ref":"#/components/schemas/studentCreditSponsorships-creditAssignments-item-response"
            }
        },
        "ChargePriorityCode":{
            "title":"Charge Priority Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique code of the charge priority mapping.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of the credit. It can be active or inactive.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":12,
            "type":"string",
            "description":"Symbol of the applicable currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Unique code for the currency used in the primary ledger of the business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SponsorPartyName":{
            "title":"Sponsor",
            "maxLength":255,
            "type":"string",
            "description":"The name of the organization which is associated as a sponsor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreditId",
                    "SponsorPartyId"
                ]
            }
        },
        "CreditId":{
            "title":"Credit ID",
            "type":"integer",
            "description":"Unique identifier of the credit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "creditPeriods":{
            "title":"Credit Periods",
            "type":"array",
            "description":"The credit periods resource is used to associate reporting academic periods with a sponsorship credit.",
            "items":{
                "$ref":"#/components/schemas/studentCreditSponsorships-creditPeriods-item-response"
            }
        },
        "StudentResourceFlag":{
            "title":"Student Resource Information",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SetupTypeName":{
            "title":"Setup Type Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the setup type of the sponsorship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreditDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"User-defined information about the credit.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargePriorityId":{
            "title":"Charge Priority Mapping",
            "type":"integer",
            "description":"Unique identifier of the charge priority mapping.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Academic Institution",
            "type":"string",
            "description":"Name of the institution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CreditMappingInstitutionName",
                    "CreditsInstitutionName"
                ]
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Academic Institution",
            "type":"integer",
            "description":"Unique identifier of the institution associated with the credit.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillToSponsorFlag",
                    "StudentResourceFlag"
                ]
            },
            "x-queryable":true
        },
        "Priority":{
            "title":"Credit Priority",
            "type":"integer",
            "description":"Priority assigned to the credit.",
            "format":"int32",
            "nullable":false,
            "default":9999,
            "x-hints":{
                "precision":6
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditReferenceMeaning":{
            "title":"Credit Reference Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the source of financial aid.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditName":{
            "title":"Credit Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the credit.",
            "nullable":false,
            "x-queryable":true
        },
        "SponsorAgreementName":{
            "title":"Agreement Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the sponsorship agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePriorityName":{
            "title":"Charge Priority Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the charge priority mapping.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditReferenceCode":{
            "title":"Credit Reference Code",
            "type":"string",
            "description":"Unique code for the external source of the disbursed amount.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "StudentResourceFlag"
                ]
            },
            "x-queryable":true
        },
        "CreditSourceMeaning":{
            "title":"Credit Source Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Description of the source of the credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Full description of the status set for the credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SetupTypeCode":{
            "title":"Setup Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code indicating the setup type of the sponsorship.",
            "nullable":true,
            "x-queryable":true
        },
        "SponsorAccountNumber":{
            "title":"Account Number",
            "maxLength":255,
            "type":"string",
            "description":"The account number of the sponsor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SponsorPartyId"
                ]
            }
        },
        "RefundableFlag":{
            "title":"Refundable Credit",
            "maxLength":1,
            "type":"boolean",
            "description":"This indicates that refunds are allowed for this credit. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CreditSourceCode":{
            "title":"Credit Source Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique code of the credit source.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillToSponsorFlag":{
            "title":"Bill Sponsor",
            "maxLength":1,
            "type":"boolean",
            "description":"This indicates whether or not a sponsor should be billed for the credit. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        }
    }
}

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

• Array of: object studentCreditSponsorships-creditAssignments-item-response

{
    "title":"Credit Assignments",
    "type":"array",
    "description":"The credit assignments resource is used to assign a student to a sponsorship credit.",
    "items":{
        "$ref":"#/components/schemas/studentCreditSponsorships-creditAssignments-item-response"
    }
}

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

• Array of: object studentCreditSponsorships-creditPeriods-item-response

{
    "title":"Credit Periods",
    "type":"array",
    "description":"The credit periods resource is used to associate reporting academic periods with a sponsorship credit.",
    "items":{
        "$ref":"#/components/schemas/studentCreditSponsorships-creditPeriods-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : studentCreditSponsorships-creditAssignments-item-response

Type: object

Show Source

• AcademicPeriodId: integer
  Title: Academic Period ID

  Unique identifier of the academic period associated with the credit.
• AcademicPeriodName: string
  Title: Academic Period Name

  Read Only: true

  Maximum Length: 50

  Name of the academic period associated with the credit.
• Comments: string (byte)
  Title: Comments

  User-defined notes on the student's credit assignment.
• CreditAssignmentId: integer (int64)
  Title: Credit Assignment ID

  Read Only: true

  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
  Title: Assignment Status Code

  Maximum Length: 30

  Status of the student's credit assignment. Contains one of these values: active, inactive, or canceled.
• StatusMeaning: string
  Title: Status Meaning

  Read Only: true

  Maximum Length: 80

  Full description of the status set for the student assignment.
• StudentName: string
  Title: Student Party Name

  Read Only: true

  Maximum Length: 360

  Name of the student.
• StudentPartyId: integer (int64)
  Title: Party ID

  Unique identifier of the student assigned to the credit.

{
    "type":"object",
    "properties":{
        "StatusMeaning":{
            "title":"Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Full description of the status set for the student assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodName":{
            "title":"Academic Period Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the academic period associated with the credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"User-defined notes on the student's credit assignment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StudentPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Unique identifier of the student assigned to the credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"Unique identifier of the academic period associated with the credit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreditAssignmentId":{
            "title":"Credit Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the student assignment for the credit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StudentName":{
            "title":"Student Party Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the student.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Assignment Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of the student's credit assignment. Contains one of these values: active, inactive, or canceled.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "creditCurriculums":{
            "title":"Credit Curriculums",
            "type":"array",
            "description":"The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.",
            "items":{
                "$ref":"#/components/schemas/studentCreditSponsorships-creditAssignments-creditCurriculums-item-response"
            }
        }
    }
}

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

• Array of: object studentCreditSponsorships-creditAssignments-creditCurriculums-item-response

{
    "title":"Credit Curriculums",
    "type":"array",
    "description":"The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.",
    "items":{
        "$ref":"#/components/schemas/studentCreditSponsorships-creditAssignments-creditCurriculums-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : studentCreditSponsorships-creditAssignments-creditCurriculums-item-response

Type: object

Show Source

• CreditCurriculumId: integer (int64)
  Title: Credit Curriculum ID

  Unique identifier of the curriculum assigned to the student for a particular credit.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  Unique identifier of the curriculum.
• CurriculumName: string
  Title: Curriculum Name

  Read Only: true

  Maximum Length: 50

  Name of the curriculum.
• CurriculumType: string
  Title: Curriculum Type Name

  Read Only: true

  Maximum Length: 30

  Full description of the curriculum type.
• CurriculumTypeId: integer
  Title: Curriculum Type ID

  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
  Title: Status Code

  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
  Title: Status Meaning

  Read Only: true

  Maximum Length: 80

  Full description of the student's curriculum assignment status for a particular credit.

{
    "type":"object",
    "properties":{
        "StatusMeaning":{
            "title":"Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Full description of the student's curriculum assignment status for a particular credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"Unique identifier of the curriculum.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumTypeId":{
            "title":"Curriculum Type ID",
            "type":"integer",
            "description":"Unique identifier of the type associated with the curriculum. It can be course, scheduled course, program, or course list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Type Name",
            "maxLength":30,
            "type":"string",
            "description":"Full description of the curriculum type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumName":{
            "title":"Curriculum Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the curriculum.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of the student's curriculum assignment for a particular credit. Contains these values: active or inactive. The default value is active.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreditCurriculumId":{
            "title":"Credit Curriculum ID",
            "type":"integer",
            "description":"Unique identifier of the curriculum assigned to the student for a particular credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : studentCreditSponsorships-creditPeriods-item-response

Type: object

Show Source

• AcademicPeriodId: integer (int64)
  Title: Academic Period ID

  Unique identifier of the academic period.
• AcademicPeriodName: string
  Title: Academic 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
  Title: Credit Period Description

  Maximum Length: 240

  Name of the credit period.
• CreditPeriodId: integer (int64)
  Title: Credit Period ID

  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)
  Title: Memo Line ID

  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)
  Title: Receivables Activity

  Unique identifier of the receivables activity when the credit is posted for the academic period.
• ReceivableActivityName: string
  Title: Receivables Activity Name

  Name of the receivables activity.
• TransactionTypeId: integer (int64)
  Title: Credit Transaction Type ID

  Unique identifier of the transaction type when the credit is posted for the academic period.
• TransactionTypeName: string
  Title: Credit Transaction Type Name

  Maximum Length: 20

  Name of the transaction type.

{
    "type":"object",
    "properties":{
        "TransactionTypeName":{
            "title":"Credit Transaction Type Name",
            "maxLength":20,
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the memo line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreditPeriodDescription":{
            "title":"Credit Period Description",
            "maxLength":240,
            "type":"string",
            "description":"Name of the credit period.",
            "nullable":false,
            "x-queryable":true
        },
        "ReceivableActivityName":{
            "title":"Receivables Activity Name",
            "type":"string",
            "description":"Name of the receivables activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AcademicPeriodName":{
            "title":"Academic Period Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the academic period.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReceivableActivityId":{
            "title":"Receivables Activity",
            "type":"integer",
            "description":"Unique identifier of the receivables activity when the credit is posted for the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "creditPeriodCurriculums":{
            "title":"Credit Period Curriculums",
            "type":"array",
            "description":"The credit period curriculums resource is used to associate curriculums with the academic periods that are already associated to the sponsorship credit.",
            "items":{
                "$ref":"#/components/schemas/studentCreditSponsorships-creditPeriods-creditPeriodCurriculums-item-response"
            }
        },
        "TransactionTypeId":{
            "title":"Credit Transaction Type ID",
            "type":"integer",
            "description":"Unique identifier of the transaction type when the credit is posted for the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreditPeriodId":{
            "title":"Credit Period ID",
            "type":"integer",
            "description":"Unique identifier of the credit period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"Unique identifier of the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "MemoLineId":{
            "title":"Memo Line ID",
            "type":"integer",
            "description":"The unique identifier of the memo line used when the credit is posted for the academic period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object studentCreditSponsorships-creditPeriods-creditPeriodCurriculums-item-response

{
    "title":"Credit Period Curriculums",
    "type":"array",
    "description":"The credit period curriculums resource is used to associate curriculums with the academic periods that are already associated to the sponsorship credit.",
    "items":{
        "$ref":"#/components/schemas/studentCreditSponsorships-creditPeriods-creditPeriodCurriculums-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : studentCreditSponsorships-creditPeriods-creditPeriodCurriculums-item-response

Type: object

Show Source

• CreditPeriodCurriculumId: integer (int64)
  Title: Credit Curriculum ID

  Read Only: true

  Unique identifier of the curriculum associated with the credit period.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  Unique identifier of the curriculum.
• CurriculumName: string
  Title: Curriculum Name

  Read Only: true

  Maximum Length: 50

  Name of the curriculum.
• CurriculumTypeId: integer (int64)
  Title: Curriculum Type ID

  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
  Title: Curriculum Type Name

  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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreditPeriodCurriculumId":{
            "title":"Credit Curriculum ID",
            "type":"integer",
            "description":"Unique identifier of the curriculum associated with the credit period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Curriculum Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the curriculum.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"Unique identifier of the curriculum.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumTypeMeaning":{
            "title":"Curriculum Type Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the curriculum type for the curriculum associated with the credit period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTypeId":{
            "title":"Curriculum Type ID",
            "type":"integer",
            "description":"Unique identifier of the type of the curriculum associated with the credit period. Here are examples: course, scheduled course, program, or course list.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

chargePrioritiesLOV

Operation: /fscmRestApi/resources/11.13.18.05/chargePriorityMappingsLOV

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

creditAssignments

Operation: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments

Parameters:

• studentCreditSponsorshipsUniqID: $request.path.studentCreditSponsorshipsUniqID

The credit assignments resource is used to assign a student to a sponsorship credit.

creditPeriods

Operation: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditPeriods

Parameters:

• studentCreditSponsorshipsUniqID: $request.path.studentCreditSponsorshipsUniqID

The credit periods resource is used to associate reporting academic periods with a sponsorship credit.

creditReferencesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

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

creditSourcesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

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

institutionsLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions

The following properties are defined on the LOV link relation:

• Source Attribute: InstitutionName; Target Attribute: InstitutionName
• Display Attribute: InstitutionName

statusesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

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

studentFinancialSystemConfigurationsLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurationsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: BusinessUnitName; Target Attribute: Name
• Display Attribute: Name

Back to Top