regis

<back to all web services

BioSyncRequest

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


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

open class BioSyncResponse
{
    var responseStatus:ResponseStatus? = null
    var uuid:String? = null
    var regent_id:Int? = null
    var sugar_bio:BioResponse? = null
    var regis_bio:BioResponse? = null
    var re_bio:BioResponse? = null
    var exists_in_sugar:Boolean? = null
    var exists_in_re:Boolean? = null
    var are_equal:Boolean? = null
    var first_name_are_equal:Boolean? = null
    var middle_name_are_equal:Boolean? = null
    var last_name_are_equal:Boolean? = null
    var preferred_name_are_equal:Boolean? = null
    var birth_name_are_equal:Boolean? = null
    var prefix_are_equal:Boolean? = null
    var dob_are_equal:Boolean? = null
    var deceased_are_equal:Boolean? = null
    var citizenship_are_equal:Boolean? = null
    var gender_are_equal:Boolean? = null
    var marital_status_are_equal:Boolean? = null
}

open class BioResponse
{
    var responseStatus:ResponseStatus? = null
    var first_name:String? = null
    var middle_name:String? = null
    var last_name:String? = null
    var preferred_name:String? = null
    var birth_name:String? = null
    var prefix:String? = null
    var dob:Date? = null
    var citizenship:String? = null
    var citizenship_code:String? = null
    var citizenship_other:String? = null
    var permanent_resident:String? = null
    var citizenship_other_code:String? = null
    var permanent_resident_code:String? = null
    var gender:String? = null
    var gender_code:String? = null
    var marital_status:String? = null
    var marital_status_code:String? = null
    var deceased_date:Date? = null
    var added_by:String? = null
    var added_date:Date? = null
    var changed_by:String? = null
    var changed_date:Date? = null
}

Kotlin BioSyncRequest 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 /admissions/{uuid}/bio/sync 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
		}
	},
	uuid: String,
	regent_id: 0,
	sugar_bio: 
	{
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		},
		first_name: String,
		middle_name: String,
		last_name: String,
		preferred_name: String,
		birth_name: String,
		prefix: String,
		dob: 0001-01-01,
		citizenship: String,
		citizenship_code: String,
		citizenship_other: String,
		permanent_resident: String,
		citizenship_other_code: String,
		permanent_resident_code: String,
		gender: String,
		gender_code: String,
		marital_status: String,
		marital_status_code: String,
		deceased_date: 0001-01-01,
		added_by: String,
		added_date: 0001-01-01,
		changed_by: String,
		changed_date: 0001-01-01
	},
	regis_bio: 
	{
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		},
		first_name: String,
		middle_name: String,
		last_name: String,
		preferred_name: String,
		birth_name: String,
		prefix: String,
		dob: 0001-01-01,
		citizenship: String,
		citizenship_code: String,
		citizenship_other: String,
		permanent_resident: String,
		citizenship_other_code: String,
		permanent_resident_code: String,
		gender: String,
		gender_code: String,
		marital_status: String,
		marital_status_code: String,
		deceased_date: 0001-01-01,
		added_by: String,
		added_date: 0001-01-01,
		changed_by: String,
		changed_date: 0001-01-01
	},
	re_bio: 
	{
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		},
		first_name: String,
		middle_name: String,
		last_name: String,
		preferred_name: String,
		birth_name: String,
		prefix: String,
		dob: 0001-01-01,
		citizenship: String,
		citizenship_code: String,
		citizenship_other: String,
		permanent_resident: String,
		citizenship_other_code: String,
		permanent_resident_code: String,
		gender: String,
		gender_code: String,
		marital_status: String,
		marital_status_code: String,
		deceased_date: 0001-01-01,
		added_by: String,
		added_date: 0001-01-01,
		changed_by: String,
		changed_date: 0001-01-01
	},
	exists_in_sugar: False,
	exists_in_re: False,
	are_equal: False,
	first_name_are_equal: False,
	middle_name_are_equal: False,
	last_name_are_equal: False,
	preferred_name_are_equal: False,
	birth_name_are_equal: False,
	prefix_are_equal: False,
	dob_are_equal: False,
	deceased_are_equal: False,
	citizenship_are_equal: False,
	gender_are_equal: False,
	marital_status_are_equal: False
}