regis

<back to all web services

FinancialAidApplicationUpdateAwardsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/FinancialAid/Application/{application_uuid}/Update/Awards
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class FinancialAidApplicationUpdateAwardRequest
            Public Overridable Property award_code As String
            Public Overridable Property award_description As String
            Public Overridable Property is_awarded As Boolean
            Public Overridable Property is_eligible As Boolean
            Public Overridable Property award_amount As Nullable(Of Decimal)
            Public Overridable Property comments As String
            Public Overridable Property term As String
        End Class

        Public Partial Class FinancialAidApplicationUpdateAwardsRequest
            Public Sub New()
                awards = New List(Of FinancialAidApplicationUpdateAwardRequest)
            End Sub

            Public Overridable Property application_uuid As String
            Public Overridable Property authorizing_uuid As String
            Public Overridable Property term As String
            Public Overridable Property awards As List(Of FinancialAidApplicationUpdateAwardRequest)
        End Class
    End Namespace
End Namespace

VB.NET FinancialAidApplicationUpdateAwardsRequest 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/Application/{application_uuid}/Update/Awards HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	application_uuid: String,
	authorizing_uuid: String,
	term: String,
	awards: 
	[
		{
			award_code: String,
			award_description: String,
			is_awarded: False,
			is_eligible: False,
			award_amount: 0,
			comments: String,
			term: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}