regis

<back to all web services

ApplicationSummaryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/application/summary
"use strict";
export class ApplicationSummaryResponse {
    /** @param {{responseStatus?:ResponseStatus,uuid?:string,regent_id?:number,start_term?:string,program?:string,application_status?:string,undergrad_gpa?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    uuid;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    start_term;
    /** @type {string} */
    program;
    /** @type {string} */
    application_status;
    /** @type {?number} */
    undergrad_gpa;
}
export class ApplicationSummaryRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript ApplicationSummaryRequest 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 /application/summary HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	uuid: String,
	regent_id: 0,
	start_term: String,
	program: String,
	application_status: String,
	undergrad_gpa: 0
}