regis

<back to all web services

FinancialAidSummaryInTermRequest

Requires Authentication
Required permission:FinancialAidPermission
The following routes are available for this service:
POST/Finance/FinancialAid/Awards/{reporting_term}/Summary
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FinancialAidAwardResponse() = 
        member val uuid:String = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val first_name:String = null with get,set
        member val last_name:String = null with get,set
        member val awarded_amount:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type FinancialAidAwardSummaryInTermResponse() = 
        member val award_id:Int32 = new Int32() with get,set
        member val award_code:String = null with get,set
        member val award_description:String = null with get,set
        member val budget_amount:Decimal = new Decimal() with get,set
        member val awarded_amount:Decimal = new Decimal() with get,set
        member val person_awards:ResizeArray<FinancialAidAwardResponse> = new ResizeArray<FinancialAidAwardResponse>() with get,set

    [<AllowNullLiteral>]
    type FinancialAidSummaryInTermResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val reporting_term:String = null with get,set
        member val awards:ResizeArray<FinancialAidAwardSummaryInTermResponse> = new ResizeArray<FinancialAidAwardSummaryInTermResponse>() with get,set

    [<AllowNullLiteral>]
    type FinancialAidSummaryInTermRequest() = 
        member val reporting_term:String = null with get,set

F# FinancialAidSummaryInTermRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"reporting_term":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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}]}]}