regis

BioSyncRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/admissions/{uuid}/bio/sync

namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BioResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val first_name:String = null with get,set
        member val middle_name:String = null with get,set
        member val last_name:String = null with get,set
        member val preferred_name:String = null with get,set
        member val birth_name:String = null with get,set
        member val prefix:String = null with get,set
        member val dob:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val citizenship:String = null with get,set
        member val citizenship_code:String = null with get,set
        member val citizenship_other:String = null with get,set
        member val permanent_resident:String = null with get,set
        member val citizenship_other_code:String = null with get,set
        member val permanent_resident_code:String = null with get,set
        member val gender:String = null with get,set
        member val gender_code:String = null with get,set
        member val marital_status:String = null with get,set
        member val marital_status_code:String = null with get,set
        member val deceased_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val added_by:String = null with get,set
        member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val changed_by:String = null with get,set
        member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type BioSyncResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val uuid:String = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val sugar_bio:BioResponse = null with get,set
        member val regis_bio:BioResponse = null with get,set
        member val re_bio:BioResponse = null with get,set
        member val exists_in_sugar:Boolean = new Boolean() with get,set
        member val exists_in_re:Boolean = new Boolean() with get,set
        member val are_equal:Boolean = new Boolean() with get,set
        member val first_name_are_equal:Boolean = new Boolean() with get,set
        member val middle_name_are_equal:Boolean = new Boolean() with get,set
        member val last_name_are_equal:Boolean = new Boolean() with get,set
        member val preferred_name_are_equal:Boolean = new Boolean() with get,set
        member val birth_name_are_equal:Boolean = new Boolean() with get,set
        member val prefix_are_equal:Boolean = new Boolean() with get,set
        member val dob_are_equal:Boolean = new Boolean() with get,set
        member val deceased_are_equal:Boolean = new Boolean() with get,set
        member val citizenship_are_equal:Boolean = new Boolean() with get,set
        member val gender_are_equal:Boolean = new Boolean() with get,set
        member val marital_status_are_equal:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type BioSyncRequest() = 
        member val uuid:String = null with get,set

F# 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
}