regis

BioHistoryRequest

**Requires Authentication**
Required role:	REGISUserRole

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

import Foundation
import ServiceStack

public class BioHistoryRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class BioHistoryResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var uuid:String
    public var regent_id:Int
    public var bios:[BioResponse] = []

    required public init(){}
}

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

    required public init(){}
}

Swift BioHistoryRequest 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/history 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,
	bios: 
	[
		{
			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
		}
	]
}