regis

<back to all web services

ExternalDegreesRequest

export class PersonSimpleResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public ubc_id?: number;
    public uuid: string;
    public regent_login: string;
    public first_name: string;
    public preferred_name: string;
    public middle_name: string;
    public last_name: string;
    public email: string;
    public phone_home: string;
    public phone_cell: string;
    public phone_bus: string;
    public addr1: string;
    public addr2: string;
    public city: string;
    public state: string;
    public country: string;
    public code: string;
    public citizenship: string;
    public citizenship_other: string;
    public permanent_resident: string;
    public dob?: string;
    public is_student: boolean;
    public is_faculty: boolean;
    public is_vendor: boolean;

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

export class StudentProgramSimpleResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public uuid: string;
    public program_id: number;
    public program_code: string;
    public program_name: string;
    public concentration_code: string;
    public concentration_name: string;
    public start_date?: string;
    public end_date?: string;
    public catalog: string;
    public is_active: boolean;
    public is_graduated: boolean;

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

export class ExternalDegreeResponse
{
    public id?: number;
    public institution_id?: number;
    public degree_name: string;
    public degree_override_name: string;
    public institution_name: string;
    public graduation_month: string;
    public start_year?: number;
    public end_year?: number;
    public is_only_in_d365: boolean;

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

export class ExternalDegreesAdminResponse
{
    public degree_code: string;
    public degree_name: string;
    public degree_type: string;

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

export class ExternalDegreesResponse
{
    public responseStatus: ResponseStatus;
    public person: PersonSimpleResponse;
    public gpa?: number;
    public student_programs: StudentProgramSimpleResponse[];
    public degrees: ExternalDegreeResponse[];
    public valid_degrees: ExternalDegreesAdminResponse[];

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

export class ExternalDegreesRequest
{
    public uuid: string;

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

TypeScript ExternalDegreesRequest DTOs

POST /Academic/{uuid}/ExternalDegrees 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
		}
	},
	person: 
	{
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		},
		regent_id: 0,
		ubc_id: 0,
		uuid: String,
		regent_login: String,
		first_name: String,
		preferred_name: String,
		middle_name: String,
		last_name: String,
		email: String,
		phone_home: String,
		phone_cell: String,
		phone_bus: String,
		addr1: String,
		addr2: String,
		city: String,
		state: String,
		country: String,
		code: String,
		citizenship: String,
		citizenship_other: String,
		permanent_resident: String,
		dob: 0001-01-01,
		is_student: False,
		is_faculty: False,
		is_vendor: False
	},
	gpa: 0,
	student_programs: 
	[
		{
			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,
			program_id: 0,
			program_code: String,
			program_name: String,
			concentration_code: String,
			concentration_name: String,
			start_date: 0001-01-01,
			end_date: 0001-01-01,
			catalog: String,
			is_active: False,
			is_graduated: False
		}
	],
	degrees: 
	[
		{
			id: 0,
			institution_id: 0,
			degree_name: String,
			degree_override_name: String,
			institution_name: String,
			graduation_month: String,
			start_year: 0,
			end_year: 0,
			is_only_in_d365: False
		}
	],
	valid_degrees: 
	[
		{
			degree_code: String,
			degree_name: String,
			degree_type: String
		}
	]
}