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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class FinancialAidApplicationUpdateAwardsRequest
    {
        public String application_uuid = null;
        public String authorizing_uuid = null;
        public String term = null;
        public ArrayList<FinancialAidApplicationUpdateAwardRequest> awards = null;
        
        public String getApplicationUuid() { return application_uuid; }
        public FinancialAidApplicationUpdateAwardsRequest setApplicationUuid(String value) { this.application_uuid = value; return this; }
        public String getAuthorizingUuid() { return authorizing_uuid; }
        public FinancialAidApplicationUpdateAwardsRequest setAuthorizingUuid(String value) { this.authorizing_uuid = value; return this; }
        public String getTerm() { return term; }
        public FinancialAidApplicationUpdateAwardsRequest setTerm(String value) { this.term = value; return this; }
        public ArrayList<FinancialAidApplicationUpdateAwardRequest> getAwards() { return awards; }
        public FinancialAidApplicationUpdateAwardsRequest setAwards(ArrayList<FinancialAidApplicationUpdateAwardRequest> value) { this.awards = value; return this; }
    }

    public static class FinancialAidApplicationUpdateAwardRequest
    {
        public String award_code = null;
        public String award_description = null;
        public Boolean is_awarded = null;
        public Boolean is_eligible = null;
        public BigDecimal award_amount = null;
        public String comments = null;
        public String term = null;
        
        public String getAwardCode() { return award_code; }
        public FinancialAidApplicationUpdateAwardRequest setAwardCode(String value) { this.award_code = value; return this; }
        public String getAwardDescription() { return award_description; }
        public FinancialAidApplicationUpdateAwardRequest setAwardDescription(String value) { this.award_description = value; return this; }
        public Boolean getIsAwarded() { return is_awarded; }
        public FinancialAidApplicationUpdateAwardRequest setIsAwarded(Boolean value) { this.is_awarded = value; return this; }
        public Boolean getIsEligible() { return is_eligible; }
        public FinancialAidApplicationUpdateAwardRequest setIsEligible(Boolean value) { this.is_eligible = value; return this; }
        public BigDecimal getAwardAmount() { return award_amount; }
        public FinancialAidApplicationUpdateAwardRequest setAwardAmount(BigDecimal value) { this.award_amount = value; return this; }
        public String getComments() { return comments; }
        public FinancialAidApplicationUpdateAwardRequest setComments(String value) { this.comments = value; return this; }
        public String getTerm() { return term; }
        public FinancialAidApplicationUpdateAwardRequest setTerm(String value) { this.term = value; return this; }
    }

}

Java 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
	}
}