regis

FinancialAidApplicationUpdateAwardsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Finance/FinancialAid/Application/{application_uuid}/Update/Awards

"use strict";
export class FinancialAidApplicationUpdateAwardRequest {
    /** @param {{award_code?:string,award_description?:string,is_awarded?:boolean,is_eligible?:boolean,award_amount?:number,comments?:string,term?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    award_code;
    /** @type {string} */
    award_description;
    /** @type {boolean} */
    is_awarded;
    /** @type {boolean} */
    is_eligible;
    /** @type {?number} */
    award_amount;
    /** @type {string} */
    comments;
    /** @type {string} */
    term;
}
export class FinancialAidApplicationUpdateAwardsRequest {
    /** @param {{application_uuid?:string,authorizing_uuid?:string,term?:string,awards?:FinancialAidApplicationUpdateAwardRequest[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    application_uuid;
    /** @type {string} */
    authorizing_uuid;
    /** @type {string} */
    term;
    /** @type {FinancialAidApplicationUpdateAwardRequest[]} */
    awards;
}

JavaScript 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>