regis

FinancialAidSummaryInTermRequest

**Requires Authentication**
Required permission:	FinancialAidPermission

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

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

namespace regis.ClassLibrary.Requests
{
    public partial class FinancialAidSummaryInTermRequest
    {
        public virtual string reporting_term { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class FinancialAidAwardResponse
    {
        public virtual string uuid { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string first_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual decimal awarded_amount { get; set; }
    }

    public partial class FinancialAidAwardSummaryInTermResponse
    {
        public FinancialAidAwardSummaryInTermResponse()
        {
            person_awards = new List<FinancialAidAwardResponse>{};
        }

        public virtual int award_id { get; set; }
        public virtual string award_code { get; set; }
        public virtual string award_description { get; set; }
        public virtual decimal budget_amount { get; set; }
        public virtual decimal awarded_amount { get; set; }
        public virtual List<FinancialAidAwardResponse> person_awards { get; set; }
    }

    public partial class FinancialAidSummaryInTermResponse
    {
        public FinancialAidSummaryInTermResponse()
        {
            awards = new List<FinancialAidAwardSummaryInTermResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual List<FinancialAidAwardSummaryInTermResponse> awards { get; set; }
    }

}

C# 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
				}
			]
		}
	]
}