regis

<back to all web services

RegentDegreesRequest

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


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

open class RegentDegreesResponse
{
    var responseStatus:ResponseStatus? = null
    var regent_id:Int? = null
    var uuid:String? = null
    var regent_degrees:ArrayList<RegentDegreeResponse> = ArrayList<RegentDegreeResponse>()
    var valid_programs:ArrayList<ProgramResponse> = ArrayList<ProgramResponse>()
    var valid_concentrations:ArrayList<ConcentrationResponse> = ArrayList<ConcentrationResponse>()
    var valid_catalogs:ArrayList<CatalogResponse> = ArrayList<CatalogResponse>()
}

open class RegentDegreeResponse
{
    var id:Int? = null
    var program_code:String? = null
    var program_name:String? = null
    var concentration_code:String? = null
    var concentration_name:String? = null
    var graduation_month:Date? = null
    var start_date:Date? = null
    var end_date:Date? = null
    var gpa:BigDecimal? = null
    var academic_level:String? = null
    var commencement_date:Date? = null
    var added_date:Date? = null
    var added_by:String? = null
    var changed_date:Date? = null
    var changed_by:String? = null
    var timestamp:Date? = null
}

open class ProgramResponse
{
    var responseStatus:ResponseStatus? = null
    var id:Int? = null
    var program_code:String? = null
    var program_pretty_code:String? = null
    var program_long_name:String? = null
    var available_concentrations:String? = null
    var is_active:Boolean? = null
    var timestamp:Date? = null
}

open class ConcentrationResponse
{
    var responseStatus:ResponseStatus? = null
    var id:Int? = null
    var concentration_code:String? = null
    var concentration_name:String? = null
    var is_active:Boolean? = null
}

open class CatalogResponse
{
    var responseStatus:ResponseStatus? = null
    var id:Int? = null
    var catalog_code:String? = null
}

Kotlin RegentDegreesRequest 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}/RegentDegrees 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
		}
	},
	regent_id: 0,
	uuid: String,
	regent_degrees: 
	[
		{
			id: 0,
			program_code: String,
			program_name: String,
			concentration_code: String,
			concentration_name: String,
			graduation_month: 0001-01-01,
			start_date: 0001-01-01,
			end_date: 0001-01-01,
			gpa: 0,
			academic_level: String,
			commencement_date: 0001-01-01,
			added_date: 0001-01-01,
			added_by: String,
			changed_date: 0001-01-01,
			changed_by: String,
			timestamp: 0001-01-01
		}
	],
	valid_programs: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			program_code: String,
			program_pretty_code: String,
			program_long_name: String,
			available_concentrations: String,
			is_active: False,
			timestamp: 0001-01-01
		}
	],
	valid_concentrations: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			concentration_code: String,
			concentration_name: String,
			is_active: False
		}
	],
	valid_catalogs: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			catalog_code: String
		}
	]
}