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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<FinancialAidApplicationUpdateAwardsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <application_uuid>String</application_uuid>
  <authorizing_uuid>String</authorizing_uuid>
  <awards>
    <FinancialAidApplicationUpdateAwardRequest>
      <award_amount>0</award_amount>
      <award_code>String</award_code>
      <award_description>String</award_description>
      <comments>String</comments>
      <is_awarded>false</is_awarded>
      <is_eligible>false</is_eligible>
      <term>String</term>
    </FinancialAidApplicationUpdateAwardRequest>
  </awards>
  <term>String</term>
</FinancialAidApplicationUpdateAwardsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>