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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}