regis

<back to all web services

FinancePayMyTuitionRequest

Requires Authentication
Required permission:CreatePayments
The following routes are available for this service:
POST/Finance/PayMyTuition
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 FinancePayMyTuitionPayloadRequest
            Public Overridable Property StudentGuid As String
            Public Overridable Property AcademicPeriodGUID As String
            Public Overridable Property PaymentType As String
            Public Overridable Property paidOn As String
            Public Overridable Property comments As String
            Public Overridable Property amount As String
            Public Overridable Property Currency As String
            Public Overridable Property Id As String
            Public Overridable Property StudentResidenceType As String
        End Class

        Public Partial Class FinancePayMyTuitionRequest
            Public Sub New()
                payload = New List(Of FinancePayMyTuitionPayloadRequest)
            End Sub

            Public Overridable Property payload As List(Of FinancePayMyTuitionPayloadRequest)
            Public Overridable Property stamp As String
            Public Overridable Property hash As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class FinancePayStudentAccountByCardResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property success As Boolean
        End Class
    End Namespace
End Namespace

VB.NET FinancePayMyTuitionRequest 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/PayMyTuition HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	payload: 
	[
		{
			studentGuid: String,
			academicPeriodGUID: String,
			paymentType: String,
			paidOn: String,
			comments: String,
			amount: String,
			currency: String,
			id: String,
			studentResidenceType: String
		}
	],
	stamp: String,
	hash: 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
		}
	},
	success: False
}