regis

<back to all web services

ExternalDegreesRequest

Requires Authentication
Required permission:ReadExternalDegrees
The following routes are available for this service:
POST/Academic/{uuid}/ExternalDegrees
import java.math.*
import java.util.*
import net.servicestack.client.*


open class ExternalDegreesRequest
{
    var uuid:String? = null
}

open class ExternalDegreesResponse
{
    var responseStatus:ResponseStatus? = null
    var person:PersonSimpleResponse? = null
    var gpa:BigDecimal? = null
    var student_programs:ArrayList<StudentProgramSimpleResponse> = ArrayList<StudentProgramSimpleResponse>()
    var degrees:ArrayList<ExternalDegreeResponse> = ArrayList<ExternalDegreeResponse>()
    var valid_degrees:ArrayList<ExternalDegreesAdminResponse> = ArrayList<ExternalDegreesAdminResponse>()
}

open class PersonSimpleResponse
{
    var responseStatus:ResponseStatus? = null
    var regent_id:Int? = null
    var ubc_id:Int? = null
    var uuid:String? = null
    var regent_login:String? = null
    var first_name:String? = null
    var preferred_name:String? = null
    var middle_name:String? = null
    var last_name:String? = null
    var email:String? = null
    var phone_home:String? = null
    var phone_cell:String? = null
    var phone_bus:String? = null
    var addr1:String? = null
    var addr2:String? = null
    var city:String? = null
    var state:String? = null
    var country:String? = null
    var code:String? = null
    var citizenship:String? = null
    var citizenship_other:String? = null
    var permanent_resident:String? = null
    var dob:Date? = null
    var is_student:Boolean? = null
    var is_faculty:Boolean? = null
    var is_vendor:Boolean? = null
}

open class StudentProgramSimpleResponse
{
    var responseStatus:ResponseStatus? = null
    var regent_id:Int? = null
    var uuid:String? = null
    var program_id:Int? = null
    var program_code:String? = null
    var program_name:String? = null
    var concentration_code:String? = null
    var concentration_name:String? = null
    var start_date:Date? = null
    var end_date:Date? = null
    var catalog:String? = null
    var is_active:Boolean? = null
    var is_graduated:Boolean? = null
}

open class ExternalDegreeResponse
{
    var id:Int? = null
    var institution_id:Int? = null
    var degree_name:String? = null
    var degree_override_name:String? = null
    var institution_name:String? = null
    var graduation_month:String? = null
    var start_year:Int? = null
    var end_year:Int? = null
    var is_only_in_d365:Boolean? = null
}

open class ExternalDegreesAdminResponse
{
    var degree_code:String? = null
    var degree_name:String? = null
    var degree_type:String? = null
}

Kotlin ExternalDegreesRequest 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 /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
		}
	]
}