regis

FinancialAidSummaryInTermRequest

**Requires Authentication**
Required permission:	FinancialAidPermission

The following routes are available for this service:
POST	/Finance/FinancialAid/Awards/{reporting_term}/Summary

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class FinancialAidSummaryInTermRequest
            Public Overridable Property reporting_term As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class FinancialAidAwardResponse
            Public Overridable Property uuid As String
            Public Overridable Property regent_id As Integer
            Public Overridable Property first_name As String
            Public Overridable Property last_name As String
            Public Overridable Property awarded_amount As Decimal
        End Class

        Public Partial Class FinancialAidAwardSummaryInTermResponse
            Public Sub New()
                person_awards = New List(Of FinancialAidAwardResponse)
            End Sub

            Public Overridable Property award_id As Integer
            Public Overridable Property award_code As String
            Public Overridable Property award_description As String
            Public Overridable Property budget_amount As Decimal
            Public Overridable Property awarded_amount As Decimal
            Public Overridable Property person_awards As List(Of FinancialAidAwardResponse)
        End Class

        Public Partial Class FinancialAidSummaryInTermResponse
            Public Sub New()
                awards = New List(Of FinancialAidAwardSummaryInTermResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property reporting_term As String
            Public Overridable Property awards As List(Of FinancialAidAwardSummaryInTermResponse)
        End Class
    End Namespace
End Namespace

VB.NET FinancialAidSummaryInTermRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Finance/FinancialAid/Awards/{reporting_term}/Summary HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	reporting_term: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	reporting_term: String,
	awards: 
	[
		{
			award_id: 0,
			award_code: String,
			award_description: String,
			budget_amount: 0,
			awarded_amount: 0,
			person_awards: 
			[
				{
					uuid: String,
					regent_id: 0,
					first_name: String,
					last_name: String,
					awarded_amount: 0
				}
			]
		}
	]
}