regis

<back to all web services

FinancialAidApplicationFileRequest

Requires Authentication
Required permission:FinancialAidPermission
The following routes are available for this service:
POST/Finance/FinancialAid/Application/{application_uuid}/{file_uuid}

export class FileSimpleResponse
{
    public responseStatus: ResponseStatus;
    public uuid: string;
    public name: string;
    public extension: string;
    public size: number;

    public constructor(init?: Partial<FileSimpleResponse>) { (Object as any).assign(this, init); }
}

export class FileResponse extends FileSimpleResponse
{
    public type: string;
    public content: string;

    public constructor(init?: Partial<FileResponse>) { super(init); (Object as any).assign(this, init); }
}

export class FinancialAidApplicationFileRequest
{
    public application_uuid: string;
    public file_uuid: string;

    public constructor(init?: Partial<FinancialAidApplicationFileRequest>) { (Object as any).assign(this, init); }
}

TypeScript FinancialAidApplicationFileRequest 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}/{file_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"application_uuid":"String","file_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"type":"String","content":"AA==","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","name":"String","extension":"String","size":0}