regis

BioSyncRequest

**Requires Authentication**
Required role:	REGISUserRole

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


export class BioResponse
{
    public responseStatus: ResponseStatus;
    public first_name: string;
    public middle_name: string;
    public last_name: string;
    public preferred_name: string;
    public birth_name: string;
    public prefix: string;
    public dob?: string;
    public citizenship: string;
    public citizenship_code: string;
    public citizenship_other: string;
    public permanent_resident: string;
    public citizenship_other_code: string;
    public permanent_resident_code: string;
    public gender: string;
    public gender_code: string;
    public marital_status: string;
    public marital_status_code: string;
    public deceased_date?: string;
    public added_by: string;
    public added_date?: string;
    public changed_by: string;
    public changed_date?: string;

    public constructor(init?: Partial<BioResponse>) { (Object as any).assign(this, init); }
}

export class BioSyncResponse
{
    public responseStatus: ResponseStatus;
    public uuid: string;
    public regent_id: number;
    public sugar_bio: BioResponse;
    public regis_bio: BioResponse;
    public re_bio: BioResponse;
    public exists_in_sugar: boolean;
    public exists_in_re: boolean;
    public are_equal: boolean;
    public first_name_are_equal: boolean;
    public middle_name_are_equal: boolean;
    public last_name_are_equal: boolean;
    public preferred_name_are_equal: boolean;
    public birth_name_are_equal: boolean;
    public prefix_are_equal: boolean;
    public dob_are_equal: boolean;
    public deceased_are_equal: boolean;
    public citizenship_are_equal: boolean;
    public gender_are_equal: boolean;
    public marital_status_are_equal: boolean;

    public constructor(init?: Partial<BioSyncResponse>) { (Object as any).assign(this, init); }
}

export class BioSyncRequest
{
    public uuid: string;

    public constructor(init?: Partial<BioSyncRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
}