regis

PersonSideBarRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/person/{uuid}/sidebar

import java.math.*
import java.util.*
import net.servicestack.client.*


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

open class PersonSideBarResponse
{
    var responseStatus:ResponseStatus? = null
    var regent_id:Int? = null
    var ubc_id:Int? = null
    var regent_login:String? = null
    var uuid:String? = null
    var first_name:String? = null
    var middle_name:String? = null
    var last_name:String? = null
    var preferred_name:String? = null
    var dob:Date? = null
    var citizenship:String? = null
    var citizenship_other:String? = null
    var permanent_resident:String? = null
    var addr1:String? = null
    var addr2:String? = null
    var city:String? = null
    var state:String? = null
    var code:String? = null
    var country:String? = null
    var email:String? = null
    var phone_home:String? = null
    var phone_cell:String? = null
    var phone_bus:String? = null
    var imageBase64:String? = null
    var tax_number:String? = null
    var programs:ArrayList<StudentProgramSimpleResponse> = ArrayList<StudentProgramSimpleResponse>()
}

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
}

Kotlin PersonSideBarRequest 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 /person/{uuid}/sidebar 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,
	ubc_id: 0,
	regent_login: String,
	uuid: String,
	first_name: String,
	middle_name: String,
	last_name: String,
	preferred_name: String,
	dob: 0001-01-01,
	citizenship: String,
	citizenship_other: String,
	permanent_resident: String,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	code: String,
	country: String,
	email: String,
	phone_home: String,
	phone_cell: String,
	phone_bus: String,
	imageBase64: String,
	tax_number: String,
	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
		}
	]
}