Required permission: | FinancialAidPermission |
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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<FinancialAidSummaryInTermRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<reporting_term>String</reporting_term>
</FinancialAidSummaryInTermRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <FinancialAidSummaryInTermResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <awards> <FinancialAidAwardSummaryInTermResponse> <award_code>String</award_code> <award_description>String</award_description> <award_id>0</award_id> <awarded_amount>0</awarded_amount> <budget_amount>0</budget_amount> <person_awards> <FinancialAidAwardResponse> <awarded_amount>0</awarded_amount> <first_name>String</first_name> <last_name>String</last_name> <regent_id>0</regent_id> <uuid>String</uuid> </FinancialAidAwardResponse> </person_awards> </FinancialAidAwardSummaryInTermResponse> </awards> <reporting_term>String</reporting_term> </FinancialAidSummaryInTermResponse>