regis

<back to all web services

StudentGraduationRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentGraduation/{uuid}/{year}
"use strict";
export class StudentGraduationProgramResponse {
    /** @param {{program_code?:string,concentration_code?:string,program_details?:string,comments?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    program_code;
    /** @type {string} */
    concentration_code;
    /** @type {string} */
    program_details;
    /** @type {string} */
    comments;
}
export class StudentGraduationResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,first_name?:string,preferred_name?:string,middle_name?:string,last_name?:string,email?:string,phonetic_first_name?:string,phonetic_middle_name?:string,phonetic_last_name?:string,placement?:string,placement_other?:string,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,code?:string,citizenship?:string,citizenship_other?:string,permanent_resident?:string,previous_degrees?:string,gown_size?:number,project_title?:string,supervisor?:string,is_attending?:boolean,is_hood_requested?:boolean,is_hood_paid?:boolean,is_paid?:boolean,is_late?:boolean,year?:number,comments?:string,current_status?:string,current_status_date?:string,added_date?:string,applied_programs?:StudentGraduationProgramResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {string} */
    first_name;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    email;
    /** @type {string} */
    phonetic_first_name;
    /** @type {string} */
    phonetic_middle_name;
    /** @type {string} */
    phonetic_last_name;
    /** @type {string} */
    placement;
    /** @type {string} */
    placement_other;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {string} */
    previous_degrees;
    /** @type {?number} */
    gown_size;
    /** @type {string} */
    project_title;
    /** @type {string} */
    supervisor;
    /** @type {boolean} */
    is_attending;
    /** @type {boolean} */
    is_hood_requested;
    /** @type {boolean} */
    is_hood_paid;
    /** @type {boolean} */
    is_paid;
    /** @type {boolean} */
    is_late;
    /** @type {?number} */
    year;
    /** @type {string} */
    comments;
    /** @type {string} */
    current_status;
    /** @type {?string} */
    current_status_date;
    /** @type {?string} */
    added_date;
    /** @type {StudentGraduationProgramResponse[]} */
    applied_programs;
}
export class StudentGraduationRequest {
    /** @param {{uuid?:string,year?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {number} */
    year;
}

JavaScript StudentGraduationRequest 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 /StudentGraduation/{uuid}/{year} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	year: 0
}
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
		}
	},
	regent_id: 0,
	uuid: String,
	first_name: String,
	preferred_name: String,
	middle_name: String,
	last_name: String,
	email: String,
	phonetic_first_name: String,
	phonetic_middle_name: String,
	phonetic_last_name: String,
	placement: String,
	placement_other: String,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	code: String,
	citizenship: String,
	citizenship_other: String,
	permanent_resident: String,
	previous_degrees: String,
	gown_size: 0,
	project_title: String,
	supervisor: String,
	is_attending: False,
	is_hood_requested: False,
	is_hood_paid: False,
	is_paid: False,
	is_late: False,
	year: 0,
	comments: String,
	current_status: String,
	current_status_date: 0001-01-01,
	added_date: 0001-01-01,
	applied_programs: 
	[
		{
			program_code: String,
			concentration_code: String,
			program_details: String,
			comments: String
		}
	]
}