Leverage API to Update Direct Loan Financial Award Sequence Number

A new Financial Award Sequence Number API has been made available to update a Financial Award Sequence Number for any Title IV Direct Loan for COD originations.

The REST API will include the following parameters:

Parameter	Property	Type	Description
External Student ID	required	string	Student's External Student ID.
Fund Code	required	string	Determines the fund by fund code. Includes Title IV funds: (DSUB | DUNSUB | PLUS | GPLUS)
Award Year	required	int	The award year (eg. 2025, 2026, 2027, etc).
Financial Award Sequence Number	required	int	Sequence number that should be inserted to the FAS_COD_AWD_SEQ_NUM as the first Financial Award Number for a student's Direct Loan for that award year  Since back-end logic does occasionally set the first financial award number to be greater than 1 for an academic year, the system generated Financial Award Sequence Number is a limiting factor and the Financial Award Sequence Number sent in via the API cannot be lower than the system generated value. If the API value is lower, the system generated value will be unchanged.

 Other notable feature items include:

• The system will perform a validation for every inbound Financial Award Number API received
  • If the insert is successful, a message in the following format will be present:
    • {"type":"SUCCESS","message":"Financial Award Sequence Number for DUNSUB 2025 for External Student ID =123 has been updated to 2"}
  • If the insert is not successful, a message in the following format will be be present:
    • {"type":"ERROR","message":"Financial Award Sequence Number for DUNSUB 2025 for External Student ID =123 has not been updated to 3"}
• A Student History Entry will generate when a Financial Award Number API is received
  • Student History Category = Origination Management
  • Description = The initial Financial Award Sequence Number has been updated using the Financial Award Sequence Number API
  • Fund Information should include the following info:
    • Award year
    • Fund Code
    • Previous Financial Award Sequence Number
      • This value can be blank in instances where the system has not yet generated a value and a user has sent in a value via the API (i.e API is sent in prior to the SDI). 
    • Updated Financial Award Sequence Number
  • User ID = Admin

This feature allows you to process scenarios where a student is converted mid-academic year and has a previously used a Financial Award Sequence Number in an outside system. 

Steps to Enable

Use the Opt In UI to enable this feature. For instructions, refer to the Optional Uptake of New Features section of this document.

Offering: Student Financial Aid

• Leverage the new Financial Award Sequence Number API to update the Financial Award Sequence Number for any Title IV Direct Loan for COD originations. 

Tips And Considerations

• The following can be used as an example of how to use the Financial Award Sequence Number API in terminal and the resulting success message:
  • OCI % curl -s -X POST -c ./cookie.txt -b ./cookie.txt "http://localhost:8080/vm-ui/rest/admin/cod/directloan/updateFinancialAwardSequenceNumber?externalStudentId=12551110&fundCode=DSUB&awardYear=2025&sequenceNumber=3"
  • {"type":"SUCCESS","message":"Financial Award Sequence Number for DSUB 2025 for External Student ID =12551110 has been updated to 3."}% 
• The API can be sent in at any time, and the API information will be stored for any future use, i.e. if the API is sent in prior to the SDI, SAFI, or other message types. 
• It should be noted that current back-end logic does occasionally set the first Financial Award Sequence Number to be greater than 1 for an academic year. In these instances, the system generated Financial Award Sequence Number is a limiting factor and the Financial Award Sequence Number sent in via the API cannot be lower than the system generated value. 
  • If the Financial Award Sequence Number sent in via the API is lower than the system generated value, the Financial Award Sequence Number will not be updated but a Student history Entry will be logged 

Key Resources

• For more information on the associated Customer Ideas, see these resources:
  • Idea Number: 775792